Skip to content

Commit a31f2e6

Browse files
committed
fix: docs and message
1 parent f12bbdf commit a31f2e6

12 files changed

+60
-60
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
308308
| [svelte/no-store-async](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-store-async/) | disallow using async/await inside svelte stores because it causes issues with the auto-unsubscribing features | |
309309
| [svelte/no-unknown-style-directive-property](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-unknown-style-directive-property/) | disallow unknown `style:property` | :star: |
310310
| [svelte/require-store-callbacks-use-set-param](https://ota-meshi.github.io/eslint-plugin-svelte/rules/require-store-callbacks-use-set-param/) | store callbacks must use `set` param | |
311-
| [svelte/require-store-reactive-access](https://ota-meshi.github.io/eslint-plugin-svelte/rules/require-store-reactive-access/) | disallow to render store itself. Need to use $ prefix or get function. | :wrench: |
311+
| [svelte/require-store-reactive-access](https://ota-meshi.github.io/eslint-plugin-svelte/rules/require-store-reactive-access/) | disallow to use of the store itself as an operand. Need to use $ prefix or get function. | :wrench: |
312312
| [svelte/valid-compile](https://ota-meshi.github.io/eslint-plugin-svelte/rules/valid-compile/) | disallow warnings when compiling. | :star: |
313313

314314
## Security Vulnerability

docs/rules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
2626
| [svelte/no-store-async](./rules/no-store-async.md) | disallow using async/await inside svelte stores because it causes issues with the auto-unsubscribing features | |
2727
| [svelte/no-unknown-style-directive-property](./rules/no-unknown-style-directive-property.md) | disallow unknown `style:property` | :star: |
2828
| [svelte/require-store-callbacks-use-set-param](./rules/require-store-callbacks-use-set-param.md) | store callbacks must use `set` param | |
29-
| [svelte/require-store-reactive-access](./rules/require-store-reactive-access.md) | disallow to render store itself. Need to use $ prefix or get function. | :wrench: |
29+
| [svelte/require-store-reactive-access](./rules/require-store-reactive-access.md) | disallow to use of the store itself as an operand. Need to use $ prefix or get function. | :wrench: |
3030
| [svelte/valid-compile](./rules/valid-compile.md) | disallow warnings when compiling. | :star: |
3131

3232
## Security Vulnerability

docs/rules/require-store-reactive-access.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
pageClass: "rule-details"
33
sidebarDepth: 0
44
title: "svelte/require-store-reactive-access"
5-
description: "disallow to render store itself. Need to use $ prefix or get function."
5+
description: "disallow to use of the store itself as an operand. Need to use $ prefix or get function."
66
---
77

88
# svelte/require-store-reactive-access
99

10-
> disallow to render store itself. Need to use $ prefix or get function.
10+
> disallow to use of the store itself as an operand. Need to use $ prefix or get function.
1111
1212
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> **_This rule has not been released yet._** </badge>
1313
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
1414

1515
## :book: Rule Details
1616

17-
This rule disallow to render store itself.
17+
This rule disallow to use of the store itself as an operand.
1818
You should access the store value using the `$` prefix or the `get` function.
1919

2020
<ESLintCodeBlock fix>

src/rules/require-store-reactive-access.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default createRule("require-store-reactive-access", {
77
meta: {
88
docs: {
99
description:
10-
"disallow to render store itself. Need to use $ prefix or get function.",
10+
"disallow to use of the store itself as an operand. Need to use $ prefix or get function.",
1111
category: "Possible Errors",
1212
// TODO Switch to recommended in the major version.
1313
// recommended: true,
@@ -17,7 +17,7 @@ export default createRule("require-store-reactive-access", {
1717
schema: [],
1818
messages: {
1919
usingRawStoreInText:
20-
"Use $ prefix or get function, instead of using raw stores in template.",
20+
"Use the $ prefix or the get function to access reactive values instead of accessing the raw store.",
2121
},
2222
type: "problem",
2323
},
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 7
33
column: 19
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 8
77
column: 12
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 9
1111
column: 7
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 10
1515
column: 10
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 11
1919
column: 17
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 12
2323
column: 13
2424
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 10
33
column: 19
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 11
77
column: 19
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 12
1111
column: 12
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 13
1515
column: 10
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 14
1919
column: 17
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 15
2323
column: 9
2424
suggestions: null
25-
- message: Use $ prefix or get function, instead of using raw stores in template.
25+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2626
line: 16
2727
column: 10
2828
suggestions: null
29-
- message: Use $ prefix or get function, instead of using raw stores in template.
29+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
3030
line: 18
3131
column: 16
3232
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 7
33
column: 27
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 8
77
column: 25
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 9
1111
column: 30
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 10
1515
column: 18
1616
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 8
33
column: 25
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 8
77
column: 49
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 9
1111
column: 25
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 9
1515
column: 47
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 10
1919
column: 25
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 10
2323
column: 52
2424
suggestions: null
25-
- message: Use $ prefix or get function, instead of using raw stores in template.
25+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2626
line: 11
2727
column: 25
2828
suggestions: null
29-
- message: Use $ prefix or get function, instead of using raw stores in template.
29+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
3030
line: 11
3131
column: 40
3232
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 9
33
column: 23
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 9
77
column: 41
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 10
1111
column: 23
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 10
1515
column: 34
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 11
1919
column: 23
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 11
2323
column: 29
2424
suggestions: null
25-
- message: Use $ prefix or get function, instead of using raw stores in template.
25+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2626
line: 12
2727
column: 23
2828
suggestions: null
29-
- message: Use $ prefix or get function, instead of using raw stores in template.
29+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
3030
line: 12
3131
column: 32
3232
suggestions: null
33-
- message: Use $ prefix or get function, instead of using raw stores in template.
33+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
3434
line: 13
3535
column: 23
3636
suggestions: null
37-
- message: Use $ prefix or get function, instead of using raw stores in template.
37+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
3838
line: 13
3939
column: 39
4040
suggestions: null
41-
- message: Use $ prefix or get function, instead of using raw stores in template.
41+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
4242
line: 14
4343
column: 23
4444
suggestions: null
45-
- message: Use $ prefix or get function, instead of using raw stores in template.
45+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
4646
line: 14
4747
column: 35
4848
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 17
33
column: 5
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 18
77
column: 5
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 19
1111
column: 5
1212
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 6
33
column: 5
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 7
77
column: 5
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 8
1111
column: 5
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 9
1515
column: 5
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 10
1919
column: 5
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 11
2323
column: 5
2424
suggestions: null
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
- message: Use $ prefix or get function, instead of using raw stores in template.
1+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
22
line: 27
33
column: 5
44
suggestions: null
5-
- message: Use $ prefix or get function, instead of using raw stores in template.
5+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
66
line: 28
77
column: 5
88
suggestions: null
9-
- message: Use $ prefix or get function, instead of using raw stores in template.
9+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1010
line: 29
1111
column: 5
1212
suggestions: null
13-
- message: Use $ prefix or get function, instead of using raw stores in template.
13+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1414
line: 30
1515
column: 5
1616
suggestions: null
17-
- message: Use $ prefix or get function, instead of using raw stores in template.
17+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
1818
line: 31
1919
column: 5
2020
suggestions: null
21-
- message: Use $ prefix or get function, instead of using raw stores in template.
21+
- message: Use the $ prefix or the get function to access reactive values instead of accessing the raw store.
2222
line: 32
2323
column: 5
2424
suggestions: null

0 commit comments

Comments
 (0)