VSCode Erlang 扩展项目教程

VSCode Erlang 扩展项目教程

1. 项目的目录结构及介绍

vscode_erlang/
├── .github/
│   └── workflows/
├── assets/
│   └── images/
├── client/
│   ├── src/
│   ├── test/
│   └── package.json
├── server/
│   ├── src/
│   ├── test/
│   └── package.json
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• assets/images: 存放项目相关的图片资源。
• client/src: 客户端源代码文件。
• client/test: 客户端测试文件。
• server/src: 服务器端源代码文件。
• server/test: 服务器端测试文件。
• .gitignore: 指定Git忽略的文件和目录。
• .vscodeignore: 指定VSCode忽略的文件和目录。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于client/src和server/src目录下。

• client/src/extension.ts: 客户端扩展的主入口文件，负责初始化和激活扩展。
• server/src/server.ts: 服务器端的主入口文件，负责启动语言服务器。

3. 项目的配置文件介绍

• package.json: 包含项目的依赖、脚本、扩展信息等。
• tsconfig.json: TypeScript编译配置文件，定义编译选项和文件包含规则。
• .vscodeignore: 指定在打包扩展时忽略的文件和目录。
• .gitignore: 指定Git版本控制时忽略的文件和目录。

这些配置文件共同确保了项目的正确构建、运行和版本控制。