防止询问“缺少JSDoc注释”的标准反应方法在打字稿项目

Question

我们用打字稿对项目作出反应。我们使用TSDoc来标准化在TypeScript代码中使用的文档注释。

我们的eslint.trc文件如下：

{
    "env": {
        "browser": true,
        "es2021": true
    },
    "extends": [
        "plugin:react/recommended",
        "google",
        "plugin:@typescript-eslint/recommended",
        "plugin:prettier/recommended"
    ],
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaFeatures": {
            "jsx": true
        },
        "ecmaVersion": 12,
        "sourceType": "module"
    },
    "plugins": [
        "react",
        "@typescript-eslint/eslint-plugin",
        "eslint-plugin-tsdoc"
    ],
    "settings": {
        "react": {
            "version": "detect"
        }
    },
    "rules": {
        "tsdoc/syntax": "warn",
        "valid-jsdoc" : 0,
        "@typescript-eslint/explicit-module-boundary-types": "off"
    }
}

如何配置此配置文件，以便不询问ESLINT如何记录标准的react方法，如constructor(),static getDerivedStateFromProps(),render(),componentDidMount() and etc.

我们可以切换"require-jsdoc":"off"，但它也不会在类中请求出用户定义的方法。

Answer 1

我已经用这个插件https://www.npmjs.com/package/eslint-plugin-require-jsdoc-except?activeTab=readme解决了这个问题

您可以在“忽略”中添加函数名：

 "ignore":[
            "constructor", "render","componentDidUpdate","getDerivedStateFromProps","componentDidMount"
         ]