Skip to content

Add URL to rule documentation to the metadata#59

Open
Arcanemagus wants to merge 1 commit intojfmengels:masterfrom
Arcanemagus:rules-docs-url
Open

Add URL to rule documentation to the metadata#59
Arcanemagus wants to merge 1 commit intojfmengels:masterfrom
Arcanemagus:rules-docs-url

Conversation

@Arcanemagus
Copy link
Copy Markdown

ESLint v4.15.0 added an official location for rules to store a URL to their documentation in the rule metadata in eslint/eslint#9788. This adds the URL to all the existing rules so anything consuming them can
know where their documentation is without having to resort to external packages to guess.

@Arcanemagus
Copy link
Copy Markdown
Author

Looks like the build failure is unrelated to this PR.

@graingert
Copy link
Copy Markdown
Collaborator

I've recently merged #62 which fixed the travis tests. Please could you rebase this PR to re-run the travis tests.

@Arcanemagus
Copy link
Copy Markdown
Author

@graingert Rebased, and the specs pass now 😉.

@graingert
Copy link
Copy Markdown
Collaborator

@Arcanemagus make it match eslint-plugin-lodash wix-incubator/eslint-plugin-lodash@8e3f4dc

@Arcanemagus
Copy link
Copy Markdown
Author

Sorry, just saw your comment. I'll update that to match. (Funny that they copied a PR I did to another eslint-plugin-* project and didn't link to it...)

@graingert
Copy link
Copy Markdown
Collaborator

Great, thanks!

ESLint v4.15.0 added an official location for rules to store a URL to
their documentation in the rule metadata in eslint/eslint#9788. This
adds the URL to all the existing rules so anything consuming them can
know where their documentation is without having to resort to external
packages to guess.
@Arcanemagus
Copy link
Copy Markdown
Author

Updated, the function will return a URL that uses the tagged documentation for the exact version the user has installed.

If there are any other changes let me know 😉.

@graingert
Copy link
Copy Markdown
Collaborator

Great, thanks! I probably won't be able to get back to this until Monday

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants