Update docs script, fixture timeouts.

joshwilsonvu · joshwilsonvu · commit c842390bbfe3 · 2022-11-01T11:46:49.000-04:00
diff --git a/README.md b/README.md
@@ -119,27 +119,25 @@ const [editedValue, setEditedValue] = createSignal(props.value);
 🔧: Fixable with [`eslint --fix`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems)/IDE auto-fix.
 
 <!-- AUTO-GENERATED-CONTENT:START (RULES) -->
-
-|  ✔  | 🔧  | Rule                                                             | Description                                                                                                                                                                                                                           |
-| :-: | :-: | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-|  ✔  | 🔧  | [solid/components-return-once](docs/components-return-once.md)   | Disallow early returns in components. Solid components only run once, and so conditionals should be inside JSX.                                                                                                                       |
-|  ✔  | 🔧  | [solid/event-handlers](docs/event-handlers.md)                   | Enforce naming DOM element event handlers consistently and prevent Solid's analysis from misunderstanding whether a prop should be an event handler.                                                                                  |
-|  ✔  | 🔧  | [solid/imports](docs/imports.md)                                 | Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store".                                                                                                                                                     |
-|  ✔  |     | [solid/jsx-no-duplicate-props](docs/jsx-no-duplicate-props.md)   | Disallow passing the same prop twice in JSX.                                                                                                                                                                                          |
-|  ✔  |     | [solid/jsx-no-script-url](docs/jsx-no-script-url.md)             | Disallow javascript: URLs.                                                                                                                                                                                                            |
-|  ✔  | 🔧  | [solid/jsx-no-undef](docs/jsx-no-undef.md)                       | Disallow references to undefined variables in JSX. Handles custom directives.                                                                                                                                                         |
-|  ✔  |     | [solid/jsx-uses-vars](docs/jsx-uses-vars.md)                     | Prevent variables used in JSX from being marked as unused.                                                                                                                                                                            |
-|  ✔  | 🔧  | [solid/no-destructure](docs/no-destructure.md)                   | Disallow destructuring props. In Solid, props must be used with property accesses (`props.foo`) to preserve reactivity. This rule only tracks destructuring in the parameter list.                                                    |
-|  ✔  | 🔧  | [solid/no-innerhtml](docs/no-innerhtml.md)                       | Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities.                                                                                                                                          |
-|  ✔  | 🔧  | [solid/no-react-specific-props](docs/no-react-specific-props.md) | Disallow usage of React-specific `className`/`htmlFor` props, which were deprecated in v1.4.0.                                                                                                                                        |
-|  ✔  |     | [solid/no-unknown-namespaces](docs/no-unknown-namespaces.md)     | Enforce using only Solid-specific namespaced attribute names (i.e. `'on:'` in `<div on:click={...} />`).                                                                                                                              |
-|  ✔  | 🔧  | [solid/prefer-classlist](docs/prefer-classlist.md)               | Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames.                                                                        |
-|  ✔  | 🔧  | [solid/prefer-for](docs/prefer-for.md)                           | Enforce using Solid's `<For />` component for mapping an array to JSX elements.                                                                                                                                                       |
-|  ✔  | 🔧  | [solid/prefer-show](docs/prefer-show.md)                         | Enforce using Solid's `<Show />` component for conditionally showing content. Solid's compiler covers this case, so it's a stylistic rule only.                                                                                       |
-|  ✔  |     | [solid/reactivity](docs/reactivity.md)                           | Enforce that reactive expressions (props, signals, memos, etc.) are only used in tracked scopes; otherwise, they won't update the view as expected.                                                                                   |
-|  ✔  | 🔧  | [solid/self-closing-comp](docs/self-closing-comp.md)             | Disallow extra closing tags for components without children.                                                                                                                                                                          |
-|  ✔  | 🔧  | [solid/style-prop](docs/style-prop.md)                           | 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 with dimensions are strings, not numbers with implicit 'px' units. |
-
+| ✔ | 🔧 | Rule | Description |
+| :---: | :---: | :--- | :--- |
+| ✔ | 🔧 | [solid/components-return-once](docs/components-return-once.md) | Disallow early returns in components. Solid components only run once, and so conditionals should be inside JSX. |
+| ✔ | 🔧 | [solid/event-handlers](docs/event-handlers.md) | Enforce naming DOM element event handlers consistently and prevent Solid's analysis from misunderstanding whether a prop should be an event handler. |
+| ✔ | 🔧 | [solid/imports](docs/imports.md) | Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store". |
+| ✔ |  | [solid/jsx-no-duplicate-props](docs/jsx-no-duplicate-props.md) | Disallow passing the same prop twice in JSX. |
+| ✔ |  | [solid/jsx-no-script-url](docs/jsx-no-script-url.md) | Disallow javascript: URLs. |
+| ✔ | 🔧 | [solid/jsx-no-undef](docs/jsx-no-undef.md) | Disallow references to undefined variables in JSX. Handles custom directives. |
+| ✔ |  | [solid/jsx-uses-vars](docs/jsx-uses-vars.md) | Prevent variables used in JSX from being marked as unused. |
+| ✔ | 🔧 | [solid/no-destructure](docs/no-destructure.md) | Disallow destructuring props. In Solid, props must be used with property accesses (`props.foo`) to preserve reactivity. This rule only tracks destructuring in the parameter list. |
+| ✔ | 🔧 | [solid/no-innerhtml](docs/no-innerhtml.md) | Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities. |
+| ✔ | 🔧 | [solid/no-react-specific-props](docs/no-react-specific-props.md) | Disallow usage of React-specific `className`/`htmlFor` props, which were deprecated in v1.4.0. |
+| ✔ |  | [solid/no-unknown-namespaces](docs/no-unknown-namespaces.md) | Enforce using only Solid-specific namespaced attribute names (i.e. `'on:'` in `<div on:click={...} />`). |
+| ✔ | 🔧 | [solid/prefer-classlist](docs/prefer-classlist.md) | Enforce using the classlist prop over importing a classnames helper. The classlist prop accepts an object `{ [class: string]: boolean }` just like classnames. |
+| ✔ | 🔧 | [solid/prefer-for](docs/prefer-for.md) | Enforce using Solid's `<For />` component for mapping an array to JSX elements. |
+| ✔ | 🔧 | [solid/prefer-show](docs/prefer-show.md) | Enforce using Solid's `<Show />` component for conditionally showing content. Solid's compiler covers this case, so it's a stylistic rule only. |
+| ✔ |  | [solid/reactivity](docs/reactivity.md) | Enforce that reactive expressions (props, signals, memos, etc.) are only used in tracked scopes; otherwise, they won't update the view as expected. |
+| ✔ | 🔧 | [solid/self-closing-comp](docs/self-closing-comp.md) | Disallow extra closing tags for components without children. |
+| ✔ | 🔧 | [solid/style-prop](docs/style-prop.md) | 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 with dimensions are strings, not numbers with implicit 'px' units. |
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 ## Versioning
@@ -149,10 +147,8 @@ stable across patch (`0.0.x`) versions, but may change across minor (`0.x`) vers
 If you want to pin a minor version, use a tilde in your `package.json`.
 
 <!-- AUTO-GENERATED-CONTENT:START (TILDE) -->
