eslint-plugin-tsdoc

NPM 包
CHANGELOG.md

这个 ESLint 插件提供了一个规则，用于验证 TypeScript 文档注释是否符合 TSDoc 规范。

用法

1. 为你的 TypeScript 项目配置 ESLint。请参阅 typescript-eslint 项目提供的说明。你最终会得到一些像这样的依赖项

   my-project/package.json (示例)

   {
     "name": "my-project",
     "version": "1.0.0",
     "dependencies": {},
     "devDependencies": {
       "@typescript-eslint/eslint-plugin": "~2.6.1",
       "@typescript-eslint/parser": "~2.6.1",
       "eslint": "~6.6.0",
       "typescript": "~3.7.2"
     },
     "scripts": {
       "lint": "eslint -f unix \"src/**/*.{ts,tsx}\""
     }
   }

2. 将 eslint-plugin-tsdoc 依赖项添加到你的项目

   $ cd my-project
   $ npm install --save-dev eslint-plugin-tsdoc

3. 在你的 ESLint 配置文件中，将 "eslint-plugin-tsdoc" 包添加到你的 plugins 字段，并启用 "tsdoc/syntax" 规则。例如

   my-project/.eslintrc.js (示例)

   module.exports = {
     plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc'],
     extends: ['plugin:@typescript-eslint/recommended'],
     parser: '@typescript-eslint/parser',
     parserOptions: {
       project: './tsconfig.json',
       tsconfigRootDir: __dirname,
       ecmaVersion: 2018,
       sourceType: 'module'
     },
     rules: {
       'tsdoc/syntax': 'warn'
     }
   };