Add URL to rule documentation to the metadata #59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks like the build failure is unrelated to this PR. |
|
I've recently merged #62 which fixed the travis tests. Please could you rebase this PR to re-run the travis tests. |
Arcanemagus
force-pushed
the
rules-docs-url
branch
from
2e6ae46 to
6de74dc
Compare
|
@graingert Rebased, and the specs pass now 😉. |
|
@Arcanemagus make it match |
|
Sorry, just saw your comment. I'll update that to match. (Funny that they copied a PR I did to another |
|
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
force-pushed
the
rules-docs-url
branch
from
6de74dc to
d3354eb
Compare
|
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 😉. |
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.