eslint-plugin-svelte 2.27.4 → 2.28.0

package/README.md

@@ -346,9 +346,11 @@ These rules relate to better ways of doing things to help you avoid problems:
 | [svelte/no-unused-svelte-ignore](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-unused-svelte-ignore/) | disallow unused svelte-ignore comments | :star: |
 | [svelte/no-useless-mustaches](https://sveltejs.github.io/eslint-plugin-svelte/rules/no-useless-mustaches/) | disallow unnecessary mustache interpolations | :wrench: |
 | [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: |
+| [svelte/require-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-each-key/) | require keyed `{#each}` block |  |
 | [svelte/require-event-dispatcher-types](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-event-dispatcher-types/) | require type parameters for `createEventDispatcher` |  |
 | [svelte/require-optimized-style-attribute](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-optimized-style-attribute/) | require style attributes that can be optimized |  |
 | [svelte/require-stores-init](https://sveltejs.github.io/eslint-plugin-svelte/rules/require-stores-init/) | require initial value in store |  |
+| [svelte/valid-each-key](https://sveltejs.github.io/eslint-plugin-svelte/rules/valid-each-key/) | enforce keys to use variables defined in the `{#each}` block |  |
 
 ## Stylistic Issues
 

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import type { RuleModule } from "./types";
 import * as processor from "./processor";
 declare const _default: {
+    meta: typeof processor.meta;
     configs: {
         base: {
             plugins: string[];

package/lib/index.js

@@ -31,6 +31,7 @@ const recommended_1 = __importDefault(require("./configs/recommended"));
 const prettier_1 = __importDefault(require("./configs/prettier"));
 const all_1 = __importDefault(require("./configs/all"));
 const processor = __importStar(require("./processor"));
+const meta = __importStar(require("./meta"));
 const configs = {
     base: base_1.default,
     recommended: recommended_1.default,
@@ -42,6 +43,7 @@ const rules = rules_1.rules.reduce((obj, r) => {
     return obj;
 }, {});
 module.exports = {
+    meta,
     configs,
     rules,
     processors: {

package/lib/meta.d.ts

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

package/lib/meta.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = exports.name = void 0;
+exports.name = "eslint-plugin-svelte";
+exports.version = "2.28.0";

package/lib/processor/index.d.ts

@@ -1,4 +1,5 @@
 import type { Linter } from "eslint";
+export * as meta from "../meta";
 export declare function preprocess(code: string, filename: string): string[];
 export declare function postprocess([messages]: Linter.LintMessage[][], filename: string): Linter.LintMessage[];
 export declare const supportsAutofix = true;

package/lib/processor/index.js

@@ -1,7 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.supportsAutofix = exports.postprocess = exports.preprocess = void 0;
+exports.supportsAutofix = exports.postprocess = exports.preprocess = exports.meta = void 0;
 const shared_1 = require("../shared");
+exports.meta = __importStar(require("../meta"));
 function preprocess(code, filename) {
     if (filename) {
         (0, shared_1.beginShared)(filename);

package/lib/rules/require-each-key.d.ts

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

package/lib/rules/require-each-key.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+exports.default = (0, utils_1.createRule)("require-each-key", {
+    meta: {
+        docs: {
+            description: "require keyed `{#each}` block",
+            category: "Best Practices",
+            recommended: false,
+        },
+        schema: [],
+        messages: { expectedKey: "Each block should have a key" },
+        type: "suggestion",
+    },
+    create(context) {
+        return {
+            SvelteEachBlock(node) {
+                if (node.key == null) {
+                    context.report({
+                        node,
+                        messageId: "expectedKey",
+                    });
+                }
+            },
+        };
+    },
+});

package/lib/rules/valid-each-key.d.ts

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

package/lib/rules/valid-each-key.js

@@ -0,0 +1,47 @@
+"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)("valid-each-key", {
+    meta: {
+        docs: {
+            description: "enforce keys to use variables defined in the `{#each}` block",
+            category: "Best Practices",
+            recommended: false,
+        },
+        schema: [],
+        messages: {
+            keyUseEachVars: "Expected key to use the variables which are defined by the `{#each}` block.",
+        },
+        type: "suggestion",
+    },
+    create(context) {
+        return {
+            SvelteEachBlock(node) {
+                if (node.key == null) {
+                    return;
+                }
+                const scope = (0, ast_utils_1.getScope)(context, node.key);
+                for (const variable of scope.variables) {
+                    if (!variable.defs.some((def) => (node.context.range[0] <= def.name.range[0] &&
+                        def.name.range[1] <= node.context.range[1]) ||
+                        (node.index &&
+                            node.index.range[0] <= def.name.range[0] &&
+                            def.name.range[1] <= node.index.range[1]))) {
+                        continue;
+                    }
+                    for (const reference of variable.references) {
+                        if (node.key.range[0] <= reference.identifier.range[0] &&
+                            reference.identifier.range[1] <= node.key.range[1]) {
+                            return;
+                        }
+                    }
+                }
+                context.report({
+                    node: node.key,
+                    messageId: "keyUseEachVars",
+                });
+            },
+        };
+    },
+});

package/lib/utils/rules.js

@@ -47,6 +47,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_destructured_store_props_1 = __importDefault(require("../rules/prefer-destructured-store-props"));
 const prefer_style_directive_1 = __importDefault(require("../rules/prefer-style-directive"));
+const require_each_key_1 = __importDefault(require("../rules/require-each-key"));
 const require_event_dispatcher_types_1 = __importDefault(require("../rules/require-event-dispatcher-types"));
 const require_optimized_style_attribute_1 = __importDefault(require("../rules/require-optimized-style-attribute"));
 const require_store_callbacks_use_set_param_1 = __importDefault(require("../rules/require-store-callbacks-use-set-param"));
@@ -58,6 +59,7 @@ const sort_attributes_1 = __importDefault(require("../rules/sort-attributes"));
 const spaced_html_comment_1 = __importDefault(require("../rules/spaced-html-comment"));
 const system_1 = __importDefault(require("../rules/system"));
 const valid_compile_1 = __importDefault(require("../rules/valid-compile"));
+const valid_each_key_1 = __importDefault(require("../rules/valid-each-key"));
 const valid_prop_names_in_kit_pages_1 = __importDefault(require("../rules/valid-prop-names-in-kit-pages"));
 exports.rules = [
     no_unnecessary_condition_1.default,
@@ -103,6 +105,7 @@ exports.rules = [
     prefer_class_directive_1.default,
     prefer_destructured_store_props_1.default,
     prefer_style_directive_1.default,
+    require_each_key_1.default,
     require_event_dispatcher_types_1.default,
     require_optimized_style_attribute_1.default,
     require_store_callbacks_use_set_param_1.default,
@@ -114,5 +117,6 @@ exports.rules = [
     spaced_html_comment_1.default,
     system_1.default,
     valid_compile_1.default,
+    valid_each_key_1.default,
     valid_prop_names_in_kit_pages_1.default,
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.27.4",
+  "version": "2.28.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",
@@ -26,7 +26,8 @@
     "sveltejs"
   ],
   "scripts": {
-    "build": "yarn build:ts",
+    "build": "yarn build:meta && yarn build:ts",
+    "build:meta": "yarn ts ./tools/update-meta.ts",
     "build:ts": "tsc --project ./tsconfig.build.json",
     "clean": "rimraf .nyc_output lib coverage build .svelte-kit svelte.config-dist.js",
     "cover": "nyc --reporter=lcov yarn test",
@@ -73,7 +74,7 @@
     "postcss": "^8.4.5",
     "postcss-load-config": "^3.1.4",
     "postcss-safe-parser": "^6.0.0",
-    "svelte-eslint-parser": "^0.27.0"
+    "svelte-eslint-parser": "^0.28.0"
   },
   "devDependencies": {
     "@1stg/browserslist-config": "^1.2.3",
@@ -130,7 +131,7 @@
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-mdx": "^2.0.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-node-dependencies": "^0.10.0",
+    "eslint-plugin-node-dependencies": "^0.11.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-regexp": "^1.0.0",
     "eslint-plugin-svelte": "^2.11.0",