eslint-plugin-svelte 2.6.0 → 2.7.0

package/README.md

@@ -269,6 +269,7 @@ These rules relate to possible syntax or logic errors in Svelte code:
 | [svelte/no-not-function-handler](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-not-function-handler/) | disallow use of not function in event handler | :star: |
 | [svelte/no-object-in-text-mustaches](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-object-in-text-mustaches/) | disallow objects in text mustache interpolation | :star: |
 | [svelte/no-shorthand-style-property-overrides](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-shorthand-style-property-overrides/) | disallow shorthand style properties that override related longhand properties | :star: |
+| [svelte/no-store-async](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-store-async/) | disallow using async/await inside svelte stores because it causes issues with the auto-unsubscribing features |  |
 | [svelte/no-unknown-style-directive-property](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-unknown-style-directive-property/) | disallow unknown `style:property` | :star: |
 | [svelte/valid-compile](https://ota-meshi.github.io/eslint-plugin-svelte/rules/valid-compile/) | disallow warnings when compiling. | :star: |
 
@@ -325,6 +326,7 @@ These rules extend the rules provided by ESLint itself to work well in Svelte:
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [svelte/no-inner-declarations](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-inner-declarations/) | disallow variable or `function` declarations in nested blocks | :star: |
+| [svelte/no-trailing-spaces](https://ota-meshi.github.io/eslint-plugin-svelte/rules/no-trailing-spaces/) | disallow trailing whitespace at the end of lines | :wrench: |
 
 ## System
 
@@ -347,43 +349,7 @@ Welcome contributing!
 
 Please use GitHub's Issues/PRs.
 
-### Development Tools
-
-- `yarn test` runs tests.
-- `yarn cover` runs tests and measures coverage.
-- `yarn new [new-rule-name]` generate the files needed to implement the new rule.
-- `yarn update` runs in order to update readme and recommended configuration.
-- `yarn docs:watch` launch the document site in development mode.
-
-### Test the Rule
-
-Rule testing almost always uses fixtures.  
-For example, for an `indent` rule, the `.ts` file that runs the test is `tests/src/rules/indent.ts` and the fixture is in `tests/fixtures/rules/indent`.  
-The fixture directory has an `invalid` directory and a `valid` directory.
-
-- The `invalid` directory contains test cases where the rule reports problems.
-- The `valid` directory contains test cases where the rule does not report a problem.
-
-The fixture input file should be named `*-input.svelte`. It is automatically collected and tested.  
-If your test requires configuration, you need to add a json file with the configuration.
-
-- If you want to apply a configuration to `my-test-input.svelte`, add `my-test-config.json`.
-- If you want to apply the same configuration to all the fixtures in that directory, add `_config.json`.
-
-To verify the output of invalid test cases requires `*-errors.json`, and `*-output.svelte` (for auto-fix). However, you don't have to add them yourself. If they do not exist, they will be automatically generated when you run the test. In other words, delete them manually when you want to recreate them.
-
-**Tips**:
-
-If you want to test only one rule, run the following command (for `indent` rule):
-
-```sh
-yarn test -g indent
-```
-
-Take <https://stackoverflow.com/questions/10832031/how-to-run-a-single-test-with-mocha> as reference for details.
-
-If you want to test only `my-test-input.svelte`, add `my-test-config.json` and save `{"only": true}`.  
-(Note that `{"only": true}` must be removed before making a pull request.)
+See also [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ### Working With Rules
 

package/lib/configs/prettier.d.ts

@@ -9,6 +9,7 @@ declare const _default: {
         "svelte/max-attributes-per-line": string;
         "svelte/mustache-spacing": string;
         "svelte/no-spaces-around-equal-signs-in-attribute": string;
+        "svelte/no-trailing-spaces": string;
         "svelte/shorthand-attribute": string;
         "svelte/shorthand-directive": string;
     };

package/lib/configs/prettier.js

@@ -16,6 +16,7 @@ module.exports = {
         "svelte/max-attributes-per-line": "off",
         "svelte/mustache-spacing": "off",
         "svelte/no-spaces-around-equal-signs-in-attribute": "off",
+        "svelte/no-trailing-spaces": "off",
         "svelte/shorthand-attribute": "off",
         "svelte/shorthand-directive": "off",
     },

package/lib/index.d.ts

@@ -44,6 +44,7 @@ declare const _default: {
                 "svelte/max-attributes-per-line": string;
                 "svelte/mustache-spacing": string;
                 "svelte/no-spaces-around-equal-signs-in-attribute": string;
+                "svelte/no-trailing-spaces": string;
                 "svelte/shorthand-attribute": string;
                 "svelte/shorthand-directive": string;
             };

package/lib/rules/no-store-async.d.ts

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

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

@@ -0,0 +1,46 @@
+"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)("no-store-async", {
+    meta: {
+        docs: {
+            description: "disallow using async/await inside svelte stores because it causes issues with the auto-unsubscribing features",
+            category: "Possible Errors",
+            recommended: false,
+            default: "error",
+        },
+        schema: [],
+        messages: {
+            unexpected: "Do not pass async functions to svelte stores.",
+        },
+        type: "problem",
+    },
+    create(context) {
+        return {
+            Program() {
+                for (const { node } of (0, svelte_store_1.extractStoreReferences)(context)) {
+                    const [, fn] = node.arguments;
+                    if (!fn ||
+                        (fn.type !== "ArrowFunctionExpression" &&
+                            fn.type !== "FunctionExpression") ||
+                        !fn.async) {
+                        continue;
+                    }
+                    const start = fn.loc?.start ?? { line: 1, column: 0 };
+                    context.report({
+                        node: fn,
+                        loc: {
+                            start,
+                            end: {
+                                line: start.line,
+                                column: start.column + 5,
+                            },
+                        },
+                        messageId: "unexpected",
+                    });
+                }
+            },
+        };
+    },
+});

package/lib/rules/no-trailing-spaces.d.ts

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

package/lib/rules/no-trailing-spaces.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+exports.default = (0, utils_1.createRule)("no-trailing-spaces", {
+    meta: {
+        type: "layout",
+        docs: {
+            description: "disallow trailing whitespace at the end of lines",
+            category: "Extension Rules",
+            recommended: false,
+            extensionRule: "no-trailing-spaces",
+            conflictWithPrettier: true,
+        },
+        fixable: "whitespace",
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    skipBlankLines: { type: "boolean" },
+                    ignoreComments: { type: "boolean" },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            trailingSpace: "Trailing spaces not allowed.",
+        },
+    },
+    create(context) {
+        const options = context.options[0];
+        const skipBlankLines = options?.skipBlankLines || false;
+        const ignoreComments = options?.ignoreComments || false;
+        const sourceCode = context.getSourceCode();
+        const ignoreLineNumbers = new Set();
+        if (ignoreComments) {
+            for (const { type, loc } of sourceCode.getAllComments()) {
+                const endLine = type === "Block" ? loc.end.line - 1 : loc.end.line;
+                for (let i = loc.start.line; i <= endLine; i++) {
+                    ignoreLineNumbers.add(i);
+                }
+            }
+        }
+        function report(loc) {
+            context.report({
+                loc,
+                messageId: "trailingSpace",
+                fix(fixer) {
+                    return fixer.removeRange([
+                        sourceCode.getIndexFromLoc(loc.start),
+                        sourceCode.getIndexFromLoc(loc.end),
+                    ]);
+                },
+            });
+        }
+        function collectIgnoreLineNumbers({ loc }) {
+            const endLine = loc.end.line - 1;
+            for (let i = loc.start.line; i <= endLine; i++) {
+                ignoreLineNumbers.add(i);
+            }
+        }
+        return {
+            TemplateElement: collectIgnoreLineNumbers,
+            ...(ignoreComments
+                ? {
+                    SvelteHTMLComment: collectIgnoreLineNumbers,
+                }
+                : {}),
+            "Program:exit"() {
+                const lines = sourceCode.lines;
+                for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+                    const line = lines[lineIndex];
+                    if (skipBlankLines && !line.trim()) {
+                        continue;
+                    }
+                    const lineNumber = lineIndex + 1;
+                    if (ignoreLineNumbers.has(lineNumber)) {
+                        continue;
+                    }
+                    const trimmed = line.trimEnd();
+                    if (trimmed === line) {
+                        continue;
+                    }
+                    report({
+                        start: { line: lineNumber, column: trimmed.length },
+                        end: { line: lineNumber, column: line.length },
+                    });
+                }
+            },
+        };
+    },
+});

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

