eslint-plugin-svelte 2.44.1 → 2.45.0

package/README.md

@@ -419,6 +419,7 @@ These rules relate to better ways of doing things to help you avoid problems:
 | [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. |  |
 | [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. |  |
 | [svelte/no-inline-styles](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inline-styles/) | disallow attributes and directives that produce inline styles |  |
+| [svelte/no-inspect](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inspect/) | Warns against the use of `$inspect` directive |  |
 | [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: |
 | [svelte/no-reactive-literals](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-reactive-literals/) | don't assign literal values in reactive statements | :bulb: |
 | [svelte/no-svelte-internal](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-svelte-internal/) | svelte/internal will be removed in Svelte 6. |  |
@@ -440,6 +441,7 @@ These rules relate to style guidelines, and are therefore quite subjective:
 |:--------|:------------|:---|
 | [svelte/derived-has-same-inputs-outputs](https://sveltejs.github.io/eslint-plugin-svelte/rules/derived-has-same-inputs-outputs/) | derived store should use same variable names between values and callback |  |
 | [svelte/first-attribute-linebreak](https://sveltejs.github.io/eslint-plugin-svelte/rules/first-attribute-linebreak/) | enforce the location of first attribute | :wrench: |
+| [svelte/html-closing-bracket-new-line](https://sveltejs.github.io/eslint-plugin-svelte/rules/html-closing-bracket-new-line/) | Require or disallow a line break before tag's closing brackets | :wrench: |
 | [svelte/html-closing-bracket-spacing](https://sveltejs.github.io/eslint-plugin-svelte/rules/html-closing-bracket-spacing/) | require or disallow a space before tag's closing brackets | :wrench: |
 | [svelte/html-quotes](https://sveltejs.github.io/eslint-plugin-svelte/rules/html-quotes/) | enforce quotes style of HTML attributes | :wrench: |
 | [svelte/html-self-closing](https://sveltejs.github.io/eslint-plugin-svelte/rules/html-self-closing/) | enforce self-closing style | :wrench: |

package/lib/configs/flat/all.d.ts

@@ -1,3 +1,3 @@
 import type { Linter } from 'eslint';
-declare const config: Linter.FlatConfig[];
+declare const config: Linter.Config[];
 export default config;

package/lib/configs/flat/prettier.js

@@ -11,6 +11,7 @@ const config = [
         rules: {
             // eslint-plugin-svelte rules
             'svelte/first-attribute-linebreak': 'off',
+            'svelte/html-closing-bracket-new-line': 'off',
             'svelte/html-closing-bracket-spacing': 'off',
             'svelte/html-quotes': 'off',
             'svelte/html-self-closing': 'off',

package/lib/configs/prettier.js

@@ -10,6 +10,7 @@ const config = {
     rules: {
         // eslint-plugin-svelte rules
         'svelte/first-attribute-linebreak': 'off',
+        'svelte/html-closing-bracket-new-line': 'off',
         'svelte/html-closing-bracket-spacing': 'off',
         'svelte/html-quotes': 'off',
         'svelte/html-self-closing': 'off',

package/lib/index.d.ts

@@ -11,7 +11,7 @@ declare const _default: {
         'flat/base': import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
         'flat/recommended': import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
         'flat/prettier': import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
-        'flat/all': import("eslint").Linter.FlatConfig[];
+        'flat/all': import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
     };
     rules: {
         [key: string]: RuleModule;

package/lib/meta.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "eslint-plugin-svelte";
-export declare const version = "2.44.1";
+export declare const version = "2.45.0";

package/lib/meta.js

@@ -5,4 +5,4 @@ exports.version = exports.name = void 0;
 // This file has been automatically generated,
 // in order to update its content execute "pnpm run update"
 exports.name = 'eslint-plugin-svelte';
-exports.version = '2.44.1';
+exports.version = '2.45.0';

package/lib/rule-types.d.ts

@@ -47,6 +47,11 @@ export interface RuleOptions {
      * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/first-attribute-linebreak/
      */
     'svelte/first-attribute-linebreak'?: Linter.RuleEntry<SvelteFirstAttributeLinebreak>;
+    /**
+     * Require or disallow a line break before tag's closing brackets
+     * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/html-closing-bracket-new-line/
+     */
+    'svelte/html-closing-bracket-new-line'?: Linter.RuleEntry<SvelteHtmlClosingBracketNewLine>;
     /**
      * require or disallow a space before tag's closing brackets
      * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/html-closing-bracket-spacing/
@@ -157,6 +162,11 @@ export interface RuleOptions {
      * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inner-declarations/
      */
     'svelte/no-inner-declarations'?: Linter.RuleEntry<SvelteNoInnerDeclarations>;
+    /**
+     * Warns against the use of `$inspect` directive
+     * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-inspect/
+     */
+    'svelte/no-inspect'?: Linter.RuleEntry<[]>;
     /**
      * disallow use of not function in event handler
      * @see https://sveltejs.github.io/eslint-plugin-svelte/rules/no-not-function-handler/
@@ -355,6 +365,16 @@ type SvelteFirstAttributeLinebreak = [] | [
         singleline?: ("below" | "beside");
     }
 ];
+type SvelteHtmlClosingBracketNewLine = [] | [
+    {
+        singleline?: ("always" | "never");
+        multiline?: ("always" | "never");
+        selfClosingTag?: {
+            singleline?: ("always" | "never");
+            multiline?: ("always" | "never");
+        };
+    }
+];
 type SvelteHtmlClosingBracketSpacing = [] | [
     {
         startTag?: ("always" | "never" | "ignore");

package/lib/rules/html-closing-bracket-new-line.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../types").RuleModule;
+export default _default;

package/lib/rules/html-closing-bracket-new-line.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const compat_1 = require("../utils/compat");
+function getPhrase(lineBreaks) {
+    switch (lineBreaks) {
+        case 0: {
+            return 'no line breaks';
+        }
+        case 1: {
+            return '1 line break';
+        }
+        default: {
+            return `${lineBreaks} line breaks`;
+        }
+    }
+}
+function getExpectedLineBreaks(node, options, type) {
+    const isSelfClosingTag = node.type === 'SvelteStartTag' && node.selfClosing;
+    if (isSelfClosingTag && options.selfClosingTag && options.selfClosingTag[type]) {
+        return options.selfClosingTag[type] === 'always' ? 1 : 0;
+    }
+    return options[type] === 'always' ? 1 : 0;
+}
+function getSelfClosingData(sourceCode, node, options) {
+    const tokens = sourceCode.getTokens(node);
+    const closingToken = tokens[tokens.length - 2];
+    if (closingToken.value !== '/') {
+        return null;
+    }
+    const prevToken = sourceCode.getTokenBefore(closingToken);
+    const type = node.loc.start.line === prevToken.loc.end.line ? 'singleline' : 'multiline';
+    const expectedLineBreaks = getExpectedLineBreaks(node, options, type);
+    const actualLineBreaks = closingToken.loc.start.line - prevToken.loc.end.line;
+    return { actualLineBreaks, expectedLineBreaks, startToken: prevToken, endToken: closingToken };
+}
+function getNodeData(sourceCode, node, options) {
+    const closingToken = sourceCode.getLastToken(node);
+    if (closingToken.value !== '>') {
+        return null;
+    }
+    const prevToken = sourceCode.getTokenBefore(closingToken);
+    const type = node.loc.start.line === prevToken.loc.end.line ? 'singleline' : 'multiline';
+    const expectedLineBreaks = getExpectedLineBreaks(node, options, type);
+    const actualLineBreaks = closingToken.loc.start.line - prevToken.loc.end.line;
+    return { actualLineBreaks, expectedLineBreaks, startToken: prevToken, endToken: closingToken };
+}
+exports.default = (0, utils_1.createRule)('html-closing-bracket-new-line', {
+    meta: {
+        docs: {
+            description: "Require or disallow a line break before tag's closing brackets",
+            category: 'Stylistic Issues',
+            recommended: false,
+            conflictWithPrettier: true
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    singleline: { enum: ['always', 'never'] },
+                    multiline: { enum: ['always', 'never'] },
+                    selfClosingTag: {
+                        type: 'object',
+                        properties: {
+                            singleline: { enum: ['always', 'never'] },
+                            multiline: { enum: ['always', 'never'] }
+                        },
+                        additionalProperties: false,
+                        minProperties: 1
+                    }
+                },
+                additionalProperties: false
+            }
+        ],
+        messages: {
+            expectedBeforeClosingBracket: 'Expected {{expected}} before closing bracket, but {{actual}} found.'
+        },
+        fixable: 'code',
+        type: 'suggestion'
+    },
+    create(context) {
+        const options = context.options[0] ?? {};
+        options.singleline ?? (options.singleline = 'never');
+        options.multiline ?? (options.multiline = 'always');
+        const sourceCode = (0, compat_1.getSourceCode)(context);
+        return {
+            'SvelteStartTag, SvelteEndTag'(node) {
+                const data = node.type === 'SvelteStartTag' && node.selfClosing
+                    ? getSelfClosingData(sourceCode, node, options)
+                    : getNodeData(sourceCode, node, options);
+                if (!data) {
+                    return;
+                }
+                const { actualLineBreaks, expectedLineBreaks, startToken, endToken } = data;
+                if (actualLineBreaks !== expectedLineBreaks) {
+                    // For SvelteEndTag, does not make sense to add a line break, so we only fix if there are extra line breaks
+                    if (node.type === 'SvelteEndTag' && expectedLineBreaks !== 0) {
+                        return;
+                    }
+                    context.report({
+                        node,
+                        loc: { start: startToken.loc.end, end: endToken.loc.start },
+                        messageId: 'expectedBeforeClosingBracket',
+                        data: {
+                            expected: getPhrase(expectedLineBreaks),
+                            actual: getPhrase(actualLineBreaks)
+                        },
+                        fix(fixer) {
+                            const range = [startToken.range[1], endToken.range[0]];
+                            const text = '\n'.repeat(expectedLineBreaks);
+                            return fixer.replaceTextRange(range, text);
+                        }
+                    });
+                }
+            }
+        };
+    }
+});

package/lib/rules/no-inspect.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../types").RuleModule;
+export default _default;

package/lib/rules/no-inspect.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+exports.default = (0, utils_1.createRule)('no-inspect', {
+    meta: {
+        docs: {
+            description: 'Warns against the use of `$inspect` directive',
+            category: 'Best Practices',
+            // TODO: Enable recommended in major version
+            recommended: false,
+            default: 'warn'
+        },
+        schema: [],
+        messages: {
+            unexpected: 'Do not use $inspect directive'
+        },
+        type: 'suggestion'
+    },
+    create(context) {
+        return {
+            Identifier(node) {
+                if (node.name !== '$inspect') {
+                    return;
+                }
+                context.report({ messageId: 'unexpected', node });
+            }
+        };
+    }
+});

package/lib/utils/rules.js

@@ -12,6 +12,7 @@ const derived_has_same_inputs_outputs_1 = __importDefault(require("../rules/deri
 const experimental_require_slot_types_1 = __importDefault(require("../rules/experimental-require-slot-types"));
 const experimental_require_strict_events_1 = __importDefault(require("../rules/experimental-require-strict-events"));
 const first_attribute_linebreak_1 = __importDefault(require("../rules/first-attribute-linebreak"));
+const html_closing_bracket_new_line_1 = __importDefault(require("../rules/html-closing-bracket-new-line"));
 const html_closing_bracket_spacing_1 = __importDefault(require("../rules/html-closing-bracket-spacing"));
 const html_quotes_1 = __importDefault(require("../rules/html-quotes"));
 const html_self_closing_1 = __importDefault(require("../rules/html-self-closing"));
@@ -34,6 +35,7 @@ const no_ignored_unsubscribe_1 = __importDefault(require("../rules/no-ignored-un
 const no_immutable_reactive_statements_1 = __importDefault(require("../rules/no-immutable-reactive-statements"));
 const no_inline_styles_1 = __importDefault(require("../rules/no-inline-styles"));
 const no_inner_declarations_1 = __importDefault(require("../rules/no-inner-declarations"));
+const no_inspect_1 = __importDefault(require("../rules/no-inspect"));
 const no_not_function_handler_1 = __importDefault(require("../rules/no-not-function-handler"));
 const no_object_in_text_mustaches_1 = __importDefault(require("../rules/no-object-in-text-mustaches"));
 const no_reactive_functions_1 = __importDefault(require("../rules/no-reactive-functions"));
@@ -76,6 +78,7 @@ exports.rules = [
     experimental_require_slot_types_1.default,
     experimental_require_strict_events_1.default,
     first_attribute_linebreak_1.default,
+    html_closing_bracket_new_line_1.default,
     html_closing_bracket_spacing_1.default,
     html_quotes_1.default,
     html_self_closing_1.default,
@@ -98,6 +101,7 @@ exports.rules = [
     no_immutable_reactive_statements_1.default,
     no_inline_styles_1.default,
     no_inner_declarations_1.default,
+    no_inspect_1.default,
     no_not_function_handler_1.default,
     no_object_in_text_mustaches_1.default,
     no_reactive_functions_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.44.1",
+  "version": "2.45.0",
   "description": "ESLint plugin for Svelte using AST",
   "repository": "git+https://github.com/sveltejs/eslint-plugin-svelte.git",
   "homepage": "https://sveltejs.github.io/eslint-plugin-svelte",
@@ -45,39 +45,39 @@
     "svelte-eslint-parser": "^0.41.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.25.2",
-    "@babel/eslint-parser": "^7.25.1",
-    "@babel/plugin-proposal-function-bind": "^7.24.7",
+    "@babel/core": "^7.25.8",
+    "@babel/eslint-parser": "^7.25.8",
+    "@babel/plugin-proposal-function-bind": "^7.25.8",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
     "@types/babel__core": "^7.20.5",
     "@types/eslint-utils": "^3.0.5",
     "@types/esutils": "^2.0.2",
     "@types/json-schema": "^7.0.15",
     "@types/less": "^3.0.6",
-    "@types/mocha": "^10.0.8",
-    "@types/node": "^20.16.5",
+    "@types/mocha": "^10.0.9",
+    "@types/node": "^20.16.11",
     "@types/postcss-safe-parser": "^5.0.4",
     "@types/semver": "^7.5.8",
-    "@types/stylus": "^0.48.42",
-    "acorn": "^8.12.1",
+    "@types/stylus": "^0.48.43",
+    "acorn": "^8.13.0",
     "assert": "^2.1.0",
     "esbuild": "^0.24.0",
     "esbuild-register": "^3.6.0",
-    "eslint-scope": "^8.0.2",
+    "eslint-scope": "^8.1.0",
     "eslint-typegen": "^0.3.2",
-    "eslint-visitor-keys": "^4.0.0",
-    "espree": "^10.1.0",
+    "eslint-visitor-keys": "^4.1.0",
+    "espree": "^10.2.0",
     "less": "^4.2.0",
     "mocha": "^10.7.3",
-    "nyc": "^17.0.0",
+    "nyc": "^17.1.0",
     "postcss-nested": "^6.2.0",
-    "sass": "^1.78.0",
+    "sass": "^1.79.5",
     "source-map-js": "^1.2.1",
     "stylus": "^0.63.0",
-    "svelte": "5.0.0-next.249",
+    "svelte": "^5.0.0-next.268",
     "svelte-i18n": "^4.0.0",
-    "type-coverage": "^2.29.1",
-    "yaml": "^2.5.1"
+    "type-coverage": "^2.29.7",
+    "yaml": "^2.6.0"
   },
   "publishConfig": {
     "access": "public"