Skip to content

Commit a559009

Browse files
nzakasamareshsm
andauthored
docs: Add warning about extending core rules (#19295)
* docs: Add warning about extending core rules fixes #19169 * Update docs/src/extend/custom-rules.md Co-authored-by: Amaresh S M <[email protected]> --------- Co-authored-by: Amaresh S M <[email protected]>
1 parent 0bfdf6c commit a559009

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/src/extend/custom-rules.md

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ module.exports = {
3232
};
3333
```
3434

35+
::: warning
36+
The core rules shipped in the `eslint` package are not considered part of the public API and are not designed to be extended from. Building on top of these rules is fragile and will most likely result in your rules breaking completely at some point in the future. If you're interested in creating a rule that is similar to a core rule, you should first copy the rule file into your project and proceed from there.
37+
:::
38+
3539
## Rule Structure
3640

3741
The source file for a rule exports an object with the following properties. Both custom rules and core rules follow this format.

0 commit comments

Comments
 (0)