diff --git a/.changeset/grumpy-files-design.md b/.changeset/grumpy-files-design.md new file mode 100644 index 000000000..0f9c20e0a --- /dev/null +++ b/.changeset/grumpy-files-design.md @@ -0,0 +1,5 @@ +--- +'eslint-plugin-svelte': major +--- + +breaking: remove `require-stores-init` from recommended rules diff --git a/README.md b/README.md index 83a17b9ed..be05aca61 100644 --- a/README.md +++ b/README.md @@ -371,7 +371,7 @@ These rules relate to better ways of doing things to help you avoid problems: | [svelte/require-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-each-key/) | require keyed `{#each}` block | :star: | | [svelte/require-event-dispatcher-types](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-event-dispatcher-types/) | require type parameters for `createEventDispatcher` | :star: | | [svelte/require-optimized-style-attribute](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-optimized-style-attribute/) | require style attributes that can be optimized | | -| [svelte/require-stores-init](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store | :star: | +| [svelte/require-stores-init](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store | | | [svelte/valid-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/valid-each-key/) | enforce keys to use variables defined in the `{#each}` block | :star: | ## Stylistic Issues diff --git a/docs/rules.md b/docs/rules.md index 3d6000e8d..7d2834a7c 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -68,7 +68,7 @@ These rules relate to better ways of doing things to help you avoid problems: | [svelte/require-each-key](./rules/require-each-key.md) | require keyed `{#each}` block | :star: | | [svelte/require-event-dispatcher-types](./rules/require-event-dispatcher-types.md) | require type parameters for `createEventDispatcher` | :star: | | [svelte/require-optimized-style-attribute](./rules/require-optimized-style-attribute.md) | require style attributes that can be optimized | | -| [svelte/require-stores-init](./rules/require-stores-init.md) | require initial value in store | :star: | +| [svelte/require-stores-init](./rules/require-stores-init.md) | require initial value in store | | | [svelte/valid-each-key](./rules/valid-each-key.md) | enforce keys to use variables defined in the `{#each}` block | :star: | ## Stylistic Issues diff --git a/docs/rules/require-stores-init.md b/docs/rules/require-stores-init.md index 177dd3c0b..13dcc9985 100644 --- a/docs/rules/require-stores-init.md +++ b/docs/rules/require-stores-init.md @@ -10,8 +10,6 @@ since: 'v2.5.0' > require initial value in store -- :gear: This rule is included in `"plugin:svelte/recommended"`. - ## :book: Rule Details This rule is aimed to enforce initial values when initializing the Svelte stores. diff --git a/packages/eslint-plugin-svelte/src/configs/flat/recommended.ts b/packages/eslint-plugin-svelte/src/configs/flat/recommended.ts index fc7f0890f..9a9792eba 100644 --- a/packages/eslint-plugin-svelte/src/configs/flat/recommended.ts +++ b/packages/eslint-plugin-svelte/src/configs/flat/recommended.ts @@ -38,7 +38,6 @@ const config: Linter.Config[] = [ 'svelte/require-each-key': 'error', 'svelte/require-event-dispatcher-types': 'error', 'svelte/require-store-reactive-access': 'error', - 'svelte/require-stores-init': 'error', 'svelte/system': 'error', 'svelte/valid-each-key': 'error', 'svelte/valid-prop-names-in-kit-pages': 'error' diff --git a/packages/eslint-plugin-svelte/src/rules/require-stores-init.ts b/packages/eslint-plugin-svelte/src/rules/require-stores-init.ts index 820267ed2..7683c1e70 100644 --- a/packages/eslint-plugin-svelte/src/rules/require-stores-init.ts +++ b/packages/eslint-plugin-svelte/src/rules/require-stores-init.ts @@ -6,7 +6,9 @@ export default createRule('require-stores-init', { docs: { description: 'require initial value in store', category: 'Best Practices', - recommended: true + // Please refer to the following before setting recommended to true. + // https://github.com/sveltejs/eslint-plugin-svelte/issues/1073 + recommended: false }, schema: [], messages: {