Merge pull request #149 from JoshuaKGoldberg/typescript-eslint-8

fix: allow typescript-eslint@8 as dependency

Author: joshwilsonvu

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 8
+          version: 9
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}

README.md

@@ -1,225 +0,0 @@
-<p>
-  <img width="100%" src="https://assets.solidjs.com/banner?type=ESLint%20Plugin&background=tiles&project=%20" alt="Solid ESLint Extension">
-</p>
-
-# Solid ESLint Plugin
-
-[![npm version](https://img.shields.io/npm/v/eslint-plugin-solid?style=for-the-badge)](https://npmjs.com/package/eslint-plugin-solid)
-[![GitHub package version](https://img.shields.io/github/package-json/v/solidjs-community/eslint-plugin-solid?style=for-the-badge)](https://github.com/solidjs-community/eslint-plugin-solid)
-![ESLint peer dependency](https://img.shields.io/badge/eslint-6.x--8.x-blue?style=for-the-badge)
-[![CI](https://github.com/solidjs-community/eslint-plugin-solid/actions/workflows/ci.yml/badge.svg?style=for-the-badge)](https://github.com/solidjs-community/eslint-plugin-solid/actions/workflows/ci.yml)
-
-This package contains [Solid](https://www.solidjs.com/)-specific linting rules for ESLint. It can
-ease Solid's learning curve by finding and fixing problems around Solid's reactivity system, and can
-migrate some React patterns to Solid code.
-
-It's approaching a `1.0.0` release, and it's well tested and should be helpful in Solid projects
-today.
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC) -->
-- [Installation](#installation)
-- [Configuration](#configuration)
-  - [TypeScript](#typescript)
-  - [Manual Configuration](#manual-configuration)
-  - [Flat Configuration](#flat-configuration)
-- [Rules](#rules)
-- [Troubleshooting](#troubleshooting)
-- [Versioning](#versioning)
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-## Installation
-
-Install `eslint` and `eslint-plugin-solid` locally.
-
-```sh
-npm install --save-dev eslint eslint-plugin-solid
-# or
-pnpm add --save-dev eslint eslint-plugin-solid
-yarn add --dev eslint eslint-plugin-solid
-
-# optional, to create an ESLint config file
-npx eslint --init
-# or
-pnpm eslint --init
-yarn eslint --init
-```
-
-If you're using VSCode, you'll want to install the [ESLint
-extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint). You're
-encouraged to enable auto-fixing problems on save by adding the following to your `settings.json`
-file.
-
-```json
-{
-  "editor.codeActionsOnSave": {
-    "source.fixAll": true
-  }
-}
-```
-
-If you're using Vite, you may want to install
-[vite-plugin-eslint](https://github.com/gxmari007/vite-plugin-eslint).
-
-You may also want to check out
-[eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y), which provides
-useful rules for writing accessible HTML.
-
-## Configuration
-
-Use the `"plugin:solid/recommended"` configuration to get reasonable defaults as shown [below](#rules).
-
-```json
-{
-  "plugins": ["solid"],
-  "extends": ["eslint:recommended", "plugin:solid/recommended"]
-}
-```
-
-### TypeScript
-
-If you're using TypeScript, use the `"plugin:solid/typescript"` configuration instead.
-This disables some features that overlap with type checking.
-
-```json
-{
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["solid"],
-  "extends": ["eslint:recommended", "plugin:solid/typescript"]
-}
-```
-
-### Manual Configuration
-
-If you don't want to use a preset, you can configure rules individually. Add the `"solid"` plugin,
-enable JSX with the parser options (or use the equivalent options for `@typescript-eslint/parser` or
-`@babel/eslint-parser`), and configure the rules you would like to use. Some rules have additional
-options you can set.
-
-```json
-{
-  "plugins": ["solid"],
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": true
-    }
-  },
-  "rules": {
-    "solid/reactivity": "warn",
-    "solid/no-destructure": "warn",
-    "solid/jsx-no-undef": "error"
-  }
-}
-```
-
-### Flat Configuration
-
-ESLint's new configuration system, [Flat
-Configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new#using-configurations-included-in-plugins),
-is available starting in ESLint [v8.23.0](https://github.com/eslint/eslint/releases/tag/v8.23.0). To
-use it, create an `eslint.config.js` file at the root of your project, instead of `.eslintrc.*`
-and/or `.eslintignore`.
-
-```js
-import js from "@eslint/js";
-import solid from "eslint-plugin-solid/configs/recommended";
-
-export default [
-  js.configs.recommended, // replaces eslint:recommended
-  solid,
-];
-```
-
-For TypeScript:
-
-```js
-import js from "@eslint/js";
-import solid from "eslint-plugin-solid/configs/typescript";
-import * as tsParser from "@typescript-eslint/parser";
-
-export default [
-  js.configs.recommended,
-  {
-    files: ["**/*.{ts,tsx}"],
-    ...solid,
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        project: "tsconfig.json",
-      },
-    },
-  },
-];
-```
-
-These configurations do not configure global variables in ESLint. You can do this yourself manually
-or with a package like [globals](https://www.npmjs.com/package/globals) by creating a configuration
-with a `languageOptions.globals` object. We recommend setting up global variables for Browser APIs
-as well as at least ES2015.
-
-Note for the ESLint VSCode Extension: Enable the "Use Flat Config" setting for your workspace to
-enable Flat Config support.
-
-Flat configs are also available as `plugin.configs['flat/recommended']` and `plugin.configs['flat/typescript']`, after using `import plugin from 'eslint-plugin-solid'`.
-
-## Rules
-
-✔: Enabled in the `recommended` configuration.
-
-🔧: 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-array-handlers](docs/no-array-handlers.md) | Disallow usage of type-unsafe event handlers. |
-| ✔ | 🔧 | [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-proxy-apis](docs/no-proxy-apis.md) | Disallow usage of APIs that use ES6 Proxies, only to target environments that don't support them. |
-| ✔ | 🔧 | [solid/no-react-deps](docs/no-react-deps.md) | Disallow usage of dependency arrays in `createEffect` and `createMemo`. |
-| ✔ | 🔧 | [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 reactivity (props, signals, memos, etc.) is properly used, so changes in those values will be tracked and 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 -->
-
-## Troubleshooting
-
-The rules in this plugin provide sensible guidelines as well as possible, but there may be times
-where you know better than the rule and want to ignore a warning. To do that, [add a
-comment](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-rules) like the
-following:
-
-```jsx
-// eslint-disable-next-line solid/reactivity
-const [editedValue, setEditedValue] = createSignal(props.value);
-```
-
-_Please note_: there may also be times where a rule correctly warns about a subtle problem,
-even if it looks like a false positive at first. With `solid/reactivity`, please look at the
-[reactivity docs](./docs/reactivity.md#troubleshooting) before deciding to disable the rule.
-
-When in doubt, feel free to [file an
-issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/new/choose).
-
-## Versioning
-
-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`.
-
-<!-- AUTO-GENERATED-CONTENT:START (TILDE) -->
-```diff
-- "eslint-plugin-solid": "^0.14.1"
-+ "eslint-plugin-solid": "~0.14.1"
-```
-<!-- AUTO-GENERATED-CONTENT:END -->

docs/components-return-once.md

@@ -1,19 +1,18 @@
-<!-- AUTO-GENERATED-CONTENT:START (HEADER) -->
+<!-- doc-gen HEADER -->
 # solid/components-return-once
 Disallow early returns in components. Solid components only run once, and so conditionals should be inside JSX.
 This rule is **a warning** by default.
 
 [View source](../src/rules/components-return-once.ts) · [View tests](../test/rules/components-return-once.test.ts)
-
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- end-doc-gen -->
 
 See [this issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/24) for rationale.
 
-<!-- AUTO-GENERATED-CONTENT:START (OPTIONS) -->
- 
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- doc-gen OPTIONS -->
+
+<!-- end-doc-gen -->
 
-<!-- AUTO-GENERATED-CONTENT:START (CASES) -->
+<!-- doc-gen CASES -->
 ## Tests
 
 ### Invalid Examples
@@ -27,36 +26,32 @@ function Component() {
   }
   return <span />;
 }
- 
+
 const Component = () => {
   if (condition) {
     return <div />;
   }
   return <span />;
 };
- 
+
 function Component() {
   return Math.random() > 0.5 ? <div>Big!</div> : <div>Small!</div>;
 }
 // after eslint --fix:
 function Component() {
   return <>{Math.random() > 0.5 ? <div>Big!</div> : <div>Small!</div>}</>;
 }
- 
+
 function Component() {
   return Math.random() > 0.5 ? <div>Big!</div> : "Small!";
 }
 // after eslint --fix:
 function Component() {
   return <>{Math.random() > 0.5 ? <div>Big!</div> : "Small!"}</>;
 }
- 
+
 function Component() {
-  return Math.random() > 0.5 ? (
-    <div>Big! No, really big!</div>
-  ) : (
-    <div>Small!</div>
-  );
+  return Math.random() > 0.5 ? <div>Big! No, really big!</div> : <div>Small!</div>;
 }
 // after eslint --fix:
 function Component() {
@@ -66,7 +61,7 @@ function Component() {
     </Show>
   );
 }
- 
+
 function Component(props) {
   return props.cond1 ? (
     <div>Condition 1</div>
@@ -89,7 +84,7 @@ function Component(props) {
     </Switch>
   );
 }
- 
+
 function Component(props) {
   return !!props.cond && <div>Conditional</div>;
 }
@@ -101,18 +96,17 @@ function Component(props) {
     </Show>
   );
 }
- 
+
 function Component(props) {
   return props.primary || <div>{props.secondaryText}</div>;
 }
- 
+
 HOC(() => {
   if (condition) {
     return <div />;
   }
   return <div />;
 });
- 
 ```
 
 ### Valid Examples
@@ -172,6 +166,5 @@ function Component() {
   };
   return <></>;
 }
-
 ```
-<!-- AUTO-GENERATED-CONTENT:END -->
+<!-- end-doc-gen -->