Use link to tagged version for rule docs #1005
Merged
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
ljharb
reviewed
Jan 22, 2018
src/docsUrl.js
Outdated
| @@ -1,5 +1,7 @@ | |||
| import pkg from '../package' | |||
There was a problem hiding this comment.
it'd be nice to use .json here (unless the linter objects)
sudo-suhas
force-pushed
the
docs-link-tagged
branch
from
b2a5024 to
8d203d8
Compare
ljharb
reviewed
Jan 22, 2018
tests/src/core/docsUrl.js
Outdated
| @@ -1,13 +1,14 @@ | |||
| import { expect } from 'chai' | |||
|
|
|||
| import pkg from '../../../package' | |||
There was a problem hiding this comment.
Yea.. realised it after the first push 😅. Done.
sudo-suhas
force-pushed
the
docs-link-tagged
branch
from
8d203d8 to
fa24082
Compare
ljharb
approved these changes
Jan 22, 2018
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.
This uses the version present in package.json for generating the URL to rule documentation if no commit-ish value is passed. I think this is good because the documentation will match the version the user has installed. This way, even if a rule is changed or removed in the future, the user can find the documentation with ease.