Skip to content

Implement a requireJSDoc compatible rule with working tests #205

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Apr 18, 2019
Merged

Implement a requireJSDoc compatible rule with working tests #205

merged 10 commits into from
Apr 18, 2019

Conversation

allthesignals
Copy link
Contributor

Forked from the proposed pull request here: #188.

Original text from @thsmi:

Implements a requireJSDoc compatible rule as described in issue #162.

The unit test file is ported from eslint and therefore MIT licensed for more details refer also to issue #162

@allthesignals
Copy link
Contributor Author

Actually, the tests pass locally, so I'm not sure what's happening.

@allthesignals allthesignals reopened this Apr 17, 2019
@allthesignals allthesignals force-pushed the master branch 2 times, most recently from 8dda5fb to 6290537 Compare April 18, 2019 13:53
@allthesignals allthesignals mentioned this pull request Apr 18, 2019
Merged
@allthesignals
Copy link
Contributor Author

Should be good to go! The latest commit here is a cleaner approach using git mv and git rm.

gajus
gajus reviewed Apr 18, 2019
View reviewed changes
src/rules/requireJsdoc.js Outdated
@@ -0,0 +1,166 @@
//
Copy link
Owner

Choose a reason for hiding this comment

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

Unnecessary comment.

gajus
gajus reviewed Apr 18, 2019
View reviewed changes
src/rules/requireJsdoc.js Outdated
// Thus this method implements a compatible requireJSDoc rule.
//

/* eslint-disable sort-keys */
Copy link
Owner

Choose a reason for hiding this comment

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

Unnecessary eslint-disable/ comment.

Sorted property style is enforced across the entire library. This rule implementation is not an exception.

@gajus
Copy link
Owner

gajus commented Apr 18, 2019

Thank you for cleaning this up. I've added to style comments. Can you please address them? Otherwise, I am happy to jump in and amend the the PR in the next 24 hours.

@allthesignals
Copy link
Contributor Author

@gajus I will be happy to - @thsmi, is this okay? I feel I am co-opting your original PR. Otherwise, will continue with cleanup.

@allthesignals
Copy link
Contributor Author

@gajus I committed some changes that address your comments. Let me know if there's anything else.

Thanks!

@gajus gajus merged commit dc6857a into gajus:master Apr 18, 2019
@gajus
Copy link
Owner

gajus commented Apr 18, 2019

Noticed after merging that this was submitted without the accompanying documentation. That would be a nice follow up PR.

@allthesignals allthesignals mentioned this pull request Apr 18, 2019
Closed
@philsch philsch mentioned this pull request Apr 20, 2019
Closed
@gajus
Copy link
Owner

gajus commented May 11, 2019

🎉 This PR is included in version 4.8.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label May 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gajus gajus gajus left review comments

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@allthesignals @gajus @thsmi