From cb907467d6aab61b9059a48f0a70c2e0a9bcd296 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Mon, 30 Dec 2024 17:14:57 -0500 Subject: [PATCH 1/2] docs: Add warning about extending core rules fixes #19169 --- docs/src/extend/custom-rules.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/src/extend/custom-rules.md b/docs/src/extend/custom-rules.md index 24f0489521d3..4b29f539cf2b 100644 --- a/docs/src/extend/custom-rules.md +++ b/docs/src/extend/custom-rules.md @@ -32,6 +32,10 @@ module.exports = { }; ``` +::: warning +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 mostly 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. +::: + ## Rule Structure The source file for a rule exports an object with the following properties. Both custom rules and core rules follow this format. From 3273a5a53ce8feb08ad6c0c81cc2a63137b20c48 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Tue, 31 Dec 2024 12:25:01 -0500 Subject: [PATCH 2/2] Update docs/src/extend/custom-rules.md Co-authored-by: Amaresh S M --- docs/src/extend/custom-rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/extend/custom-rules.md b/docs/src/extend/custom-rules.md index 4b29f539cf2b..66b679f9358e 100644 --- a/docs/src/extend/custom-rules.md +++ b/docs/src/extend/custom-rules.md @@ -33,7 +33,7 @@ module.exports = { ``` ::: warning -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 mostly 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. +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. ::: ## Rule Structure pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy