Skip to content

breaking: remove require-stores-init from recommended rules #1086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 25, 2025
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
5 changes: 5 additions & 0 deletions .changeset/grumpy-files-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'eslint-plugin-svelte': major
---

breaking: remove `require-stores-init` from recommended rules
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/rules/require-stores-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down