Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p>
<img width="100%" src="https://assets.solidjs.com/banner?type=ESLint%20Plugin&background=tiles&project=%20&version=2.0" alt="Solid ESLint Extension">
<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)
[![GitHub package version](https://img.shields.io/github/package-json/v/solidjs/eslint-plugin-solid/main?filename=packages%2Feslint-plugin-solid%2Fpackage.json&style=for-the-badge)](https://github.com/solidjs/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)
[![CI](https://github.com/solidjs/eslint-plugin-solid/actions/workflows/ci.yml/badge.svg?style=for-the-badge)](https://github.com/solidjs/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
Expand Down Expand Up @@ -273,10 +273,10 @@ 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.
[reactivity docs](https://github.com/solidjs/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).
issue](https://github.com/solidjs/eslint-plugin-solid/issues/new/choose).

## Versioning

Expand Down
2 changes: 1 addition & 1 deletion eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default tseslint.config(
"error",
{
pattern:
"https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/{{name}}.md",
"https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/{{name}}.md",
},
],
},
Expand Down
8 changes: 4 additions & 4 deletions packages/eslint-plugin-solid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
# 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)
[![GitHub package version](https://img.shields.io/github/package-json/v/solidjs/eslint-plugin-solid/main?filename=packages%2Feslint-plugin-solid%2Fpackage.json&style=for-the-badge)](https://github.com/solidjs/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)
[![CI](https://github.com/solidjs/eslint-plugin-solid/actions/workflows/ci.yml/badge.svg?style=for-the-badge)](https://github.com/solidjs/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
Expand Down Expand Up @@ -273,10 +273,10 @@ 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.
[reactivity docs](https://github.com/solidjs/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).
issue](https://github.com/solidjs/eslint-plugin-solid/issues/new/choose).

## Versioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ bodies or initializers are still checked. Handling implicit suspension requires
contract and analysis.

See the [Solid action contract](https://github.com/solidjs/solid/blob/next/packages/signals/src/core/action.ts)
and [issue #229](https://github.com/solidjs-community/eslint-plugin-solid/issues/229).
and [issue #229](https://github.com/solidjs/eslint-plugin-solid/issues/229).

<!-- doc-gen OPTIONS -->
<!-- end-doc-gen -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This rule is **a warning** by default.
[View source](../src/rules/components-return-once.ts) · [View tests](../test/rules/components-return-once.test.ts)
<!-- end-doc-gen -->

See [this issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/24) for rationale.
See [this issue](https://github.com/solidjs/eslint-plugin-solid/issues/24) for rationale.

<!-- doc-gen OPTIONS -->

Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/docs/event-handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This rule is **a warning** by default.
[View source](../src/rules/event-handlers.ts) · [View tests](../test/rules/event-handlers.test.ts)
<!-- end-doc-gen -->

See [this issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/23) for rationale.
See [this issue](https://github.com/solidjs/eslint-plugin-solid/issues/23) for rationale.

<!-- doc-gen OPTIONS -->
## Rule Options
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/docs/jsx-no-script-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This rule is **an error** by default.
[View source](../src/rules/jsx-no-script-url.ts) · [View tests](../test/rules/jsx-no-script-url.test.ts)
<!-- end-doc-gen -->

See [this issue](https://github.com/solidjs-community/eslint-plugin-solid/issues/24) for rationale.
See [this issue](https://github.com/solidjs/eslint-plugin-solid/issues/24) for rationale.

<!-- doc-gen OPTIONS -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Boolean literals are autofixed to the matching token. Provably-boolean expressio

This rule applies to Solid 1.x as well as 2.0 — the attribute behavior is the same — but is only enabled by default (as an error) in the `v2` and `v2-strict` configs.

Credit to [#145](https://github.com/solidjs-community/eslint-plugin-solid/pull/145) by @SarguelUnda, which proposed this rule for `draggable`.
Credit to [#145](https://github.com/solidjs/eslint-plugin-solid/pull/145) by @SarguelUnda, which proposed this rule for `draggable`.

<!-- doc-gen OPTIONS -->
<!-- end-doc-gen -->
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"solidjs",
"reactivity"
],
"repository": "https://github.com/solidjs-community/eslint-plugin-solid",
"repository": "https://github.com/solidjs/eslint-plugin-solid",
"license": "MIT",
"author": "Josh Wilson <joshwilsonvu@gmail.com>",
"exports": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export default createRule({
type: "problem",
docs: {
description: "Require a bare yield after await in Solid action generators.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/action-yield-after-await.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/action-yield-after-await.md",
},
fixable: "code",
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default createRule({
docs: {
description:
"Disallow early returns in components. Solid components only run once, and so conditionals should be inside JSX.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/components-return-once.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/components-return-once.md",
},
fixable: "code",
schema: [],
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/event-handlers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Enforce naming DOM element event handlers consistently and prevent Solid's analysis from misunderstanding whether a prop should be an event handler.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/event-handlers.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/event-handlers.md",
},
fixable: "code",
hasSuggestions: true,
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/imports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ export default createRule({
docs: {
description:
'Enforce consistent imports from "solid-js", "solid-js/web", and "solid-js/store".',
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/imports.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/imports.md",
},
fixable: "code",
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default createRule<Options, MessageIds>({
type: "problem",
docs: {
description: "Disallow passing the same prop twice in JSX.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-duplicate-props.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-duplicate-props.md",
},
schema: [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export default createRule({
type: "problem",
docs: {
description: "Disallow javascript: URLs.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-script-url.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-script-url.md",
},
schema: [],
messages: {
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/jsx-no-undef.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export default createRule<Options, MessageIds>({
type: "problem",
docs: {
description: "Disallow references to undefined variables in JSX. Handles custom directives.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-undef.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-no-undef.md",
},
fixable: "code",
schema: [
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/jsx-uses-vars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export default createRule({
docs: {
// eslint-disable-next-line eslint-plugin/require-meta-docs-description
description: "Prevent variables used in JSX from being marked as unused.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-uses-vars.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/jsx-uses-vars.md",
},
schema: [],
messages: {},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow passing uncalled signal accessors or other functions as value-typed DOM element attributes.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-accessor-as-prop.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-accessor-as-prop.md",
},
hasSuggestions: true,
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default createRule({
type: "problem",
docs: {
description: "Disallow usage of type-unsafe event handlers.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-array-handlers.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-array-handlers.md",
},
schema: [],
messages: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
'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".',
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-boolean-enumerated-attribute.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-boolean-enumerated-attribute.md",
},
fixable: "code",
hasSuggestions: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow browser-only globals inside server functions, which run exclusively on the server.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-browser-globals-in-server-function.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-browser-globals-in-server-function.md",
},
schema: [],
messages: {
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/no-destructure.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export default createRule({
docs: {
description:
"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.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-destructure.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-destructure.md",
},
fixable: "code",
schema: [],
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/no-innerhtml.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow usage of the innerHTML attribute, which can often lead to security vulnerabilities.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-innerhtml.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-innerhtml.md",
},
fixable: "code",
hasSuggestions: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow server functions from capturing variables in enclosing non-module scopes, mirroring the compiler's build-time validation.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-invalid-server-capture.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-invalid-server-capture.md",
},
schema: [],
messages: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow reactive primitives at module scope, where state is shared across SSR requests.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-module-scope-reactive-primitive.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-module-scope-reactive-primitive.md",
},
schema: [],
messages: {
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/no-proxy-apis.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default createRule({
docs: {
description:
"Disallow usage of APIs that use ES6 Proxies, only to target environments that don't support them.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-proxy-apis.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-proxy-apis.md",
},
schema: [],
messages: {
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin-solid/src/rules/no-react-deps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default createRule({
type: "problem",
docs: {
description: "Disallow usage of dependency arrays in `createEffect` and `createMemo`.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-deps.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-deps.md",
},
fixable: "code",
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default createRule({
docs: {
description:
"Disallow usage of React-specific `className`/`htmlFor` props, which were deprecated in v1.4.0.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-specific-props.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-react-specific-props.md",
},
fixable: "code",
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default createRule<Options, MessageIds>({
type: "suggestion",
docs: {
description: "Disallow restating a prop or option value that is already the default.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-restated-default-options.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-restated-default-options.md",
},
fixable: "code",
schema: [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Require the two-argument `createEffect(compute, effect)` form used by Solid 2.0.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-single-arg-create-effect.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-single-arg-create-effect.md",
},
schema: [],
messages: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Disallow mutating a store's read proxy; store state changes only through the setter's mutable draft.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-store-mutation-outside-setter.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-store-mutation-outside-setter.md",
},
schema: [],
messages: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default createRule({
docs: {
description:
"Disallow `let` and `var` variables that are read but never assigned, counting `ref={el}` as an assignment. Replaces ESLint's `no-unassigned-vars`.",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unassigned-vars.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unassigned-vars.md",
},
schema: [],
messages: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default createRule<Options, MessageIds>({
docs: {
description:
"Enforce using only Solid-specific namespaced attribute names (i.e. `'on:'` in `<div on:click={...} />`).",
url: "https://github.com/solidjs-community/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unknown-namespaces.md",
url: "https://github.com/solidjs/eslint-plugin-solid/blob/main/packages/eslint-plugin-solid/docs/no-unknown-namespaces.md",
},
hasSuggestions: true,
schema: [
Expand Down
Loading
Loading