You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/rules/require-meta-docs-url.md
+2-3
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
# require rules to implement a meta.docs.url property (require-meta-docs-url)
2
2
3
-
`meta.docs.url` property is the official location to store a URL to their documentation in the rule metadata.
4
-
Some integration tools will show the URL to users to understand rules.
3
+
A rule can store the URL to its documentation page in `meta.docs.url`. This enables integration tools / IDEs / editors to conveniently provide the link to developers so that they can better understand the rule.
5
4
6
5
## Rule Details
7
6
@@ -17,7 +16,7 @@ This rule has an option.
17
16
}
18
17
```
19
18
20
-
-`pattern` (`string`) ... A pattern to enforce rule's document URL. It replaces `{{name}}` placeholder by each rule name. The rule name is the basename of each rule file. Default is undefined.
19
+
-`pattern` (`string`) ... A pattern to enforce rule's document URL. It replaces `{{name}}` placeholder by each rule name. The rule name is the basename of each rule file. Default is `undefined` which allows any URL.
21
20
22
21
If you set the `pattern` option, this rule adds `meta.docs.url` property automatically when you execute `eslint --fix` command.
0 commit comments