prevent asking "Missing JSDoc comment" for standard react methods in typescript project

Question

we have React project with Typescript. We use TSDoc to standardize the doc comments used in TypeScript code

Our eslint.trc file as follow:

{
    "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"
    }
}

How to configure this configuration file, for not asking ESLINT about documenting standard react methods, like constructor(),static getDerivedStateFromProps(),render(),componentDidMount() and etc.

We can switch "require-jsdoc":"off", but it also will not ask out user defined methods in class.

FWIW: It's "standard" (with "d" at the end, not a "t").

T.J. Crowder
– T.J. Crowder

2021-05-08 12:06:17 +00:00
Commented May 8, 2021 at 12:06 — T.J. Crowder
– T.J. Crowder, Commented May 8, 2021 at 12:06

loviji · Accepted Answer · 2021-05-16 13:29:04Z

3

I've resolved this problem with this plugin https://www.npmjs.com/package/eslint-plugin-require-jsdoc-except?activeTab=readme

You can add your function names at ignore:

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

answered May 16, 2021 at 13:29

loviji

13.1k18 gold badges66 silver badges94 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Caio Mar · Accepted Answer · 2023-01-05 20:34:43Z

1

Add this to your .eslintrc.js rules:

rules: {
  'require-jsdoc': [
    'error',
    {
      require: {
        FunctionDeclaration: false,
        MethodDefinition: false,
        ClassDeclaration: false,
        ArrowFunctionExpression: false,
        FunctionExpression: false,
      },
    },
  ],
},

Read more: https://eslint.org/docs/latest/rules/require-jsdoc

answered Jan 5, 2023 at 20:34

Caio Mar

2,6645 gold badges33 silver badges40 bronze badges

Collectives™ on Stack Overflow

prevent asking "Missing JSDoc comment" for standard react methods in typescript project

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related