vscode-markdownlint 使用教程

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

vscode-markdownlint/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── rules/
│   ├── default.json
│   └── recommended.json
├── src/
│   ├── extension.ts
│   └── markdownlint.ts
├── syntaxes/
│   └── markdown.tmLanguage
└── test/
    ├── extension.test.ts
    └── markdownlint.test.ts

• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的开源许可证。
• README.md: 项目的基本介绍和使用说明。
• package.json: 项目的依赖和脚本配置文件。
• rules/: 包含默认和推荐的规则配置文件。
• src/: 项目的源代码目录，包含扩展和核心逻辑。
• syntaxes/: 包含Markdown语法定义文件。
• test/: 包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts，它负责初始化扩展并注册命令和配置。以下是该文件的主要功能：

• 注册命令：如格式化文档、格式化选定内容等。
• 配置监听器：监听文件变化并执行相应的Lint操作。
• 初始化Markdownlint库并应用规则。

3. 项目的配置文件介绍

项目的配置文件主要有两个：

• package.json: 包含项目的依赖、脚本和扩展配置。例如：

  {
    "name": "vscode-markdownlint",
    "displayName": "markdownlint",
    "version": "0.41.0",
    "publisher": "DavidAnson",
    "engines": {
      "vscode": "^1.50.0"
    },
    "categories": [
      "Linters"
    ],
    "activationEvents": [
      "onLanguage:markdown"
    ],
    "main": "./out/extension",
    "contributes": {
      "configuration": {
        "type": "object",
        "title": "markdownlint",
        "properties": {
          "markdownlint.config": {
            "type": "object",
            "default": {},
            "description": "Configuration options for markdownlint."
          }
        }
      }
    }
  }
  

• rules/default.json: 包含默认的Lint规则配置。例如：

  {
    "MD001": true,
    "MD003": { "style": "atx" },
    "MD004": { "style": "dash" },
    "MD009": { "br_spaces": 2 }
  }
  

这些配置文件允许用户自定义Lint规则，以适应不同的编码风格和需求。