-
-
Notifications
You must be signed in to change notification settings - Fork 106
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
Add meta object documentation for all rules. Closes #48 #79
Add meta object documentation for all rules. Closes #48 #79
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.
Thanks for doing this. Some general notes:
- When referencing blog posts in the docs, it’s important to indicate what the post is about. I’ve made some suggestions for these.
- In the meta info, description should be a single sentence without markdown content.
- meta.docs.url should always be a link to the rule documentation online. If no docs are available, this field can be omitted.
- It seems like these rules should all be “error” (something bad might be happening here) instead of “suggestion” (an alternate way of doing something).
Co-authored-by: Nicholas C. Zakas <[email protected]>
Co-authored-by: Nicholas C. Zakas <[email protected]>
Co-authored-by: Nicholas C. Zakas <[email protected]>
…e, markdownfree sentence.
…rkKragerup/eslint-plugin-security into add-meta-object-documentation
@nzakas i corrected all 4 points of feedbacks. The reason i put it as a suggestion instead of an "error" originally was due to the large number of false positives these rules can give. But i have changed it to "error" now, and i think we should rather work on reducing false positives in the rules separately. |
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.
LGTM. Thanks.
@nzakas When are you planning to release a new version? |
@lolgab I'd still like to get through the rest of the PRs and issues before releasing a new version. |
This pull request is an alternative from #61 and closes issue #48 Difference being:
It still has a lot of indention changes, due to the fact that adding the meta property required converting the export into a one level higher object.