eslint-plugin-svelte 2.7.0 → 2.8.0

package/README.md

@@ -303,6 +303,7 @@ These rules relate to style guidelines, and are therefore quite subjective:
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
+| [svelte/derived-has-same-inputs-outputs](https://ota-meshi.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://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: |

package/lib/rules/derived-has-same-inputs-outputs.d.ts

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

package/lib/rules/derived-has-same-inputs-outputs.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const svelte_store_1 = require("./reference-helpers/svelte-store");
+exports.default = (0, utils_1.createRule)("derived-has-same-inputs-outputs", {
+    meta: {
+        docs: {
+            description: "derived store should use same variable names between values and callback",
+            category: "Stylistic Issues",
+            recommended: false,
+            conflictWithPrettier: false,
+        },
+        schema: [],
+        messages: {
+            unexpected: "The argument name should be '{{name}}'.",
+        },
+        type: "suggestion",
+    },
+    create(context) {
+        function isIdentifierOrArrayExpression(node) {
+            return ["Identifier", "ArrayExpression"].includes(node.type);
+        }
+        function isFunctionExpression(node) {
+            return ["ArrowFunctionExpression", "FunctionExpression"].includes(node.type);
+        }
+        function checkIdentifier(context, args, fn) {
+            const fnParam = fn.params[0];
+            if (fnParam.type !== "Identifier")
+                return;
+            const expectedName = `$${args.name}`;
+            if (expectedName !== fnParam.name) {
+                context.report({
+                    node: fn,
+                    loc: fnParam.loc,
+                    messageId: "unexpected",
+                    data: { name: expectedName },
+                });
+            }
+        }
+        function checkArrayExpression(context, args, fn) {
+            const fnParam = fn.params[0];
+            if (fnParam.type !== "ArrayPattern")
+                return;
+            const argNames = args.elements.map((element) => {
+                return element && element.type === "Identifier" ? element.name : null;
+            });
+            fnParam.elements.forEach((element, index) => {
+                const argName = argNames[index];
+                if (element && element.type === "Identifier" && argName) {
+                    const expectedName = `$${argName}`;
+                    if (expectedName !== element.name) {
+                        context.report({
+                            node: fn,
+                            loc: element.loc,
+                            messageId: "unexpected",
+                            data: { name: expectedName },
+                        });
+                    }
+                }
+            });
+        }
+        return {
+            Program() {
+                for (const { node } of (0, svelte_store_1.extractStoreReferences)(context, ["derived"])) {
+                    const [args, fn] = node.arguments;
+                    if (!args || !isIdentifierOrArrayExpression(args))
+                        continue;
+                    if (!fn || !isFunctionExpression(fn))
+                        continue;
+                    if (!fn.params || fn.params.length === 0)
+                        continue;
+                    if (args.type === "Identifier")
+                        checkIdentifier(context, args, fn);
+                    else
+                        checkArrayExpression(context, args, fn);
+                }
+            },
+        };
+    },
+});

package/lib/rules/no-store-async.js

@@ -27,7 +27,7 @@ exports.default = (0, utils_1.createRule)("no-store-async", {
                         !fn.async) {
                         continue;
                     }
-                    const start = fn.loc?.start ?? { line: 1, column: 0 };
+                    const start = fn.loc.start;
                     context.report({
                         node: fn,
                         loc: {

package/lib/rules/reference-helpers/svelte-store.d.ts

@@ -1,6 +1,8 @@
 import type * as ESTree from "estree";
 import type { RuleContext } from "../../types";
-export declare function extractStoreReferences(context: RuleContext): Generator<{
+declare type StoreName = "writable" | "readable" | "derived";
+export declare function extractStoreReferences(context: RuleContext, storeNames?: StoreName[]): Generator<{
     node: ESTree.CallExpression;
     name: string;
 }, void>;
+export {};

package/lib/rules/reference-helpers/svelte-store.js

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractStoreReferences = void 0;
 const eslint_utils_1 = require("eslint-utils");
-function* extractStoreReferences(context) {
+function* extractStoreReferences(context, storeNames = ["writable", "readable", "derived"]) {
     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,
+                [eslint_utils_1.ReferenceTracker.CALL]: storeNames.includes("writable"),
             },
             readable: {
-                [eslint_utils_1.ReferenceTracker.CALL]: true,
+                [eslint_utils_1.ReferenceTracker.CALL]: storeNames.includes("readable"),
             },
             derived: {
-                [eslint_utils_1.ReferenceTracker.CALL]: true,
+                [eslint_utils_1.ReferenceTracker.CALL]: storeNames.includes("derived"),
             },
         },
     })) {

package/lib/utils/rules.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.rules = void 0;
 const button_has_type_1 = __importDefault(require("../rules/button-has-type"));
 const comment_directive_1 = __importDefault(require("../rules/comment-directive"));
+const derived_has_same_inputs_outputs_1 = __importDefault(require("../rules/derived-has-same-inputs-outputs"));
 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"));
@@ -45,6 +46,7 @@ const valid_compile_1 = __importDefault(require("../rules/valid-compile"));
 exports.rules = [
     button_has_type_1.default,
     comment_directive_1.default,
+    derived_has_same_inputs_outputs_1.default,
     first_attribute_linebreak_1.default,
     html_closing_bracket_spacing_1.default,
     html_quotes_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.7.0",
+  "version": "2.8.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",
@@ -35,6 +35,7 @@
     "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 --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 .",
@@ -87,10 +88,10 @@
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.2",
     "@fontsource/fira-mono": "^4.5.0",
-    "@ota-meshi/eslint-plugin": "^0.11.3",
+    "@ota-meshi/eslint-plugin": "^0.12.0",
     "@sindresorhus/slugify": "^2.1.0",
-    "@sveltejs/adapter-static": "^1.0.0-next.26",
-    "@sveltejs/kit": "^1.0.0-next.406",
+    "@sveltejs/adapter-static": "^1.0.0-next.40",
+    "@sveltejs/kit": "^1.0.0-next.456",
     "@types/babel__core": "^7.1.19",
     "@types/cross-spawn": "^6.0.2",
     "@types/escape-html": "^1.0.2",
@@ -161,10 +162,10 @@
     "svelte-adapter-ghpages": "0.0.2",
     "type-coverage": "^2.22.0",
     "typescript": "^4.5.2",
-    "vite": "^3.0.0-0",
+    "vite": "^3.1.0-0",
     "vite-plugin-svelte-md": "^0.1.5",
     "yaml": "^2.1.1",
-    "yarn-deduplicate": "^5.0.0"
+    "yarn-deduplicate": "^6.0.0"
   },
   "publishConfig": {
     "access": "public"