Skip to content
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.

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

Docs: Use link to tagged version for rule docs #104

Merged
merged 1 commit into from
Jan 28, 2018

Conversation

sudo-suhas
Copy link
Contributor

This adds a utility function and uses the version present in package.json for generating the URL to tagged version of the rule documentation. 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.

Note: This is very similar to the PR mysticatea/eslint-plugin-eslint-comments#11, but including the same description just to be through.

@codecov-io
Copy link

codecov-io commented Jan 27, 2018

Codecov Report

Merging #104 into master will increase coverage by 0.02%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #104      +/-   ##
==========================================
+ Coverage   98.52%   98.54%   +0.02%     
==========================================
  Files          42       43       +1     
  Lines        1014     1030      +16     
==========================================
+ Hits          999     1015      +16     
  Misses         15       15
Impacted Files Coverage Δ
lib/rules/no-deprecated-api.js 100% <100%> (ø) ⬆️
lib/rules/no-extraneous-import.js 91.66% <100%> (+0.75%) ⬆️
lib/rules/no-missing-require.js 100% <100%> (ø) ⬆️
lib/rules/no-missing-import.js 100% <100%> (ø) ⬆️
lib/rules/shebang.js 97.56% <100%> (+0.06%) ⬆️
lib/rules/exports-style.js 98.3% <100%> (+0.02%) ⬆️
lib/util/get-docs-url.js 100% <100%> (ø)
lib/rules/no-unpublished-import.js 100% <100%> (ø) ⬆️
lib/rules/no-unpublished-bin.js 92.85% <100%> (+0.26%) ⬆️
lib/rules/no-unpublished-require.js 100% <100%> (ø) ⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27ac4a8...780a370. Read the comment docs.

Copy link
Owner

@mysticatea mysticatea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants