Skip to content

Commit 86a11de

Browse files
committed
docs(prefer-const): update docs
1 parent b8ed24c commit 86a11de

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ These rules relate to better ways of doing things to help you avoid problems:
427427
| [svelte/no-unused-class-name](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-unused-class-name/) | disallow the use of a class in the template without a corresponding style | |
428428
| [svelte/no-unused-svelte-ignore](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-unused-svelte-ignore/) | disallow unused svelte-ignore comments | :star: |
429429
| [svelte/no-useless-mustaches](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-useless-mustaches/) | disallow unnecessary mustache interpolations | :wrench: |
430-
| [svelte/prefer-const](https://sveltejs.github.io/eslint-plugin-svelte/rules/prefer-const/) | Require `const` declarations for variables that are never reassigned after declared (excludes reactive values). | :wrench: |
430+
| [svelte/prefer-const](https://sveltejs.github.io/eslint-plugin-svelte/rules/prefer-const/) | Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values). | :wrench: |
431431
| [svelte/prefer-destructured-store-props](https://sveltejs.github.io/eslint-plugin-svelte/rules/prefer-destructured-store-props/) | destructure values from object stores for better change tracking & fewer redraws | :bulb: |
432432
| [svelte/require-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-each-key/) | require keyed `{#each}` block | |
433433
| [svelte/require-event-dispatcher-types](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-event-dispatcher-types/) | require type parameters for `createEventDispatcher` | |

docs/rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ These rules relate to better ways of doing things to help you avoid problems:
6464
| [svelte/no-unused-class-name](./rules/no-unused-class-name.md) | disallow the use of a class in the template without a corresponding style | |
6565
| [svelte/no-unused-svelte-ignore](./rules/no-unused-svelte-ignore.md) | disallow unused svelte-ignore comments | :star: |
6666
| [svelte/no-useless-mustaches](./rules/no-useless-mustaches.md) | disallow unnecessary mustache interpolations | :wrench: |
67-
| [svelte/prefer-const](./rules/prefer-const.md) | Require `const` declarations for variables that are never reassigned after declared (excludes reactive values). | :wrench: |
67+
| [svelte/prefer-const](./rules/prefer-const.md) | Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values). | :wrench: |
6868
| [svelte/prefer-destructured-store-props](./rules/prefer-destructured-store-props.md) | destructure values from object stores for better change tracking & fewer redraws | :bulb: |
6969
| [svelte/require-each-key](./rules/require-each-key.md) | require keyed `{#each}` block | |
7070
| [svelte/require-event-dispatcher-types](./rules/require-event-dispatcher-types.md) | require type parameters for `createEventDispatcher` | |

docs/rules/prefer-const.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: 'rule-details'
33
sidebarDepth: 0
44
title: 'svelte/prefer-const'
5-
description: 'Require `const` declarations for variables that are never reassigned after declared (excludes reactive values).'
5+
description: 'Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values).'
66
---
77

88
# svelte/prefer-const
99

10-
> Require `const` declarations for variables that are never reassigned after declared (excludes reactive values).
10+
> Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values).
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.

packages/eslint-plugin-svelte/src/rule-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ export interface RuleOptions {
265265
*/
266266
'svelte/prefer-class-directive'?: Linter.RuleEntry<SveltePreferClassDirective>
267267
/**
268-
* Require `const` declarations for variables that are never reassigned after declared (excludes reactive values).
268+
* Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values).
269269
* @see https://sveltejs.github.io/eslint-plugin-svelte/rules/prefer-const/
270270
*/
271271
'svelte/prefer-const'?: Linter.RuleEntry<SveltePreferConst>

packages/eslint-plugin-svelte/src/rules/prefer-const.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ export default createRule('prefer-const', {
117117
type: 'suggestion',
118118
docs: {
119119
description:
120-
'Require `const` declarations for variables that are never reassigned after declared (excludes reactive values).',
120+
'Require `const` declarations for variables that are never reassigned after declared (excluding Svelte reactive values).',
121121
category: 'Best Practices',
122122
recommended: false
123123
},

0 commit comments

Comments
 (0)