Skip to content

Commit

Permalink
Update: Add placeholder for meta.docs.url in rule template (#99)
Browse files Browse the repository at this point in the history
To encourage rule authors to fill in the rule URL so that IDEs / code editors can provide a link to rule documentation on violations: https://eslint.org/docs/developer-guide/working-with-rules#rule-basics

Related: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md
  • Loading branch information
bmish committed Jul 8, 2021
1 parent 3fe65c2 commit f895bcd
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion rule/templates/_rule.js
Expand Up @@ -14,7 +14,8 @@ module.exports = {
docs: {
description: "<%- desc.replace(/"/g, '\\"') %>",
category: "Fill me in",
recommended: false
recommended: false,
url: null, // URL to the documentation page for this rule
},
fixable: null, // or "code" or "whitespace"
schema: [
Expand Down

0 comments on commit f895bcd

Please sign in to comment.