New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update: Add FunctionExpression to require-jsdoc (fixes #5867) #9395
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This generally looks good to me, I just noticed a small edge case.
lib/rules/require-jsdoc.js
Outdated
checkClassMethodJsDoc(node); | ||
if ( | ||
(options.MethodDefinition && node.parent.type === "MethodDefinition") || | ||
(options.FunctionExpression && (node.parent.type === "VariableDeclarator" || node.parent.type === "Property")) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the node.parent.type === "Property"
check also verify that node === node.parent.value
?
Otherwise, I think something like this will be reported:
var foo = {
[function() {}]: 1
};
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
LGTM |
e0002a2
to
7365f7d
Compare
LGTM |
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[X] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Fixes #5867.
Add a
FunctionExpression
configuration option to therequire-jsdoc
rule.Is there anything you'd like reviewers to focus on?
Nothing in particular!