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: Mention benefit of rules providing meta.docs.url #14774

Merged
merged 1 commit into from Jul 8, 2021

Conversation

bmish
Copy link
Sponsor Member

@bmish bmish commented Jul 6, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Perhaps the top benefit of rules providing the meta.docs.url property with a link to their documentation is that IDEs / code editors can then provide a helpful link on rule violations. Developers often find this link useful to better understand a violation and learn how to fix it.

However, many rule authors are unaware of this feature and thus exclude the property because they don't see the value of it.

Mentioning this feature in ESLint's rule documentation should help encourage greater adoption of this property. It's an easy improvement to a rule that can benefit hundreds or thousands of developers using the rule.

Note that there is also a lint rule to require and autofix this property: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md

Is there anything you'd like reviewers to focus on?

No.

Perhaps the top benefit of rules providing the `meta.docs.url` property with a link to their documentation is that IDEs / code editors can then provide a helpful link on rule violations. Developers often find this link useful to better understand a violation and learn how to fix it.

However, many rule authors are unaware of this feature and thus exclude the property because they don't see the value of it.

Mentioning this feature in ESLint's rule documentation should help encourage greater adoption of this property.

Note that there is also a lint rule to require and autofix this property: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md
@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jul 6, 2021
@bmish bmish changed the title Docs: Mention benefit of providing meta.docs.url Docs: Mention benefit of rules providing meta.docs.url Jul 6, 2021
Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM, thanks!

@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon accepted There is consensus among the team that this change meets the criteria for inclusion labels Jul 7, 2021
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Makes sense to me. LGTM, thanks!

@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jul 7, 2021
@aladdin-add aladdin-add merged commit b0d22e3 into eslint:master Jul 8, 2021
14 checks passed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jan 5, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants