Skip to content

Add ESLint meta object with description and category #61

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
Closed
wants to merge 1 commit into from
Closed

Add ESLint meta object with description and category #61

wants to merge 1 commit into from

Conversation

lolgab
Copy link

@lolgab lolgab commented Feb 28, 2020

Hi team,
We use your plugin at Codacy for automated code reviews :)
We use ESLint's meta object field to add descriptions to the rules in our wrapper
This PR adds the descriptions to all the rules taken from the comments in the source files.

Hope this will be accepted.
Lorenzo

@lolgab
Copy link
Author

lolgab commented Feb 28, 2020

In the changes you see most of them are changes in indentation.
I removed some unused variables too.

@lolgab lolgab changed the title Add ESLint meta object with description and category [WIP] Add ESLint meta object with description and category Feb 28, 2020
@lolgab lolgab force-pushed the add-meta-documentation branch from fa1c94f to 7e62ba7 Compare February 28, 2020 18:02
@lolgab lolgab changed the title [WIP] Add ESLint meta object with description and category Add ESLint meta object with description and category Feb 28, 2020
@lolgab
Copy link
Author

lolgab commented Mar 9, 2020

Can I have a review here? :)

@brettz9
Copy link
Member

brettz9 commented May 13, 2020

It'd be great to have meta.type too, so that formatters (like my https://github.com/brettz9/eslint-formatter-badger ) can include that information automatically in its summarizing of linting results (e.g., number of "problem" failures vs. "layout" or "suggestion").

As an organization, is anyone still active here to review this or the other PRs, @evilpacket ? @nlf ?

@jesusprubio jesusprubio mentioned this pull request Mar 25, 2022
Closed
MarkKragerup added a commit to MarkKragerup/eslint-plugin-security that referenced this pull request Mar 28, 2022
@MarkKragerup
Closes eslint-community#61
9b14e56
@MarkKragerup MarkKragerup mentioned this pull request Mar 28, 2022
Merged
@MarkKragerup
Copy link
Contributor

MarkKragerup commented Mar 28, 2022 •
edited
Loading

I made a PR to replace this one as part of the new maintenance kickoff. The differences are outlined in the description: #79

@lolgab
Copy link
Author

lolgab commented Mar 28, 2022

@MarkKragerup Thank you for taking over! I forgot about this PR!
I'm closing this since it's superseded by #79

@lolgab lolgab closed this Mar 28, 2022
@lolgab lolgab deleted the add-meta-documentation branch March 28, 2022 13:49
@MarkKragerup
Copy link
Contributor

MarkKragerup commented Mar 28, 2022 •
edited
Loading

@lolgab you are welcome. Happy to help. And thank you for raising the issue!

nzakas added a commit that referenced this pull request Mar 30, 2022
@MarkKragerup @nzakas
feat: Add meta object documentation for all rules (#79)
fb1d9ef 
* Update .gitignore

* Closes #61
* Closes #48 

* Update README.md

Co-authored-by: Nicholas C. Zakas <[email protected]>

* Update README.md

Co-authored-by: Nicholas C. Zakas <[email protected]>

* Update README.md

Co-authored-by: Nicholas C. Zakas <[email protected]>

* docs: changed meta urls to rule docs and shortened descriptions to one, markdownfree sentence.

* docs: corrected snyk description

* docs: updated to link on main

Co-authored-by: Nicholas C. Zakas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lolgab @brettz9 @MarkKragerup