eslint-plugin-svelte 2.4.1 → 2.5.0

package/README.md

@@ -282,10 +282,12 @@ These rules relate to better ways of doing things to help you avoid problems:
 |:--------|:------------|:---|
 | [svelte/button-has-type](https://ota-meshi.github.io/eslint-plugin-svelte/rules/button-has-type/) | disallow usage of button without an explicit type attribute |  |
 | [svelte/no-at-debug-tags](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-at-debug-tags/) | disallow the use of `{@debug}` | :star: |
-| [svelte/no-reactive-literals](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-reactive-literals/) | Don't assign literal values in reactive statements | :bulb: |
+| [svelte/no-reactive-functions](https://ota-meshi.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://ota-meshi.github.io/eslint-plugin-svelte/rules/no-reactive-literals/) | don't assign literal values in reactive statements | :bulb: |
 | [svelte/no-unused-svelte-ignore](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-unused-svelte-ignore/) | disallow unused svelte-ignore comments | :star: |
 | [svelte/no-useless-mustaches](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-useless-mustaches/) | disallow unnecessary mustache interpolations | :wrench: |
 | [svelte/require-optimized-style-attribute](https://ota-meshi.github.io/eslint-plugin-svelte/rules/require-optimized-style-attribute/) | require style attributes that can be optimized |  |
+| [svelte/require-stores-init](https://ota-meshi.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store |  |
 
 ## Stylistic Issues
 
@@ -296,6 +298,7 @@ These rules relate to style guidelines, and are therefore quite subjective:
 | [svelte/first-attribute-linebreak](https://ota-meshi.github.io/eslint-plugin-svelte/rules/first-attribute-linebreak/) | enforce the location of first attribute | :wrench: |
 | [svelte/html-closing-bracket-spacing](https://ota-meshi.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://ota-meshi.github.io/eslint-plugin-svelte/rules/html-quotes/) | enforce quotes style of HTML attributes | :wrench: |
+| [svelte/html-self-closing](https://ota-meshi.github.io/eslint-plugin-svelte/rules/html-self-closing/) | enforce self-closing style | :wrench: |
 | [svelte/indent](https://ota-meshi.github.io/eslint-plugin-svelte/rules/indent/) | enforce consistent indentation | :wrench: |
 | [svelte/max-attributes-per-line](https://ota-meshi.github.io/eslint-plugin-svelte/rules/max-attributes-per-line/) | enforce the maximum number of attributes per line | :wrench: |
 | [svelte/mustache-spacing](https://ota-meshi.github.io/eslint-plugin-svelte/rules/mustache-spacing/) | enforce unified spacing in mustache | :wrench: |

package/lib/configs/prettier.d.ts

@@ -4,6 +4,7 @@ declare const _default: {
         "svelte/first-attribute-linebreak": string;
         "svelte/html-closing-bracket-spacing": string;
         "svelte/html-quotes": string;
+        "svelte/html-self-closing": string;
         "svelte/indent": string;
         "svelte/max-attributes-per-line": string;
         "svelte/mustache-spacing": string;

package/lib/configs/prettier.js

@@ -11,6 +11,7 @@ module.exports = {
         "svelte/first-attribute-linebreak": "off",
         "svelte/html-closing-bracket-spacing": "off",
         "svelte/html-quotes": "off",
+        "svelte/html-self-closing": "off",
         "svelte/indent": "off",
         "svelte/max-attributes-per-line": "off",
         "svelte/mustache-spacing": "off",

package/lib/index.d.ts

@@ -39,6 +39,7 @@ declare const _default: {
                 "svelte/first-attribute-linebreak": string;
                 "svelte/html-closing-bracket-spacing": string;
                 "svelte/html-quotes": string;
+                "svelte/html-self-closing": string;
                 "svelte/indent": string;
                 "svelte/max-attributes-per-line": string;
                 "svelte/mustache-spacing": string;

package/lib/rules/html-self-closing.d.ts

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

package/lib/rules/html-self-closing.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const ast_utils_1 = require("../utils/ast-utils");
+const TYPE_MESSAGES = {
+    normal: "HTML elements",
+    void: "HTML void elements",
+    component: "Svelte custom components",
+    svelte: "Svelte special elements",
+};
+exports.default = (0, utils_1.createRule)("html-self-closing", {
+    meta: {
+        docs: {
+            description: "enforce self-closing style",
+            category: "Stylistic Issues",
+            recommended: false,
+            conflictWithPrettier: true,
+        },
+        type: "layout",
+        fixable: "code",
+        messages: {
+            requireClosing: "Require self-closing on {{type}}.",
+            disallowClosing: "Disallow self-closing on {{type}}.",
+        },
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    void: {
+                        enum: ["never", "always", "ignore"],
+                    },
+                    normal: {
+                        enum: ["never", "always", "ignore"],
+                    },
+                    component: {
+                        enum: ["never", "always", "ignore"],
+                    },
+                    svelte: {
+                        enum: ["never", "always", "ignore"],
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    create(ctx) {
+        const options = {
+            void: "always",
+            normal: "always",
+            component: "always",
+            svelte: "always",
+            ...ctx.options?.[0],
+        };
+        function getElementType(node) {
+            if (node.kind === "component")
+                return "component";
+            if (node.kind === "special")
+                return "svelte";
+            if ((0, ast_utils_1.isVoidHtmlElement)(node))
+                return "void";
+            return "normal";
+        }
+        function isElementEmpty(node) {
+            if (node.children.length <= 0)
+                return true;
+            for (const child of node.children) {
+                if (child.type !== "SvelteText")
+                    return false;
+                if (!/^\s*$/.test(child.value))
+                    return false;
+            }
+            return true;
+        }
+        function report(node, close) {
+            const elementType = getElementType(node);
+            ctx.report({
+                node,
+                messageId: close ? "requireClosing" : "disallowClosing",
+                data: {
+                    type: TYPE_MESSAGES[elementType],
+                },
+                *fix(fixer) {
+                    if (close) {
+                        for (const child of node.children) {
+                            yield fixer.removeRange(child.range);
+                        }
+                        yield fixer.insertTextBeforeRange([node.startTag.range[1] - 1, node.startTag.range[1]], "/");
+                        if (node.endTag)
+                            yield fixer.removeRange(node.endTag.range);
+                    }
+                    else {
+                        yield fixer.removeRange([
+                            node.startTag.range[1] - 2,
+                            node.startTag.range[1] - 1,
+                        ]);
+                        if (!(0, ast_utils_1.isVoidHtmlElement)(node))
+                            yield fixer.insertTextAfter(node, `</${(0, ast_utils_1.getNodeName)(node)}>`);
+                    }
+                },
+            });
+        }
+        return {
+            SvelteElement(node) {
+                if (!isElementEmpty(node))
+                    return;
+                const elementType = getElementType(node);
+                const elementTypeOptions = options[elementType];
+                if (elementTypeOptions === "ignore")
+                    return;
+                const shouldBeClosed = elementTypeOptions === "always";
+                if (shouldBeClosed && !node.startTag.selfClosing) {
+                    report(node, true);
+                }
+                else if (!shouldBeClosed && node.startTag.selfClosing) {
+                    report(node, false);
+                }
+            },
+        };
+    },
+});

package/lib/rules/no-reactive-functions.d.ts

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

package/lib/rules/no-reactive-functions.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+exports.default = (0, utils_1.createRule)("no-reactive-functions", {
+    meta: {
+        docs: {
+            description: "it's not necessary to define functions in reactive statements",
+            category: "Best Practices",
+            recommended: false,
+        },
+        hasSuggestions: true,
+        schema: [],
+        messages: {
+            noReactiveFns: `Do not create functions inside reactive statements unless absolutely necessary.`,
+            fixReactiveFns: `Move the function out of the reactive statement`,
+        },
+        type: "suggestion",
+    },
+    create(context) {
+        return {
+            [`SvelteReactiveStatement > ExpressionStatement > AssignmentExpression > :function`](node) {
+                const parent = node.parent?.parent?.parent;
+                if (!parent) {
+                    return false;
+                }
+                const source = context.getSourceCode();
+                return context.report({
+                    node: parent,
+                    loc: parent.loc,
+                    messageId: "noReactiveFns",
+                    suggest: [
+                        {
+                            messageId: "fixReactiveFns",
+                            fix(fixer) {
+                                const tokens = source.getFirstTokens(parent, {
+                                    includeComments: false,
+                                    count: 3,
+                                });
+                                const noExtraSpace = source.isSpaceBetweenTokens(tokens[1], tokens[2]);
+                                return fixer.replaceTextRange([tokens[0].range[0], tokens[1].range[1]], noExtraSpace ? "const" : "const ");
+                            },
+                        },
+                    ],
+                });
+            },
+        };
+    },
+});

package/lib/rules/no-reactive-literals.js

@@ -4,7 +4,7 @@ const utils_1 = require("../utils");
 exports.default = (0, utils_1.createRule)("no-reactive-literals", {
     meta: {
         docs: {
-            description: "Don't assign literal values in reactive statements",
+            description: "don't assign literal values in reactive statements",
             category: "Best Practices",
             recommended: false,
         },

package/lib/rules/require-stores-init.d.ts

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

package/lib/rules/require-stores-init.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const eslint_utils_1 = require("eslint-utils");
+exports.default = (0, utils_1.createRule)("require-stores-init", {
+    meta: {
+        docs: {
+            description: "require initial value in store",
+            category: "Best Practices",
+            recommended: false,
+        },
+        schema: [],
+        messages: {
+            storeDefaultValue: `Always set a default value for svelte stores.`,
+        },
+        type: "suggestion",
+    },
+    create(context) {
+        function* extractStoreReferences() {
+            const referenceTracker = new eslint_utils_1.ReferenceTracker(context.getScope());
+            for (const { node, path } of referenceTracker.iterateEsmReferences({
+                "svelte/store": {
+                    [eslint_utils_1.ReferenceTracker.ESM]: true,
+                    writable: {
+                        [eslint_utils_1.ReferenceTracker.CALL]: true,
+                    },
+                    readable: {
+                        [eslint_utils_1.ReferenceTracker.CALL]: true,
+                    },
+                    derived: {
+                        [eslint_utils_1.ReferenceTracker.CALL]: true,
+                    },
+                },
+            })) {
+                yield {
+                    node: node,
+                    name: path[path.length - 1],
+                };
+            }
+        }
+        return {
+            Program() {
+                for (const { node, name } of extractStoreReferences()) {
+                    const minArgs = name === "writable" || name === "readable"
+                        ? 1
+                        : name === "derived"
+                            ? 3
+                            : 0;
+                    if (node.arguments.length >= minArgs ||
+                        node.arguments.some((arg) => arg.type === "SpreadElement")) {
+                        continue;
+                    }
+                    context.report({
+                        node,
+                        messageId: "storeDefaultValue",
+                    });
+                }
+            },
+        };
+    },
+});

package/lib/utils/ast-utils.d.ts

@@ -48,3 +48,5 @@ export declare function getMustacheTokens(node: SvAST.SvelteDirective | SvAST.Sv
 } | null;
 export declare function getAttributeKeyText(node: SvAST.SvelteAttribute | SvAST.SvelteShorthandAttribute | SvAST.SvelteStyleDirective | SvAST.SvelteDirective | SvAST.SvelteSpecialDirective): string;
 export declare function getDirectiveName(node: SvAST.SvelteDirective): string;
+export declare function getNodeName(node: SvAST.SvelteElement): string;
+export declare function isVoidHtmlElement(node: SvAST.SvelteElement): boolean;

package/lib/utils/ast-utils.js

@@ -22,9 +22,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDirectiveName = exports.getAttributeKeyText = exports.getMustacheTokens = exports.getAttributeValueQuoteAndRange = exports.getScope = exports.findVariable = exports.getLangValue = exports.getStaticAttributeValue = exports.findBindDirective = exports.findShorthandAttribute = exports.findAttribute = exports.isHTMLElementLike = exports.needParentheses = exports.getStringIfConstant = exports.equalTokens = void 0;
+exports.isVoidHtmlElement = exports.getNodeName = exports.getDirectiveName = exports.getAttributeKeyText = exports.getMustacheTokens = exports.getAttributeValueQuoteAndRange = exports.getScope = exports.findVariable = exports.getLangValue = exports.getStaticAttributeValue = exports.findBindDirective = exports.findShorthandAttribute = exports.findAttribute = exports.isHTMLElementLike = exports.needParentheses = exports.getStringIfConstant = exports.equalTokens = void 0;
 const eslintUtils = __importStar(require("eslint-utils"));
+const void_elements_1 = __importDefault(require("./void-elements"));
 function equalTokens(left, right, sourceCode) {
     const tokensL = sourceCode.getTokens(left);
     const tokensR = sourceCode.getTokens(right);
@@ -322,3 +326,23 @@ function getAttributeValueRangeTokens(attr, sourceCode) {
         lastToken: tokens.closeToken,
     };
 }
+function getNodeName(node) {
+    if ("name" in node.name) {
+        return node.name.name;
+    }
+    let object = "";
+    let currentObject = node.name.object;
+    while ("object" in currentObject) {
+        object = `${currentObject.property.name}.${object}`;
+        currentObject = currentObject.object;
+    }
+    if ("name" in currentObject) {
+        object = `${currentObject.name}.${object}`;
+    }
+    return object + node.name.property.name;
+}
+exports.getNodeName = getNodeName;
+function isVoidHtmlElement(node) {
+    return void_elements_1.default.includes(getNodeName(node));
+}
+exports.isVoidHtmlElement = isVoidHtmlElement;

package/lib/utils/rules.js

@@ -9,6 +9,7 @@ const comment_directive_1 = __importDefault(require("../rules/comment-directive"
 const first_attribute_linebreak_1 = __importDefault(require("../rules/first-attribute-linebreak"));
 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"));
 const indent_1 = __importDefault(require("../rules/indent"));
 const max_attributes_per_line_1 = __importDefault(require("../rules/max-attributes-per-line"));
 const mustache_spacing_1 = __importDefault(require("../rules/mustache-spacing"));
@@ -21,6 +22,7 @@ const no_extra_reactive_curlies_1 = __importDefault(require("../rules/no-extra-r
 const no_inner_declarations_1 = __importDefault(require("../rules/no-inner-declarations"));
 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"));
 const no_reactive_literals_1 = __importDefault(require("../rules/no-reactive-literals"));
 const no_shorthand_style_property_overrides_1 = __importDefault(require("../rules/no-shorthand-style-property-overrides"));
 const no_spaces_around_equal_signs_in_attribute_1 = __importDefault(require("../rules/no-spaces-around-equal-signs-in-attribute"));
@@ -31,6 +33,7 @@ const no_useless_mustaches_1 = __importDefault(require("../rules/no-useless-must
 const prefer_class_directive_1 = __importDefault(require("../rules/prefer-class-directive"));
 const prefer_style_directive_1 = __importDefault(require("../rules/prefer-style-directive"));
 const require_optimized_style_attribute_1 = __importDefault(require("../rules/require-optimized-style-attribute"));
+const require_stores_init_1 = __importDefault(require("../rules/require-stores-init"));
 const shorthand_attribute_1 = __importDefault(require("../rules/shorthand-attribute"));
 const shorthand_directive_1 = __importDefault(require("../rules/shorthand-directive"));
 const sort_attributes_1 = __importDefault(require("../rules/sort-attributes"));
@@ -43,6 +46,7 @@ exports.rules = [
     first_attribute_linebreak_1.default,
     html_closing_bracket_spacing_1.default,
     html_quotes_1.default,
+    html_self_closing_1.default,
     indent_1.default,
     max_attributes_per_line_1.default,
     mustache_spacing_1.default,
@@ -55,6 +59,7 @@ exports.rules = [
     no_inner_declarations_1.default,
     no_not_function_handler_1.default,
     no_object_in_text_mustaches_1.default,
+    no_reactive_functions_1.default,
     no_reactive_literals_1.default,
     no_shorthand_style_property_overrides_1.default,
     no_spaces_around_equal_signs_in_attribute_1.default,
@@ -65,6 +70,7 @@ exports.rules = [
     prefer_class_directive_1.default,
     prefer_style_directive_1.default,
     require_optimized_style_attribute_1.default,
+    require_stores_init_1.default,
     shorthand_attribute_1.default,
     shorthand_directive_1.default,
     sort_attributes_1.default,

package/lib/utils/void-elements.d.ts

@@ -0,0 +1,2 @@
+declare const voidElements: string[];
+export default voidElements;

package/lib/utils/void-elements.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const voidElements = [
+    "area",
+    "base",
+    "br",
+    "col",
+    "embed",
+    "hr",
+    "img",
+    "input",
+    "keygen",
+    "link",
+    "menuitem",
+    "meta",
+    "param",
+    "source",
+    "track",
+    "wbr",
+];
+exports.default = voidElements;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "ESLint plugin for Svelte using AST",
   "repository": "git+https://github.com/ota-meshi/eslint-plugin-svelte.git",
   "homepage": "https://ota-meshi.github.io/eslint-plugin-svelte",
@@ -66,7 +66,7 @@
     "postcss-load-config": "^3.1.4",
     "postcss-safe-parser": "^6.0.0",
     "sourcemap-codec": "^1.4.8",
-    "svelte-eslint-parser": "^0.17.0"
+    "svelte-eslint-parser": "^0.18.0"
   },
   "devDependencies": {
     "@babel/core": "^7.16.0",
@@ -83,6 +83,7 @@
     "@types/escape-html": "^1.0.2",
     "@types/eslint": "^8.0.0",
     "@types/eslint-scope": "^3.7.0",
+    "@types/eslint-utils": "^3.0.1",
     "@types/eslint-visitor-keys": "^1.0.0",
     "@types/estree": "^1.0.0",
     "@types/less": "^3.0.3",
@@ -99,7 +100,7 @@
     "@typescript-eslint/parser-v4": "npm:@typescript-eslint/parser@4",
     "assert": "^2.0.0",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.14.1",
+    "esbuild": "^0.15.0",
     "esbuild-register": "^3.2.0",
     "escape-html": "^1.0.3",
     "eslint": "^8.0.0",
@@ -135,13 +136,14 @@
     "sass": "^1.51.0",
     "semver": "^7.3.5",
     "stylelint": "^14.0.0",
-    "stylelint-config-standard": "^26.0.0",
+    "stylelint-config-standard": "^27.0.0",
     "stylus": "^0.58.0",
     "svelte": "^3.46.1",
     "svelte-adapter-ghpages": "0.0.2",
     "typescript": "^4.5.2",
     "vite": "^3.0.0-0",
-    "vite-plugin-svelte-md": "^0.1.5"
+    "vite-plugin-svelte-md": "^0.1.5",
+    "yaml": "^2.1.1"
   },
   "publishConfig": {
     "access": "public"