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

如何解决防止在打字稿项目中为标准反应方法询问“缺少 JSDoc 注释”

我们有带有 Typescript 的 React 项目。 我们使用 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 关于记录标准反应方法的信息，比如 constructor(),static getDerivedStateFromProps(),render(),componentDidMount() and etc.

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

解决方法

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

你可以在ignore处添加你的函数名：

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