-
 ```diff
 - "eslint-plugin-solid": "^0.7.4"
 + "eslint-plugin-solid": "~0.7.4"
 ```
-
 <!-- AUTO-GENERATED-CONTENT:END -->
diff --git a/docs/imports.md b/docs/imports.md
@@ -16,7 +16,7 @@ This rule is **a warning** by default.
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 import { createEffect } from "solid-js/web";
diff --git a/docs/no-destructure.md b/docs/no-destructure.md
@@ -16,7 +16,7 @@ This rule is **an error** by default.
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 let Component = ({}) => <div />;
diff --git a/docs/no-react-specific-props.md b/docs/no-react-specific-props.md
@@ -16,7 +16,7 @@ This rule is **a warning** by default.
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 let el = <div className="greeting">Hello world!</div>;
diff --git a/docs/prefer-classlist.md b/docs/prefer-classlist.md
@@ -28,7 +28,7 @@ Options shown here are the defaults. Manually configuring an array will *replace
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 let el = <div class={cn({ red: true })}>Hello, world!</div>;
diff --git a/docs/prefer-show.md b/docs/prefer-show.md
@@ -16,7 +16,7 @@ This rule is **off** by default.
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 function Component(props) {
diff --git a/docs/self-closing-comp.md b/docs/self-closing-comp.md
@@ -30,7 +30,7 @@ Options shown here are the defaults.
 
 ### Invalid Examples
 
-These snippets cause lint errors, and some can be auto-fixed.
+These snippets cause lint errors, and all of them can be auto-fixed.
 
 ```js
 let el = <div></div>;
diff --git a/scripts/docs.ts b/scripts/docs.ts
@@ -3,6 +3,7 @@ import path from "path";
 import fs from "fs-extra";
 import markdownMagic from "markdown-magic";
 import prettier from "prettier";
+import type { TSESLint } from "@typescript-eslint/utils";
 const plugin = require("../src/index");
 
 const { rules, configs } = plugin;
@@ -59,11 +60,14 @@ const buildRulesTable = (rows: Array<string>) => {
 const buildHeader = (filename: string): string => {
   const ruleName = filename.replace(/\.md$/, "");
   if (!rules[ruleName]) return " ";
-  const description = rules[ruleName].meta.docs.description;
+  const meta: TSESLint.RuleMetaData<never> = rules[ruleName].meta;
   return [
     `# solid/${ruleName}`,
-    description,
-    `This rule is **${getLevelForRule(`solid/${ruleName}`, formatLevel)}** by default.\n`,
+    meta.docs?.description,
+    `This rule is ${meta.deprecated ? "**deprecated** and " : ""}**${getLevelForRule(
+      `solid/${ruleName}`,
+      formatLevel
+    )}** by default.\n`,
     `[View source](../src/rules/${ruleName}.ts) · [View tests](../test/rules/${ruleName}.test.ts)\n`,
   ].join("\n");
 };
