# eslint-plugin-solid

> Solid-specific linting rules for ESLint.

Latest version **0.18.1** (published 2026-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-solid
pnpm add eslint-plugin-solid
yarn add eslint-plugin-solid
bun add eslint-plugin-solid
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.18.1 |
| Published | 2026-10-04 |
| First published | 2021-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22.0.0 |
| Dependencies | 6 |
| Unpacked size | 4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 266 |
| Author | Josh Wilson <joshwilsonvu@gmail.com> |
| Maintainers | ryansolid, joshwilsonvu |
| Keywords | eslint, eslintplugin, solid, solidjs, reactivity |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-solid
- Repository: https://github.com/solidjs-community/eslint-plugin-solid
- npm.io page: https://npm.io/package/eslint-plugin-solid

## Dependencies (6)

- [is-html](https://npm.io/package/is-html.md) ^2.0.0
- [estraverse](https://npm.io/package/estraverse.md) ^5.3.0
- [kebab-case](https://npm.io/package/kebab-case.md) ^1.0.2
- [style-to-object](https://npm.io/package/style-to-object.md) ^1.0.6
- [known-css-properties](https://npm.io/package/known-css-properties.md) ^0.30.0
- [@typescript-eslint/utils](https://npm.io/package/@typescript-eslint/utils.md) ^8.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.18.1 (latest) — 2026-10-04
- 0.18.0 — 2026-09-08
- 0.17.1 — 2026-09-08
- 0.17.0 — 2026-08-29
- 0.16.1 — 2026-08-27
- 0.16.0 — 2026-08-20
- 0.15.0 — 2026-08-13
- 0.14.5 — 2024-12-11
- 0.14.4 — 2024-11-12
- 0.14.3 — 2024-09-01
- 0.14.2 — 2024-08-17
- 0.14.1 — 2024-06-19
- 0.14.0 — 2024-04-27
- 0.13.2 — 2024-03-20
- 0.13.1 — 2023-12-30
- … 33 more at https://npm.io/package/eslint-plugin-solid/versions

## README

<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/main?filename=packages%2Feslint-plugin-solid%2Fpackage.json&style=for-the-badge)](https://github.com/solidjs-community/eslint-plugin-solid)
![ESLint peer dependency](https://img.shields.io/badge/eslint-9.x--10.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 supports both Solid 1.x and Solid 2.0 APIs, requires ESLint v9 or v10 and Node.js 22+, and also
runs under [Oxlint](#oxlint) as a JS plugin.

<!-- doc-gen TOC -->
- [Solid ESLint Plugin](#solid-eslint-plugin)
  - [Installation](#installation)
  - [Configuration](#configuration)
    - [TypeScript](#typescript)
    - [Solid 2.0](#solid-20)
    - [Manual Configuration](#manual-configuration)
    - [Oxlint](#oxlint)
  - [Rules](#rules)
  - [Troubleshooting](#troubleshooting)
  - [Versioning](#versioning)
<!-- end-doc-gen -->

## 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

Create an `eslint.config.js` file at the root of your project ([flat
config](https://eslint.org/docs/latest/use/configure/configuration-files) is the only configuration
system supported by ESLint v9+, and by this plugin as of v0.15.0), and use the `recommended`
configuration to get reasonable defaults as shown [below](#rules).

```js
import js from "@eslint/js";
import solid from "eslint-plugin-solid/configs/recommended";

export default [
  js.configs.recommended, // replaces eslint:recommended
  solid,
];
```

### TypeScript

If you're using TypeScript, use the `typescript` configuration instead.
This disables some features that overlap with type checking.

```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",
      },
    },
  },
];
```

### Solid 2.0

If your project targets Solid 2.0, use the `v2` configuration. It sets
`settings: { solid: { version: 2 } }`, which switches the version-aware rules (`reactivity`,
`imports`, `no-unknown-namespaces`, `event-handlers`, `jsx-no-undef`) to strict 2.0 semantics, and
enables the 2.0-specific rules: `removed-api`, `no-single-arg-create-effect`,
`no-accessor-as-prop`, `no-boolean-enumerated-attribute`, `no-store-mutation-outside-setter`,
`no-write-in-pure-computation`, and the server function rules (`valid-use-server`,
`require-async-server-function`, `no-invalid-server-capture`,
`no-browser-globals-in-server-function`) as errors, with `prefer-structured-class` and
`no-unused-signal` as warnings. This is the config the official Solid 2.0 templates ship
with.

```js
import js from "@eslint/js";
import solid from "eslint-plugin-solid/configs/v2";

export default [js.configs.recommended, solid];
```

There is also a `v2-strict` configuration with the plugin's strongest opinions: everything in `v2`
plus `no-module-scope-reactive-primitive` and `no-restated-default-options` as errors,
`prefer-onSettled-for-side-effects` as a warning, and `prefer-structured-class` and
`no-unused-signal` promoted to errors.

The `settings.solid.version` setting also works in any custom config; version-aware rules read it
directly, so you can opt individual rule configurations into 2.0 semantics without using the
presets.

If your project imports Solid's primitives from a custom renderer or a re-exporting wrapper module
instead of `solid-js`, add those module names to `settings.solid.moduleSources` (exact names,
matched whole) so the import-gated rules recognize them:

```js
{
  settings: { solid: { moduleSources: ["my-custom-renderer"] } },
}
```

All configs are also available on the plugin's root export, as `solid.configs.recommended`,
`solid.configs.typescript`, `solid.configs.v2`, and `solid.configs["v2-strict"]`, after using
`import solid from 'eslint-plugin-solid'`. (The `configs["flat/recommended"]` and
`configs["flat/typescript"]` names from v0.14.x still work as aliases.)

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.

### 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.

```js
import solid from "eslint-plugin-solid";

export default [
  {
    plugins: { solid },
    languageOptions: {
      parserOptions: {
        ecmaFeatures: { jsx: true },
      },
    },
    rules: {
      "solid/reactivity": "warn",
      "solid/no-destructure": "warn",
      "solid/jsx-no-undef": "error",
    },
  },
];
```

### Oxlint

The plugin's rules are AST-based, so they run under [Oxlint's JS
plugin support](https://oxc.rs/docs/guide/usage/linter/js-plugins.html) without modification. Add
the plugin to `jsPlugins` in your `.oxlintrc.json` and enable the rules you want:

```json
{
  "jsPlugins": ["eslint-plugin-solid"],
  "rules": {
    "solid/reactivity": "warn",
    "solid/no-destructure": "error",
    "solid/jsx-no-undef": "error"
  }
}
```

For Solid 2.0 projects, add `"settings": { "solid": { "version": 2 } }` to activate the
version-aware rule behavior, and enable the 2.0 rules (`solid/removed-api`,
`solid/no-single-arg-create-effect`, `solid/no-accessor-as-prop`,
`solid/no-store-mutation-outside-setter`, `solid/no-write-in-pure-computation`,
`solid/no-unused-signal`, `solid/prefer-structured-class`, and the server function rules `solid/valid-use-server`,
`solid/require-async-server-function`, `solid/no-invalid-server-capture`, and
`solid/no-browser-globals-in-server-function`).

## Rules

✔: Enabled in the `recommended` configuration.

🔧: Fixable with [`eslint --fix`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems)/IDE auto-fix.

<!-- doc-gen RULES -->
| ✔ | 🔧 | Rule | Description |
| :---: | :---: | :--- | :--- |
| ✔ | 🔧 | [solid/components-return-once](/packages/eslint-plugin-solid/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](/packages/eslint-plugin-solid/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](/packages/eslint-plugin-solid/docs/imports.md) | Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store". |
| ✔ |  | [solid/jsx-no-duplicate-props](/packages/eslint-plugin-solid/docs/jsx-no-duplicate-props.md) | Disallow passing the same prop twice in JSX. |
| ✔ |  | [solid/jsx-no-script-url](/packages/eslint-plugin-solid/docs/jsx-no-script-url.md) | Disallow javascript: URLs. |
| ✔ | 🔧 | [solid/jsx-no-undef](/packages/eslint-plugin-solid/docs/jsx-no-undef.md) | Disallow references to undefined variables in JSX. Handles custom directives. |
| ✔ |  | [solid/jsx-uses-vars](/packages/eslint-plugin-solid/docs/jsx-uses-vars.md) | Prevent variables used in JSX from being marked as unused. |
|  |  | [solid/no-accessor-as-prop](/packages/eslint-plugin-solid/docs/no-accessor-as-prop.md) | Disallow passing uncalled signal accessors or other functions as value-typed DOM element attributes. |
|  |  | [solid/no-array-handlers](/packages/eslint-plugin-solid/docs/no-array-handlers.md) | Disallow usage of type-unsafe event handlers. |
|  | 🔧 | [solid/no-boolean-enumerated-attribute](/packages/eslint-plugin-solid/docs/no-boolean-enumerated-attribute.md) | Disallow boolean values on enumerated attributes like draggable and tristate aria-*, which take string tokens — a boolean false removes the attribute instead of writing "false". |
|  |  | [solid/no-browser-globals-in-server-function](/packages/eslint-plugin-solid/docs/no-browser-globals-in-server-function.md) | Disallow browser-only globals inside server functions, which run exclusively on the server. |
| ✔ | 🔧 | [solid/no-destructure](/packages/eslint-plugin-solid/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](/packages/eslint-plugin-solid/docs/no-innerhtml.md) | Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities. |
|  |  | [solid/no-invalid-server-capture](/packages/eslint-plugin-solid/docs/no-invalid-server-capture.md) | Disallow server functions from capturing variables in enclosing non-module scopes, mirroring the compiler's build-time validation. |
|  |  | [solid/no-module-scope-reactive-primitive](/packages/eslint-plugin-solid/docs/no-module-scope-reactive-primitive.md) | Disallow reactive primitives at module scope, where state is shared across SSR requests. |
|  |  | [solid/no-proxy-apis](/packages/eslint-plugin-solid/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](/packages/eslint-plugin-solid/docs/no-react-deps.md) | Disallow usage of dependency arrays in `createEffect` and `createMemo`. |
| ✔ | 🔧 | [solid/no-react-specific-props](/packages/eslint-plugin-solid/docs/no-react-specific-props.md) | Disallow usage of React-specific `className`/`htmlFor` props, which were deprecated in v1.4.0. |
|  | 🔧 | [solid/no-restated-default-options](/packages/eslint-plugin-solid/docs/no-restated-default-options.md) | Disallow restating a prop or option value that is already the default. |
|  |  | [solid/no-single-arg-create-effect](/packages/eslint-plugin-solid/docs/no-single-arg-create-effect.md) | Require the two-argument `createEffect(compute, effect)` form used by Solid 2.0. |
|  |  | [solid/no-store-mutation-outside-setter](/packages/eslint-plugin-solid/docs/no-store-mutation-outside-setter.md) | Disallow mutating a store's read proxy; store state changes only through the setter's mutable draft. |
| ✔ |  | [solid/no-unknown-namespaces](/packages/eslint-plugin-solid/docs/no-unknown-namespaces.md) | Enforce using only Solid-specific namespaced attribute names (i.e. `'on:'` in `<div on:click={...} />`). |
|  |  | [solid/no-unused-signal](/packages/eslint-plugin-solid/docs/no-unused-signal.md) | Disallow signals that are never written (use a plain value) or never read (dead state). |
|  |  | [solid/no-write-in-pure-computation](/packages/eslint-plugin-solid/docs/no-write-in-pure-computation.md) | Disallow writing signals or stores inside `createMemo`, the compute half of `createEffect`, or a component body, which are pure owned scopes. |
|  | 🔧 | [solid/prefer-classlist](/packages/eslint-plugin-solid/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](/packages/eslint-plugin-solid/docs/prefer-for.md) | Enforce using Solid's `<For />` component for mapping an array to JSX elements. |
|  |  | [solid/prefer-onSettled-for-side-effects](/packages/eslint-plugin-solid/docs/prefer-onSettled-for-side-effects.md) | Enforce running side-effectful setup (timers, global listeners, observers) inside `onSettled` instead of the component body. |
|  | 🔧 | [solid/prefer-show](/packages/eslint-plugin-solid/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/prefer-structured-class](/packages/eslint-plugin-solid/docs/prefer-structured-class.md) | Enforce using the structured array/object forms of the `class` prop over manually-built class strings. |
| ✔ |  | [solid/reactivity](/packages/eslint-plugin-solid/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/removed-api](/packages/eslint-plugin-solid/docs/removed-api.md) | Disallow Solid 1.x APIs that were removed or renamed in Solid 2.0, with migration guidance. |
|  | 🔧 | [solid/require-async-server-function](/packages/eslint-plugin-solid/docs/require-async-server-function.md) | Require server functions to be async, matching their client-side contract. |
| ✔ | 🔧 | [solid/self-closing-comp](/packages/eslint-plugin-solid/docs/self-closing-comp.md) | Disallow extra closing tags for components without children. |
| ✔ | 🔧 | [solid/style-prop](/packages/eslint-plugin-solid/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. |
|  |  | [solid/valid-use-server](/packages/eslint-plugin-solid/docs/valid-use-server.md) | Enforce that "use server" directives are placed where the compiler honors them, and that module-level directive files export working server functions. |
<!-- end-doc-gen -->

## 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](https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/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`, `typescript`, `v2`, and `v2-strict` configurations
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`.

<!-- doc-gen TILDE -->
```diff
- "eslint-plugin-solid": "^0.18.1"
+ "eslint-plugin-solid": "~0.18.1"
```
<!-- end-doc-gen -->

---
_Source: https://npm.io/package/eslint-plugin-solid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._