eslint-plugin-svelte 2.27.4 → 2.29.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.29.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.29.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.29.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",
@@ -10,7 +10,7 @@
   ],
   "funding": "https://github.com/sponsors/ota-meshi",
   "license": "MIT",
-  "packageManager": "yarn@1.22.19",
+  "packageManager": "pnpm@7.32.4",
   "engines": {
     "node": "^14.17.0 || >=16.0.0"
   },
@@ -25,36 +25,6 @@
     "svelte",
     "sveltejs"
   ],
-  "scripts": {
-    "build": "yarn build: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",
-    "debug": "yarn mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
-    "docs:build": "yarn svelte-kit build",
-    "docs:preview": "yarn svelte-kit preview",
-    "docs:watch": "yarn svelte-kit dev",
-    "format-for-gen-file": "eslint src/types-for-node.ts src/utils/rules.ts src/configs typings/estree/index.d.ts --fix",
-    "install-with-ignore-engines": "yarn --ignore-engines",
-    "lint": "run-p lint:*",
-    "lint-fix": "yarn lint:es --fix && yarn lint:style --fix",
-    "lint:es": "eslint --cache -f friendly .",
-    "lint:style": "stylelint --cache .",
-    "mocha": "yarn ts ./node_modules/mocha/bin/mocha.js",
-    "new": "yarn ts ./tools/new-rule.ts",
-    "prebuild": "yarn clean",
-    "prepare": "simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0",
-    "prerelease": "yarn clean && yarn build",
-    "release": "changeset publish",
-    "svelte-kit": "node --experimental-loader ./svelte-kit-import-hook.mjs node_modules/vite/bin/vite.js",
-    "test": "yarn mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
-    "test:debug": "env-cmd -e debug yarn test",
-    "ts": "node -r esbuild-register",
-    "typecov": "type-coverage",
-    "update": "yarn ts ./tools/update.ts && yarn format-for-gen-file",
-    "version": "env-cmd -e version yarn update",
-    "version:ci": "env-cmd -e version-ci yarn update && changeset version"
-  },
   "peerDependencies": {
     "eslint": "^7.0.0 || ^8.0.0-0",
     "svelte": "^3.37.0"
@@ -73,14 +43,10 @@
     "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.29.0"
   },
   "devDependencies": {
     "@1stg/browserslist-config": "^1.2.3",
-    "@1stg/commitlint-config": "^3.1.4",
-    "@1stg/lint-staged": "^3.3.0",
-    "@1stg/remark-config": "^4.0.3",
-    "@1stg/simple-git-hooks": "^0.2.1",
     "@1stg/stylelint-config": "^5.0.0",
     "@babel/core": "^7.16.0",
     "@babel/eslint-parser": "^7.17.0",
@@ -88,11 +54,12 @@
     "@babel/types": "^7.16.0",
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.2",
-    "@fontsource/fira-mono": "^4.5.0",
+    "@changesets/get-release-plan": "^3.0.16",
+    "@fontsource/fira-mono": "^5.0.0",
     "@ota-meshi/eslint-plugin": "^0.13.0",
     "@sindresorhus/slugify": "^2.1.0",
-    "@sveltejs/adapter-static": "^2.0.0",
-    "@sveltejs/kit": "^1.0.0",
+    "@sveltejs/adapter-static": "^2.0.2",
+    "@sveltejs/kit": "^1.16.3",
     "@types/babel__core": "^7.1.19",
     "@types/cross-spawn": "^6.0.2",
     "@types/escape-html": "^1.0.2",
@@ -101,6 +68,7 @@
     "@types/eslint-utils": "^3.0.1",
     "@types/eslint-visitor-keys": "^1.0.0",
     "@types/esutils": "^2.0.0",
+    "@types/json-schema": "^7.0.11",
     "@types/less": "^3.0.3",
     "@types/markdown-it": "^12.2.3",
     "@types/markdown-it-container": "^2.0.5",
@@ -110,18 +78,18 @@
     "@types/postcss-safe-parser": "^5.0.1",
     "@types/prismjs": "^1.26.0",
     "@types/stylus": "^0.48.38",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
-    "@typescript-eslint/parser-v4": "npm:@typescript-eslint/parser@4",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
     "@typescript/vfs": "^1.4.0",
+    "acorn": "^8.8.2",
     "assert": "^2.0.0",
-    "commitlint": "^17.0.3",
+    "cross-spawn": "^7.0.3",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.17.0",
     "esbuild-register": "^3.2.0",
     "escape-html": "^1.0.3",
-    "eslint": "^8.0.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-formatter-friendly": "^7.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",
@@ -130,15 +98,16 @@
     "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-prettier": "^4.0.0",
+    "eslint-plugin-node-dependencies": "^0.11.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-regexp": "^1.0.0",
-    "eslint-plugin-svelte": "^2.11.0",
+    "eslint-plugin-svelte": "^2.28.0",
     "eslint-plugin-yml": "^1.0.0",
     "eslint-scope": "^7.1.1",
+    "eslint-visitor-keys": "^3.4.1",
+    "espree": "^9.5.2",
     "estree-walker": "^3.0.0",
     "less": "^4.1.2",
-    "lint-staged": "^13.0.3",
     "locate-character": "^2.0.5",
     "magic-string": "^0.30.0",
     "markdown-it-anchor": "^8.4.1",
@@ -149,26 +118,28 @@
     "nyc": "^15.1.0",
     "pako": "^2.0.3",
     "postcss-nested": "^6.0.0",
-    "prettier": "^2.2.1",
-    "prettier-plugin-pkg": "^0.17.0",
-    "prettier-plugin-svelte": "^2.6.0",
+    "prettier": "^2.8.8",
+    "prettier-plugin-pkg": "^0.17.1",
+    "prettier-plugin-svelte": "^2.10.0",
     "prism-svelte": "^0.5.0",
     "prismjs": "^1.25.0",
+    "rimraf": "^5.0.0",
     "sass": "^1.51.0",
     "semver": "^7.3.5",
     "simple-git-hooks": "^2.8.0",
+    "source-map-js": "^1.0.2",
     "stylelint": "^15.0.0",
     "stylelint-config-standard": "^33.0.0",
     "stylus": "^0.59.0",
-    "svelte": "^3.46.1",
+    "svelte": "^3.59.1",
     "svelte-adapter-ghpages": "0.1.0",
     "svelte-i18n": "^3.4.0",
+    "tslib": "^2.5.0",
     "type-coverage": "^2.22.0",
     "typescript": "^5.0.0",
     "vite": "^4.0.0",
-    "vite-plugin-svelte-md": "^0.1.5",
-    "yaml": "^2.1.1",
-    "yarn-deduplicate": "^6.0.0"
+    "vite-plugin-svelte-md": "^0.1.7",
+    "yaml": "^2.1.1"
   },
   "publishConfig": {
     "access": "public"
@@ -183,5 +154,36 @@
     "showRelativePath": true,
     "strict": true,
     "update": true
+  },
+  "scripts": {
+    "build": "pnpm run build:meta && pnpm run build:ts",
+    "build:meta": "pnpm run 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 pnpm run test",
+    "debug": "pnpm run mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
+    "docs:build": "pnpm run svelte-kit build",
+    "docs:preview": "pnpm run svelte-kit preview",
+    "docs:watch": "pnpm run svelte-kit dev",
+    "format-for-gen-file": "eslint src/types-for-node.ts src/utils/rules.ts src/configs typings/estree/index.d.ts --fix",
+    "lint": "run-p lint:*",
+    "lint-fix": "pnpm run lint-fix:md \"./**/*.md\" && pnpm run lint:es --fix && pnpm run lint:style --fix",
+    "lint-fix:md": "prettier --cache --write \"./**/*.md\"",
+    "lint:md": "prettier --cache --check \"./**/*.md\"",
+    "lint:es": "eslint --cache .",
+    "lint:style": "stylelint --cache .",
+    "mocha": "pnpm run ts ./node_modules/mocha/bin/mocha.js",
+    "new": "pnpm run ts ./tools/new-rule.ts",
+    "prebuild": "pnpm run clean",
+    "prerelease": "pnpm run clean && pnpm run build",
+    "release": "changeset publish",
+    "svelte-kit": "node --experimental-loader ./svelte-kit-import-hook.mjs node_modules/vite/bin/vite.js",
+    "test": "pnpm run mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
+    "test:debug": "env-cmd -e debug pnpm run test",
+    "ts": "node -r esbuild-register",
+    "typecov": "type-coverage",
+    "update": "pnpm run ts ./tools/update.ts && pnpm run format-for-gen-file && pnpm run lint-fix:md",
+    "version": "env-cmd -e version pnpm run update",
+    "version:ci": "env-cmd -e version-ci pnpm run update && changeset version"
   }
-}
+}