@@ -0,0 +1,6 @@
+import type * as ESTree from "estree";
+import type { RuleContext } from "../../types";
+export declare function extractStoreReferences(context: RuleContext): Generator<{
+    node: ESTree.CallExpression;
+    name: string;
+}, void>;

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

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractStoreReferences = void 0;
+const eslint_utils_1 = require("eslint-utils");
+function* extractStoreReferences(context) {
+    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],
+        };
+    }
+}
+exports.extractStoreReferences = extractStoreReferences;

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const eslint_utils_1 = require("eslint-utils");
+const svelte_store_1 = require("./reference-helpers/svelte-store");
 exports.default = (0, utils_1.createRule)("require-stores-init", {
     meta: {
         docs: {
@@ -16,31 +16,9 @@ exports.default = (0, utils_1.createRule)("require-stores-init", {
         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()) {
+                for (const { node, name } of (0, svelte_store_1.extractStoreReferences)(context)) {
                     const minArgs = name === "writable" || name === "readable"
                         ? 1
                         : name === "derived"

package/lib/utils/rules.js

@@ -26,7 +26,9 @@ const no_reactive_functions_1 = __importDefault(require("../rules/no-reactive-fu
 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"));
+const no_store_async_1 = __importDefault(require("../rules/no-store-async"));
 const no_target_blank_1 = __importDefault(require("../rules/no-target-blank"));
+const no_trailing_spaces_1 = __importDefault(require("../rules/no-trailing-spaces"));
 const no_unknown_style_directive_property_1 = __importDefault(require("../rules/no-unknown-style-directive-property"));
 const no_unused_svelte_ignore_1 = __importDefault(require("../rules/no-unused-svelte-ignore"));
 const no_useless_mustaches_1 = __importDefault(require("../rules/no-useless-mustaches"));
@@ -63,7 +65,9 @@ exports.rules = [
     no_reactive_literals_1.default,
     no_shorthand_style_property_overrides_1.default,
     no_spaces_around_equal_signs_in_attribute_1.default,
+    no_store_async_1.default,
     no_target_blank_1.default,
+    no_trailing_spaces_1.default,
     no_unknown_style_directive_property_1.default,
     no_unused_svelte_ignore_1.default,
     no_useless_mustaches_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "2.6.0",
+  "version": "2.7.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",
@@ -44,15 +44,15 @@
     "prebuild": "yarn clean",
     "prepare": "simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0",
     "prerelease": "yarn clean && yarn build",
-    "pretest": "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": "cross-env DEBUG=eslint-plugin-svelte* yarn test",
+    "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 && git add ."
+    "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",
@@ -90,7 +90,7 @@
     "@ota-meshi/eslint-plugin": "^0.11.3",
     "@sindresorhus/slugify": "^2.1.0",
     "@sveltejs/adapter-static": "^1.0.0-next.26",
-    "@sveltejs/kit": "^1.0.0-next.360",
+    "@sveltejs/kit": "^1.0.0-next.406",
     "@types/babel__core": "^7.1.19",
     "@types/cross-spawn": "^6.0.2",
     "@types/escape-html": "^1.0.2",
@@ -113,7 +113,6 @@
     "@typescript-eslint/parser-v4": "npm:@typescript-eslint/parser@4",
     "assert": "^2.0.0",
     "commitlint": "^17.0.3",
-    "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.15.0",
     "esbuild-register": "^3.2.0",
@@ -148,7 +147,7 @@
     "pako": "^2.0.3",
     "postcss-nested": "^5.0.6",
     "prettier": "^2.2.1",
-    "prettier-plugin-pkg": "^0.16.0",
+    "prettier-plugin-pkg": "^0.17.0",
     "prettier-plugin-svelte": "^2.6.0",
     "prism-svelte": "^0.5.0",
     "prismjs": "^1.25.0",
@@ -156,7 +155,7 @@
     "semver": "^7.3.5",
     "simple-git-hooks": "^2.8.0",
     "stylelint": "^14.0.0",
-    "stylelint-config-standard": "^27.0.0",
+    "stylelint-config-standard": "^28.0.0",
     "stylus": "^0.59.0",
     "svelte": "^3.46.1",
     "svelte-adapter-ghpages": "0.0.2",
@@ -171,7 +170,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 98.63,
+    "atLeast": 98.64,
     "cache": true,
     "detail": true,
     "ignoreAsAssertion": true,