Ignore option on the require-jsdoc rule

( I am using “eslint”: “^1.9.0” ) It will be nice if we can specify functions that the rule will ignore. e.g. the render function on React components is kinda obvious what is doing and a comment block is not really needed.

It will be nice if we can have something like:

        "require-jsdoc"              : [ 2,
        {
            "require":
            {
                "FunctionDeclaration" : true,
                "MethodDefinition" : true,
                "ClassDeclaration" : true
            },
            "ignore":
            {
                "render"  : true,
                "constructor" : true,
                "componentDidMount"  : true
            }
        }],

[nzakas]

This would be a pretty big hack and would likely have a lot of false positives, so I don’t think we can implement this.

[JakubRimal]

There is a quite new plugin for that: https://github.com/MaienM/eslint-plugin-require-jsdoc-except

It even supports regular expressions so you can add e.g. ignore rule "/^_.*$/" which will ignore require-jsdoc for all method/functions starting with _.