JSDoc Comment Issues

[nazhujan]

Currently working on project to throw error for unnecessary comment without correct label, which is easily to identify and helpful for the long run. But then I got 1 issue which is unable to ignore the JSDoc Comment which also become a blocker and i need to disable/warn the rules? any solution for this?

[wisniewski94]

Yes, under the hood plugin is doing regex match, so there is nothing to stop you from creating your own regex and adding it into allowlist. Note that /* and */ delimiters are not part of the tested string.

module.exports = {
    "env": {
        "browser": true,
        "es2021": true
    },
    "extends": "eslint:recommended",
    "parserOptions": {
        "ecmaVersion": 12
    },
    "plugins": ["no-comments"],
    "rules": {
        "no-comments/disallowComments": [
          "error",
          {
            "allow": [
              "global",
              "eslint",
              "TODO",
              "FIXME",
              "todo",
              `\\*\\s.*\n\\s\\*\\s+@`
            ]
          }
        ]
    }
};

Explanation:

• \* matches the literal * character
• \s matches any whitespace character (space, tab, etc.)
• .* matches any character zero or more times (except for newline)
• \n matches a newline character
• \*\s+ matches the * character followed by one or more whitespace characters
• @ matches the @ character

Note I am not adding this to the source code as regexp is usually heavy in terms of required computation power. Adding such rules will slow down all workspaces including ones that don't use jsdoc

What makes it more difficult is the fact that jsdoc examples tend to vary depending on a project. I don't think I will be able to cover all possible use cases so you have to come up with your own RegExp. ** I know some people might be unhappy of this decision** but there isn't anything worse than a loud spinning mac fan because eslint is running on a 1k lines file.

[tomerh2001]

@nazhujan I have a no-comments rule that supports jsdoc in my custom eslint rules: https://github.com/tomerh2001/eslint-plugin-th-rules

Feel free to check it out.