Skip to content

Commit 0fe07d7

Browse files
committed
fix(no-inspect): disable recommended & add description
1 parent 0d42656 commit 0fe07d7

File tree

7 files changed

+8
-9
lines changed

7 files changed

+8
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ These rules relate to better ways of doing things to help you avoid problems:
419419
| [svelte/no-ignored-unsubscribe](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-ignored-unsubscribe/) | disallow ignoring the unsubscribe method returned by the `subscribe()` on Svelte stores. | |
420420
| [svelte/no-immutable-reactive-statements](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-immutable-reactive-statements/) | disallow reactive statements that don't reference reactive values. | |
421421
| [svelte/no-inline-styles](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inline-styles/) | disallow attributes and directives that produce inline styles | |
422-
| [svelte/no-inspect](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inspect/) | (no description) | :star: |
422+
| [svelte/no-inspect](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inspect/) | Warns against the use of `$inspect` directive | |
423423
| [svelte/no-reactive-functions](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-reactive-functions/) | it's not necessary to define functions in reactive statements | :bulb: |
424424
| [svelte/no-reactive-literals](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-reactive-literals/) | don't assign literal values in reactive statements | :bulb: |
425425
| [svelte/no-svelte-internal](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-svelte-internal/) | svelte/internal will be removed in Svelte 6. | |

docs/rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ These rules relate to better ways of doing things to help you avoid problems:
5656
| [svelte/no-ignored-unsubscribe](./rules/no-ignored-unsubscribe.md) | disallow ignoring the unsubscribe method returned by the `subscribe()` on Svelte stores. | |
5757
| [svelte/no-immutable-reactive-statements](./rules/no-immutable-reactive-statements.md) | disallow reactive statements that don't reference reactive values. | |
5858
| [svelte/no-inline-styles](./rules/no-inline-styles.md) | disallow attributes and directives that produce inline styles | |
59-
| [svelte/no-inspect](./rules/no-inspect.md) | (no description) | :star: |
59+
| [svelte/no-inspect](./rules/no-inspect.md) | Warns against the use of `$inspect` directive | |
6060
| [svelte/no-reactive-functions](./rules/no-reactive-functions.md) | it's not necessary to define functions in reactive statements | :bulb: |
6161
| [svelte/no-reactive-literals](./rules/no-reactive-literals.md) | don't assign literal values in reactive statements | :bulb: |
6262
| [svelte/no-svelte-internal](./rules/no-svelte-internal.md) | svelte/internal will be removed in Svelte 6. | |

docs/rules/no-inspect.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22
pageClass: 'rule-details'
33
sidebarDepth: 0
44
title: 'svelte/no-inspect'
5-
description: ''
5+
description: 'Warns against the use of `$inspect` directive'
66
---
77

88
# svelte/no-inspect
99

10-
>
10+
> Warns against the use of `$inspect` directive
1111
1212
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> **_This rule has not been released yet._** </badge>
13-
- :gear: This rule is included in `"plugin:svelte/recommended"`.
1413

1514
## :book: Rule Details
1615

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ const config: Linter.Config[] = [
1616
'svelte/no-dupe-style-properties': 'error',
1717
'svelte/no-dynamic-slot-name': 'error',
1818
'svelte/no-inner-declarations': 'error',
19-
'svelte/no-inspect': 'warn',
2019
'svelte/no-not-function-handler': 'error',
2120
'svelte/no-object-in-text-mustaches': 'error',
2221
'svelte/no-shorthand-style-property-overrides': 'error',

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ const config: Linter.LegacyConfig = {
1616
'svelte/no-dupe-style-properties': 'error',
1717
'svelte/no-dynamic-slot-name': 'error',
1818
'svelte/no-inner-declarations': 'error',
19-
'svelte/no-inspect': 'warn',
2019
'svelte/no-not-function-handler': 'error',
2120
'svelte/no-object-in-text-mustaches': 'error',
2221
'svelte/no-shorthand-style-property-overrides': 'error',

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ export interface RuleOptions {
165165
*/
166166
'svelte/no-inner-declarations'?: Linter.RuleEntry<SvelteNoInnerDeclarations>
167167
/**
168+
* Warns against the use of `$inspect` directive
168169
* @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inspect/
169170
*/
170171
'svelte/no-inspect'?: Linter.RuleEntry<[]>

packages/eslint-plugin-svelte/src/rules/no-inspect.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ import { createRule } from '../utils';
55
export default createRule('no-inspect', {
66
meta: {
77
docs: {
8-
description: '',
8+
description: 'Warns against the use of `$inspect` directive',
99
category: 'Best Practices',
10-
recommended: true,
10+
// TODO: Enable recommended in major version
11+
recommended: false,
1112
default: 'warn'
1213
},
1314
schema: [],

0 commit comments

Comments
 (0)