eslint-plugin-svelte 2.33.1 → 2.34.0

package/README.md

@@ -340,6 +340,7 @@ These rules relate to better ways of doing things to help you avoid problems:
 | [svelte/block-lang](https://sveltejs.github.io/eslint-plugin-svelte/rules/block-lang/) | disallows the use of languages other than those specified in the configuration for the lang attribute of `<script>` and `<style>` blocks. |  |
 | [svelte/button-has-type](https://sveltejs.github.io/eslint-plugin-svelte/rules/button-has-type/) | disallow usage of button without an explicit type attribute |  |
 | [svelte/no-at-debug-tags](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-at-debug-tags/) | disallow the use of `{@debug}` | :star: |
+| [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-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: |

package/lib/meta.d.ts

@@ -1,2 +1,2 @@
 export declare const name: "eslint-plugin-svelte";
-export declare const version: "2.33.1";
+export declare const version: "2.34.0";

package/lib/meta.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = exports.name = void 0;
 exports.name = 'eslint-plugin-svelte';
-exports.version = '2.33.1';
+exports.version = '2.34.0';

package/lib/rules/no-ignored-unsubscribe.d.ts

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

package/lib/rules/no-ignored-unsubscribe.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-ignored-unsubscribe', {
+    meta: {
+        docs: {
+            description: 'disallow ignoring the unsubscribe method returned by the `subscribe()` on Svelte stores.',
+            category: 'Best Practices',
+            recommended: false
+        },
+        fixable: undefined,
+        hasSuggestions: false,
+        messages: {
+            forbidden: 'Ignoring returned value of the subscribe method is forbidden.'
+        },
+        schema: [],
+        type: 'problem'
+    },
+    create: (context) => {
+        return {
+            "ExpressionStatement > CallExpression > MemberExpression.callee[property.name='subscribe']": (node) => {
+                context.report({
+                    messageId: 'forbidden',
+                    node: node.property
+                });
+            }
+        };
+    }
+});

package/lib/rules/no-immutable-reactive-statements.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
+const ast_utils_1 = require("../utils/ast-utils");
 exports.default = (0, utils_1.createRule)('no-immutable-reactive-statements', {
     meta: {
         docs: {
@@ -77,29 +78,43 @@ exports.default = (0, utils_1.createRule)('no-immutable-reactive-statements', {
                         reference.identifier.range[1] <= defId.range[1])) {
                     return true;
                 }
-                if (isMutableMember(reference.identifier)) {
+                if (hasWriteMember(reference.identifier)) {
                     return true;
                 }
             }
             return false;
-            function isMutableMember(expr) {
-                if (expr.type === 'JSXIdentifier')
-                    return false;
-                const parent = expr.parent;
-                if (parent.type === 'AssignmentExpression') {
-                    return parent.left === expr;
-                }
-                if (parent.type === 'UpdateExpression') {
-                    return parent.argument === expr;
-                }
-                if (parent.type === 'UnaryExpression') {
-                    return parent.operator === 'delete' && parent.argument === expr;
-                }
-                if (parent.type === 'MemberExpression') {
-                    return parent.object === expr && isMutableMember(parent);
-                }
+        }
+        function hasWriteMember(expr) {
+            if (expr.type === 'JSXIdentifier')
                 return false;
+            const parent = expr.parent;
+            if (parent.type === 'AssignmentExpression') {
+                return parent.left === expr;
+            }
+            if (parent.type === 'UpdateExpression') {
+                return parent.argument === expr;
+            }
+            if (parent.type === 'UnaryExpression') {
+                return parent.operator === 'delete' && parent.argument === expr;
             }
+            if (parent.type === 'MemberExpression') {
+                return parent.object === expr && hasWriteMember(parent);
+            }
+            if (parent.type === 'SvelteDirective') {
+                return parent.kind === 'Binding' && parent.expression === expr;
+            }
+            if (parent.type === 'SvelteEachBlock') {
+                return parent.expression === expr && hasWriteReference(parent.context);
+            }
+            return false;
+        }
+        function hasWriteReference(pattern) {
+            for (const id of (0, ast_utils_1.iterateIdentifiers)(pattern)) {
+                const variable = (0, ast_utils_1.findVariable)(context, id);
+                if (variable && hasWrite(variable))
+                    return true;
+            }
+            return false;
         }
         function* iterateRangeReferences(scope, range) {
             for (const variable of scope.variables) {

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

@@ -30,6 +30,7 @@ export declare function findBindDirective<N extends string>(node: SvAST.SvelteEl
 export declare function getStaticAttributeValue(node: SvAST.SvelteAttribute): string | null;
 export declare function getLangValue(node: SvAST.SvelteScriptElement | SvAST.SvelteStyleElement): string | null;
 export declare function findVariable(context: RuleContext, node: TSESTree.Identifier): Variable | null;
+export declare function iterateIdentifiers(node: TSESTree.DestructuringPattern): Iterable<TSESTree.Identifier>;
 export declare function getScope(context: RuleContext, currentNode: TSESTree.Node): Scope;
 export declare function getParent(node: TSESTree.Node): TSESTree.Node | null;
 export type QuoteAndRange = {

package/lib/utils/ast-utils.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExpressionIdentifier = exports.isVoidHtmlElement = exports.getNodeName = exports.getDirectiveName = exports.getAttributeKeyText = exports.getMustacheTokens = exports.getAttributeValueQuoteAndRange = exports.getParent = 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.isExpressionIdentifier = exports.isVoidHtmlElement = exports.getNodeName = exports.getDirectiveName = exports.getAttributeKeyText = exports.getMustacheTokens = exports.getAttributeValueQuoteAndRange = exports.getParent = exports.getScope = exports.iterateIdentifiers = 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-community/eslint-utils"));
 const void_elements_1 = __importDefault(require("./void-elements"));
 function equalTokens(left, right, sourceCode) {
@@ -178,6 +178,41 @@ function findVariable(context, node) {
     return eslintUtils.findVariable(initialScope, node.name.slice(1));
 }
 exports.findVariable = findVariable;
+function* iterateIdentifiers(node) {
+    const buffer = [node];
+    let pattern;
+    while ((pattern = buffer.shift())) {
+        if (pattern.type === 'Identifier') {
+            yield pattern;
+        }
+        else if (pattern.type === 'ArrayPattern') {
+            for (const element of pattern.elements) {
+                if (element) {
+                    buffer.push(element);
+                }
+            }
+        }
+        else if (pattern.type === 'ObjectPattern') {
+            for (const property of pattern.properties) {
+                if (property.type === 'Property') {
+                    buffer.push(property.value);
+                }
+                else if (property.type === 'RestElement') {
+                    buffer.push(property);
+                }
+            }
+        }
+        else if (pattern.type === 'AssignmentPattern') {
+            buffer.push(pattern.left);
+        }
+        else if (pattern.type === 'RestElement') {
+            buffer.push(pattern.argument);
+        }
+        else if (pattern.type === 'MemberExpression') {
+        }
+    }
+}
+exports.iterateIdentifiers = iterateIdentifiers;
 function getScope(context, currentNode) {
     const scopeManager = context.getSourceCode().scopeManager;
     let node = currentNode;

package/lib/utils/rules.js

@@ -29,6 +29,7 @@ const no_dupe_use_directives_1 = __importDefault(require("../rules/no-dupe-use-d
 const no_dynamic_slot_name_1 = __importDefault(require("../rules/no-dynamic-slot-name"));
 const no_export_load_in_svelte_module_in_kit_pages_1 = __importDefault(require("../rules/no-export-load-in-svelte-module-in-kit-pages"));
 const no_extra_reactive_curlies_1 = __importDefault(require("../rules/no-extra-reactive-curlies"));
+const no_ignored_unsubscribe_1 = __importDefault(require("../rules/no-ignored-unsubscribe"));
 const no_immutable_reactive_statements_1 = __importDefault(require("../rules/no-immutable-reactive-statements"));
 const no_inner_declarations_1 = __importDefault(require("../rules/no-inner-declarations"));
 const no_not_function_handler_1 = __importDefault(require("../rules/no-not-function-handler"));
@@ -89,6 +90,7 @@ exports.rules = [
     no_dynamic_slot_name_1.default,
     no_export_load_in_svelte_module_in_kit_pages_1.default,
     no_extra_reactive_curlies_1.default,
+    no_ignored_unsubscribe_1.default,
     no_immutable_reactive_statements_1.default,
     no_inner_declarations_1.default,
     no_not_function_handler_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.33.1",
+  "version": "2.34.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",