vscode-languagetool-linter 项目使用教程
1. 项目的目录结构及介绍
vscode-languagetool-linter/
├── .github/
│ └── workflows/
│ └── ci.yml
├── client/
│ ├── src/
│ │ ├── extension.ts
│ │ └── test/
│ │ └── extension.test.ts
│ └── package.json
├── server/
│ ├── src/
│ │ ├── main.ts
│ │ └── test/
│ │ └── main.test.ts
│ └── package.json
├── .gitignore
├── .vscode/
│ ├── extensions.json
│ ├── launch.json
│ └── settings.json
├── package.json
├── README.md
└── tsconfig.json
- .github/workflows/ci.yml: GitHub Actions 的 CI 配置文件。
- client/: VS Code 扩展客户端代码。
- src/extension.ts: 扩展的主入口文件。
- test/: 客户端测试代码。
- server/: LanguageTool 服务端代码。
- src/main.ts: 服务端的主入口文件。
- test/: 服务端测试代码。
- .gitignore: Git 忽略文件配置。
- .vscode/: VS Code 工作区配置。
- package.json: 项目依赖和脚本配置。
- README.md: 项目说明文档。
- tsconfig.json: TypeScript 配置文件。
2. 项目的启动文件介绍
- client/src/extension.ts: 这是 VS Code 扩展的入口文件,负责初始化和激活扩展。
- server/src/main.ts: 这是 LanguageTool 服务端的入口文件,负责启动和配置 LanguageTool 服务。
3. 项目的配置文件介绍
- .vscode/settings.json: 包含 VS Code 工作区的配置,如代码格式化、代码检查等。
- package.json: 包含项目的依赖、脚本和扩展配置。例如:
{ "name": "vscode-languagetool-linter", "version": "1.0.0", "engines": { "vscode": "^1.50.0" }, "dependencies": { "vscode-languageclient": "^7.0.0" }, "scripts": { "compile": "tsc -p ./", "watch": "tsc -watch -p ./", "test": "node ./out/test/runTest.js" } }
- tsconfig.json: TypeScript 编译配置文件,定义了编译选项和编译目标。
以上是 vscode-languagetool-linter
项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!