New: CLIEngine#getRules() (refs #6582)

[pmcelhaney]

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[x] Add a CLI option method
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

• add CLIEngine#getRules() as discussed in TSC
• update the documentation and unit tests

Is there anything you'd like reviewers to focus on?

Next step::

• add meta.docs.url to each of the built-in rules
• document meta.docs.url as a property that third party rules are encouraged to include

[platinumazure]

LGTM, thanks for contributing!

[j-f1]

Would it be possible to add a method on the exported plugin object that generates the docs URL so that people can optionally DRY out their code? (i.e. getDocsURL: name => `https://github.com/foo/eslint-plugin-bar/blob/master/docs/rules/${name}.md` instead of providing meta.docs.url on each rule)

[platinumazure]

That could be interesting/valuable, but this PR probably isn't the place to discuss :-)

…

On Dec 28, 2017 11:25 AM, "Jed Fox" ***@***.***> wrote: Would it be possible to add a method on the exported plugin object that generates the docs URL so that people can optionally DRY out their code? (i.e. getDocsURL: name => `https://github.com/foo/ eslint-plugin-bar/blob/master/docs/rules/${name}.md` <https://github.com/foo/eslint-plugin-bar/blob/master/docs/rules/$%7Bname%7D.md> instead of providing meta.docs.url on each rule) — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#9782 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARWenHw8utTXlFhW-6gXs_IpfKWUDTKks5tE875gaJpZM4ROYPV> .

[ilyavolodin]

Also it already can be done by extracting the logic into a separate file, and importing it into each rule in the plugin.

[platinumazure]

Would you mind rebasing on master and adding this new function to the table of contents added in #9785? Thanks!

[pmcelhaney]

@platinumazure Done. Thanks for merging #9785!

[platinumazure]

LGTM, thanks!