Visual Studio Code HTML 语言服务安装与使用教程

本教程将引导您了解并设置 Microsoft/vscode-html-languageservice 项目，这是一个用于提供 HTML 语言智能支持的库，可以被 Visual Studio Code 和 Monaco 编辑器等工具集成使用。

1. 项目目录结构及介绍

.
├── build            # 构建产出文件
├── docs              # 文档相关材料
├── src               # 源代码目录
│   ├── editorconfig  # EditorConfig 配置
│   ├── eslint         # ESLint 相关配置
│   ├── gitignore     # .gitignore 文件
│   ├── mocharc.json   # Mocha 测试配置
│   ├── npmignore     # .npmignore 文件
│   ├── prettierrc.json  # Prettier 格式化配置
│   └── ...            # 其他源码文件
├── CHANGELOG.md       # 更新日志
├── LICENSE.md         # 许可证文件
├── README.md          # 项目读我文件
├── SECURITY.md        # 安全政策
├── package-lock.json  # 包锁定文件
└── package.json       # 项目包定义文件

目录结构主要包括源代码、构建产出、文档和配置文件。src 目录是核心代码存储地，其他如 build 存放构建结果，docs 有项目相关的文档，而 .editorconfig, .eslint, .gitignore, .mocharc.json, .npmignore, .prettierrc.json 等是开发辅助工具的配置。

2. 项目的启动文件介绍

该项目主要用于服务端，不包含可以直接运行的应用程序。主要的入口点在于源码中的 src 文件夹，尤其是 htmlLanguageService.ts 文件，它提供了 HTML 语言服务的核心功能。当你在自己的应用中集成这个库时，将会通过导入这个模块来创建和使用 HTML 语言服务。

例如，您可以使用以下方式引入和初始化服务：

import { createHTMLLanguageService } from 'vscode-html-languageservice';
const htmlService = createHTMLLanguageService();

3. 项目的配置文件介绍

package.json

这是项目的主配置文件，包含了项目的基本信息、依赖和脚本命令。例如，你可以看到项目使用的 typescript 和 vscode-languageserver-node 等依赖，以及像 npm test 这样的测试脚本：

{
  "name": "vscode-html-languageservice",
  ...
  "dependencies": {
    "@types/json-schema": "^7.0.9",
    "vscode-languageserver-types": "^3.15.3"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^5.18.0",
    "@typescript-eslint/parser": "^5.18.0",
    "eslint": "^8.16.0",
    "mocha": "^9.2.0",
    "typescript": "^4.8.2"
  },
  "scripts": {
    "test": "tsc && node ./out/test/main.js"
  }
}

.eslintrc.json

.eslintrc.json 是 ESLint 的配置文件，用于代码风格检查和规范。

tsconfig.json

可能存在于项目根目录下（但在这个案例中没有显示），tsconfig.json 文件定义 TypeScript 编译选项，指导 tsc 编译器如何处理源代码。

其他配置文件

其他如 .editorconfig, .gitignore, .npmignore 等文件则分别用于跨编辑器代码风格一致性、Git 忽略规则和 npm 发布时要忽略的文件列表。

完成上述步骤后，您就可以开始在您的项目中集成并使用 vscode-html-languageservice 提供的功能了。如果您想要进一步了解或贡献到此项目，阅读仓库中的 README.md 和相关文档会有很大帮助。