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

Optionally loosen requireParam when implements/augments/extends present on tag or parent #116

Merged
merged 2 commits into from
Dec 7, 2018

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Dec 7, 2018

I wasn't sure whether to add them as settings rather than rule-specific options, but I followed your pattern.

…and `allowAugmentsExtendsWithoutParam` and apply to `requireParam` (fixes gajus#100)
Copy link
Owner

@gajus gajus left a comment

Choose a reason for hiding this comment

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

Looks great!

src/iterateJsdoc.js Outdated Show resolved Hide resolved
src/iterateJsdoc.js Outdated Show resolved Hide resolved
src/iterateJsdoc.js Outdated Show resolved Hide resolved
src/rules/requireParam.js Outdated Show resolved Hide resolved

const checkJsdoc = (functionNode) => {
const jsdocNode = sourceCode.getJSDocComment(functionNode);

if (!jsdocNode) {
return;
}
const ancestors = context.getAncestors();
Copy link
Owner

Choose a reason for hiding this comment

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

style: add a space before ancestors.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I guess you mean a line break, right? It's at the right indent...

src/iterateJsdoc.js Outdated Show resolved Hide resolved
…tParam` options to include methods whose class has the tag instead (i.e., @OverRide, @implements, @Augments, or @extends)
@brettz9
Copy link
Collaborator Author

brettz9 commented Dec 7, 2018

I've amended to address the styling issues...

@gajus gajus merged commit 7a34bb1 into gajus:master Dec 7, 2018
@gajus
Copy link
Owner

gajus commented Dec 7, 2018

🎉

@gajus
Copy link
Owner

gajus commented Dec 7, 2018

🎉 This PR is included in version 3.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants