Added fixtures from tutorial, reduced reactivity and style-prop to warnings.

Author: joshwilsonvu

README.md

@@ -46,6 +46,7 @@ This disables some features that overlap with type checking.
 
 ```json
 {
+  "parser": "@typescript-eslint/parser",
   "plugins": ["solid"],
   "extends": ["eslint/recommended", "plugin:solid/typescript"]
 }
@@ -97,7 +98,7 @@ would like to use.
 
 ## Versioning
 
-Pre-1.0.0, the rules and the `recommended` and `typescript` configuations will be 
+Pre-1.0.0, the rules and the `recommended` and `typescript` configuations will be
 stable across patch (`0.0.x`) versions, but may change across minor (`0.x`) versions.
 If you want to pin a minor version, use a tilde in your `package.json`.
 

docs/no-innerhtml.md

@@ -16,7 +16,7 @@ This rule is **an error** by default.
 
 Key | Type | Description
 :--- | :---: | :---
-allowStatic | `boolean` |  
+allowStatic | `boolean` | if the innerHTML value is guaranteed to be a static HTML string (i.e. no user input), allow it 
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 <!-- AUTO-GENERATED-CONTENT:START (CASES) -->

docs/reactivity.md

@@ -1,7 +1,7 @@
 <!-- AUTO-GENERATED-CONTENT:START (HEADER) -->
 # solid/reactivity
 Enforce that reactive expressions (props, signals, memos, etc.) are only used in tracked scopes; otherwise, they won't update the view as expected.
-This rule is **an error** by default.
+This rule is **a warning** by default.
 
 [View source](../src/rules/reactivity.ts) · [View tests](../test/rules/reactivity.test.ts)
 

docs/style-prop.md

@@ -1,7 +1,7 @@
 <!-- AUTO-GENERATED-CONTENT:START (HEADER) -->
 # solid/style-prop
 Require CSS properties in the `style` prop to be valid and kebab-cased (ex. 'font-size'), not camel-cased (ex. 'fontSize') like in React, and that property values are strings, not numbers with implicit 'px' units.
-This rule is **an error** by default.
+This rule is **a warning** by default.
 
 [View source](../src/rules/style-prop.ts) · [View tests](../test/rules/style-prop.test.ts)
 
@@ -16,8 +16,8 @@ This rule is **an error** by default.
 
 Key | Type | Description
 :--- | :---: | :---
-styleProps | `Array<string>` |  
-allowString | `boolean` |  
+styleProps | `Array<string>` | an array of prop names to treat as a CSS style object *Default `["style"]`*.
+allowString | `boolean` | if allowString is set to true, this rule will not convert a style string literal into a style object (not recommended for performance) 
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 <!-- AUTO-GENERATED-CONTENT:START (CASES) -->

package.json

@@ -52,6 +52,7 @@
     "eslint-plugin-import": "^2.25.3",
     "eslint-v6": "npm:eslint@^6.0.0",
     "eslint-v7": "npm:eslint@^7.0.0",
+    "fast-glob": "^3.2.11",
     "fs-extra": "^10.0.0",
     "husky": "^7.0.0",
     "jest": "^27.4.4",

scripts/docs.ts

@@ -67,12 +67,12 @@ const buildOptions = (filename: string): string => {
     ":--- | :---: | :---",
     ...Object.keys(properties).map((prop) => {
       let type = properties[prop].type;
-      const default_ = properties[prop].default;
+      const _default = properties[prop].default;
       if (type === "array") {
         type = `Array<${properties[prop].items.type}>`;
       }
       return `${prop} | \`${type}\` | ${properties[prop].description ?? ""} ${
-        default_ ? `*Default \`${default_}\`*.` : ""
+        _default ? `*Default \`${JSON.stringify(_default)}\`*.` : ""
       }`;
     }),
   ].join("\n");

src/index.ts

@@ -7,6 +7,7 @@ import noUnknownNamespaces from "./rules/no-unknown-namespaces";
 // import noUselessKeys from './rules/no-useless-keys';
 import preferClasslist from "./rules/prefer-classlist";
 import preferFor from "./rules/prefer-for";
+// import preferShow from './rules/prefer-show';
 import reactivity from "./rules/reactivity";
 import styleProp from "./rules/style-prop";
 
@@ -20,6 +21,7 @@ const allRules = {
   // noUselessKeys,
   "prefer-classlist": preferClasslist,
   "prefer-for": preferFor,
+  // "prefer-show": preferShow,
   reactivity,
   "style-prop": styleProp,
 };
@@ -46,14 +48,14 @@ module.exports = {
         "solid/jsx-no-undef": 2,
         "solid/jsx-uses-vars": 2,
         "solid/no-unknown-namespaces": 2,
-        // incorrect usages of innerHTML, <For />, and style are security or logic errors
+        // incorrect usages of innerHTML and <For /> are security or logic errors
         "solid/no-innerhtml": [2, { allowStatic: true }],
         "solid/prefer-for": 2,
-        "solid/style-prop": 2,
         // reactivity
         "solid/no-destructure": 2,
-        "solid/reactivity": 2,
+        "solid/reactivity": 1,
         // these rules are mostly style suggestions
+        "solid/style-prop": 1,
         "solid/no-react-specific-props": 1,
         "solid/prefer-classlist": 1,
       },
@@ -68,14 +70,14 @@ module.exports = {
         // identifier usage is important
         "solid/jsx-no-undef": [2, { typescriptEnabled: true }],
         "solid/jsx-uses-vars": 2,
-        // incorrect usages of innerHTML, <For />, and style are security or logic errors
+        // incorrect usages of innerHTML and <For /> are security or logic errors
         "solid/no-innerhtml": [2, { allowStatic: true }],
         "solid/prefer-for": 2,
-        "solid/style-prop": 2,
         // reactivity
         "solid/no-destructure": 2,
-        "solid/reactivity": 2,
+        "solid/reactivity": 1,
         // these rules are mostly style suggestions
+        "solid/style-prop": 1,
         "solid/no-react-specific-props": 1,
         "solid/prefer-classlist": 1,
         // namespaces taken care of by TS

src/rules/no-innerhtml.ts

@@ -22,8 +22,9 @@ const rule: TSESLint.RuleModule<
       {
         type: "object",
         properties: {
-          // if the innerHTML value is guaranteed to be a static string (i.e. no user input), allow it
           allowStatic: {
+            description:
+              "if the innerHTML value is guaranteed to be a static HTML string (i.e. no user input), allow it",
             type: "boolean",
           },
         },

src/rules/prefer-show.ts

@@ -0,0 +1 @@
+export {};

src/rules/style-prop.ts

@@ -24,17 +24,19 @@ const rule: TSESLint.RuleModule<
       {
         type: "object",
         properties: {
-          // an array of prop names to treat as a CSS style object, defaults to ["style"]
           styleProps: {
+            description: "an array of prop names to treat as a CSS style object",
+            default: ["style"],
             type: "array",
             items: {
               type: "string",
               minItems: 1,
               uniqueItems: true,
             },
           },
-          // if allowString is set to true, this rule will not convert a style string literal into a style object (not recommended for performance)
           allowString: {
+            description:
+              "if allowString is set to true, this rule will not convert a style string literal into a style object (not recommended for performance)",
             type: "boolean",
           },
         },