Skip to content

Add URL to rule documentation to the metadata #10

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

Merged
merged 1 commit into from
Jan 8, 2018

Conversation

Arcanemagus
Copy link
Contributor

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.

@codecov-io
Copy link

codecov-io commented Jan 8, 2018

Codecov Report

Merging #10 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #10   +/-   ##
=======================================
  Coverage   98.66%   98.66%           
=======================================
  Files          18       18           
  Lines         225      225           
=======================================
  Hits          222      222           
  Misses          3        3
Impacted Files Coverage Δ
lib/rules/no-aggregating-enable.js 100% <ø> (ø) ⬆️
lib/rules/no-unused-disable.js 100% <ø> (ø) ⬆️
lib/rules/no-unlimited-disable.js 91.66% <ø> (ø) ⬆️
lib/rules/disable-enable-pair.js 100% <ø> (ø) ⬆️
lib/rules/no-use.js 92.3% <ø> (ø) ⬆️
lib/rules/no-unused-enable.js 100% <ø> (ø) ⬆️
lib/rules/no-duplicate-disable.js 100% <ø> (ø) ⬆️
lib/rules/no-restricted-disable.js 100% <ø> (ø) ⬆️

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 9df52a3...79ace4e. Read the comment docs.

@mysticatea
Copy link
Owner

Thank you for this PR.

But the URLs seem wrong.

@Arcanemagus
Copy link
Contributor Author

Whoops! Forgot to hit back before copying the URL. I'll update the PR.

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
Contributor Author

@mysticatea Fixed the URL.

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!

@mysticatea mysticatea merged commit 6cc5229 into mysticatea:master Jan 8, 2018
@Arcanemagus Arcanemagus deleted the rules-docs-url branch January 8, 2018 22:54
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.

3 participants