javascript - Eslint Jsdoc插件未执行

Question

我正在尝试运行 ESLint JSDoc plugin

当我运行 npx eslint . 时，会强制执行 Airbnb 规则，但不会强制执行需要添加 JSDoc 的 jsdoc 规则。 我错过了什么吗？

这是一个test repo

package.json

{
  "name": "eslint-test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "eslint": "^6.7.2",
    "eslint-config-airbnb-base": "^14.0.0",
    "eslint-plugin-import": "^2.19.1",
    "eslint-plugin-jsdoc": "^18.4.3"
  }
}

index.js

const fn = (a) => {
  console.log('a :', a);
  return a;
};

module.exports = { fn };

Answer 1

您缺少 ESLint 配置文件。将 .eslintrc.js 添加到项目的根目录。然后复制以下基本配置:

module.exports = {
    root: true,
    plugins: ['jsdoc', 'import'],
    extends: [
        'eslint:recommended',
        'plugin:jsdoc/recommended',
        'plugin:import/errors',
        'plugin:import/warnings',
         'airbnb-base'
    ]
}

参见Configuring ESLinf了解更多信息。