Skip to content
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

Merged
merged 2 commits into from Oct 14, 2017

Conversation

kaicataldo
Copy link
Member

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 the require-jsdoc rule.

Is there anything you'd like reviewers to focus on?
Nothing in particular!

Copy link
Member

@not-an-aardvark not-an-aardvark left a 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.

checkClassMethodJsDoc(node);
if (
(options.MethodDefinition && node.parent.type === "MethodDefinition") ||
(options.FunctionExpression && (node.parent.type === "VariableDeclarator" || node.parent.type === "Property"))
Copy link
Member

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
};

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@eslintbot
Copy link

LGTM

@not-an-aardvark not-an-aardvark added accepted There is consensus among the team that this change meets the criteria for inclusion enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules labels Oct 6, 2017
@eslint eslint deleted a comment from eslintbot Oct 6, 2017
@eslint eslint deleted a comment from eslintbot Oct 6, 2017
@kaicataldo kaicataldo force-pushed the fixes5867 branch 2 times, most recently from e0002a2 to 7365f7d Compare October 10, 2017 20:24
@eslintbot
Copy link

LGTM

@eslint eslint deleted a comment from eslintbot Oct 10, 2017
@eslint eslint deleted a comment from eslintbot Oct 10, 2017
@eslint eslint deleted a comment from eslintbot Oct 10, 2017
@ilyavolodin ilyavolodin merged commit 2247efa into master Oct 14, 2017
@ilyavolodin ilyavolodin deleted the fixes5867 branch October 14, 2017 17:57
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Apr 13, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Apr 13, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

enhance require-jsdoc to recognize function expressions
4 participants