Merge branch 'feature/remove-classlist'

solidjs-community · Nov 1, 2022 · 197dbb5 · 197dbb5
2 parents 8c871ae + f615f9a
commit 197dbb5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/docs/prefer-classlist.md b/docs/prefer-classlist.md
@@ -1,7 +1,7 @@
 <!-- AUTO-GENERATED-CONTENT:START (HEADER) -->
 # solid/prefer-classlist
 Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames.
-This rule is **a warning** by default.
+This rule is **off** by default.
 
 [View source](../src/rules/prefer-classlist.ts) · [View tests](../test/rules/prefer-classlist.test.ts)
 
@@ -14,7 +14,7 @@ Options shown here are the defaults. Manually configuring an array will *replace
 
 ```js
 {
-  "solid/prefer-classlist": ["warn", { 
+  "solid/prefer-classlist": ["off", { 
     // An array of names to treat as `classnames` functions
     classnames: ["cn","clsx","classnames"], // Array<string>
   }]

diff --git a/src/index.ts b/src/index.ts
@@ -75,10 +75,11 @@ const plugin = {
         "solid/imports": 1,
         "solid/style-prop": 1,
         "solid/no-react-specific-props": 1,
-        "solid/prefer-classlist": 1,
         "solid/self-closing-comp": 1,
         // handled by Solid compiler, opt-in style suggestion
         "solid/prefer-show": 0,
+        // deprecated
+        "solid/prefer-classlist": 0,
       },
     },
     typescript: {
@@ -105,12 +106,13 @@ const plugin = {
         "solid/imports": 1,
         "solid/style-prop": 1,
         "solid/no-react-specific-props": 1,
-        "solid/prefer-classlist": 1,
         "solid/self-closing-comp": 1,
         // namespaces taken care of by TS
         "solid/no-unknown-namespaces": 0,
         // handled by Solid compiler, opt-in style suggestion
         "solid/prefer-show": 0,
+        // deprecated
+        "solid/prefer-classlist": 0,
       },
     },
   },

diff --git a/src/rules/prefer-classlist.ts b/src/rules/prefer-classlist.ts
@@ -6,7 +6,7 @@ const rule: TSESLint.RuleModule<"preferClasslist", [{ classnames?: [string, ...A
     meta: {
       type: "problem",
       docs: {
-        recommended: "warn",
+        recommended: false,
         description:
           "Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames.",
         url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/prefer-classlist.md",
@@ -34,6 +34,7 @@ const rule: TSESLint.RuleModule<"preferClasslist", [{ classnames?: [string, ...A
         preferClasslist:
           "The classlist prop should be used instead of {{ classnames }} to efficiently set classes based on an object.",
       },
+      deprecated: true,
     },
     create(context) {
       const classnames = context.options[0]?.classnames ?? ["cn", "clsx", "classnames"];