Skip to content

Commit 1c679b5

Browse files
authored
breaking: remove require-stores-init from recommended rules (#1086)
1 parent a0588ef commit 1c679b5

File tree

6 files changed

+10
-6
lines changed

6 files changed

+10
-6
lines changed

.changeset/grumpy-files-design.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'eslint-plugin-svelte': major
3+
---
4+
5+
breaking: remove `require-stores-init` from recommended rules

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ These rules relate to better ways of doing things to help you avoid problems:
371371
| [svelte/require-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-each-key/) | require keyed `{#each}` block | :star: |
372372
| [svelte/require-event-dispatcher-types](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-event-dispatcher-types/) | require type parameters for `createEventDispatcher` | :star: |
373373
| [svelte/require-optimized-style-attribute](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-optimized-style-attribute/) | require style attributes that can be optimized | |
374-
| [svelte/require-stores-init](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store | :star: |
374+
| [svelte/require-stores-init](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store | |
375375
| [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: |
376376

377377
## Stylistic Issues

docs/rules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ These rules relate to better ways of doing things to help you avoid problems:
6868
| [svelte/require-each-key](./rules/require-each-key.md) | require keyed `{#each}` block | :star: |
6969
| [svelte/require-event-dispatcher-types](./rules/require-event-dispatcher-types.md) | require type parameters for `createEventDispatcher` | :star: |
7070
| [svelte/require-optimized-style-attribute](./rules/require-optimized-style-attribute.md) | require style attributes that can be optimized | |
71-
| [svelte/require-stores-init](./rules/require-stores-init.md) | require initial value in store | :star: |
71+
| [svelte/require-stores-init](./rules/require-stores-init.md) | require initial value in store | |
7272
| [svelte/valid-each-key](./rules/valid-each-key.md) | enforce keys to use variables defined in the `{#each}` block | :star: |
7373

7474
## Stylistic Issues

docs/rules/require-stores-init.md

-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ since: 'v2.5.0'
1010

1111
> require initial value in store
1212
13-
- :gear: This rule is included in `"plugin:svelte/recommended"`.
14-
1513
## :book: Rule Details
1614

1715
This rule is aimed to enforce initial values when initializing the Svelte stores.

packages/eslint-plugin-svelte/src/configs/flat/recommended.ts

-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ const config: Linter.Config[] = [
3838
'svelte/require-each-key': 'error',
3939
'svelte/require-event-dispatcher-types': 'error',
4040
'svelte/require-store-reactive-access': 'error',
41-
'svelte/require-stores-init': 'error',
4241
'svelte/system': 'error',
4342
'svelte/valid-each-key': 'error',
4443
'svelte/valid-prop-names-in-kit-pages': 'error'

packages/eslint-plugin-svelte/src/rules/require-stores-init.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ export default createRule('require-stores-init', {
66
docs: {
77
description: 'require initial value in store',
88
category: 'Best Practices',
9-
recommended: true
9+
// Please refer to the following before setting recommended to true.
10+
// https://github.com/sveltejs/eslint-plugin-svelte/issues/1073
11+
recommended: false
1012
},
1113
schema: [],
1214
messages: {

0 commit comments

Comments
 (0)