@@ -94,9 +98,6 @@ const buildOptions = (filename: string): string => {
       return `    // ${properties[prop].description}\n    ${prop}: ${JSON.stringify(_default)}, ${
         type !== "boolean" ? "// " + type : ""
       }`;
-      // return `${prop} | \`${type}\` | ${properties[prop].description ?? ""}${
-      //   _default != null ? ` *Default \`${JSON.stringify(_default)}\`*.` : ""
-      // }`;
     }),
     "  }]",
     "}",
@@ -129,11 +130,14 @@ const buildCases = (content: string, filename: string) => {
   const valid = cases.valid?.map((c: any) => (typeof c === "string" ? { code: c } : c)) ?? [];
   const invalid = cases.invalid ?? [];
 
+  const allFixed = invalid.every((c: any) => c.output);
+  const someFixed = !allFixed && invalid.some((c: any) => c.output);
+
   const markdown = [
     "## Tests\n",
     "### Invalid Examples\n",
-    `These snippets cause lint errors${
-      invalid.some((c: any) => c.output) ? ", and some can be auto-fixed" : ""
+    `These snippets cause lint errors${allFixed ? ", and all of them can be auto-fixed" : ""}${
+      someFixed ? ", and some can be auto-fixed" : ""
     }.\n`,
     "```js",
     invalid.map((c: any) => [
diff --git a/test/fixture.test.ts b/test/fixture.test.ts
@@ -12,29 +12,35 @@ const getTestFiles = (dir: string): Array<string> => {
 };
 
 describe("fixture", function () {
-  it("loads the plugin without crashing", async () => {
-    jest.setTimeout(100 * 1000);
-    const exampleFile = path.join("test", "fixture", "invalid", "jsx-undef.jsx");
-    const { exitCode } = await execa(eslintBinPath, ["--print-config", exampleFile], {
-      shell: true,
-    });
-    expect(exitCode).toBe(0);
-  });
-
-  it("produces reasonable lint errors", async () => {
-    jest.setTimeout(100 * 1000);
-    try {
+  it(
+    "loads the plugin without crashing",
+    async () => {
       const exampleFile = path.join("test", "fixture", "invalid", "jsx-undef.jsx");
-      await execa(eslintBinPath, [exampleFile], {
+      const { exitCode } = await execa(eslintBinPath, ["--print-config", exampleFile], {
         shell: true,
       });
-    } catch (error: any) {
-      expect(error.exitCode).not.toBe(0);
-      expect(error.stderr).toBe("");
-      expect(error.stdout).toMatch(/'Component' is not defined/);
-      expect(error.stdout).toMatch(/solid\/jsx-no-undef/);
-    }
-  });
+      expect(exitCode).toBe(0);
+    },
+    100 * 1000
+  );
+
+  it(
+    "produces reasonable lint errors",
+    async () => {
+      try {
+        const exampleFile = path.join("test", "fixture", "invalid", "jsx-undef.jsx");
+        await execa(eslintBinPath, [exampleFile], {
+          shell: true,
+        });
+      } catch (error: any) {
+        expect(error.exitCode).not.toBe(0);
+        expect(error.stderr).toBe("");
+        expect(error.stdout).toMatch(/'Component' is not defined/);
+        expect(error.stdout).toMatch(/solid\/jsx-no-undef/);
+      }
+    },
+    100 * 1000
+  );
 
   describe("valid examples", () => {
     test.each(getTestFiles("valid").map((file) => [path.relative("test/fixture", file), file]))(
