@fluid-topics/ft-eslint 2.0.23 → 2.0.25

package/build/plugin.d.ts

@@ -12,6 +12,7 @@ declare const plugin: {
         "ft-css-variable-names": import("eslint").Rule.RuleModule;
         "custom-elements": import("eslint").Rule.RuleModule;
         "index-define-imports": import("eslint").Rule.RuleModule;
+        "lit-async-lifecycle": import("eslint").Rule.RuleModule;
     };
     configs: {
         recommended: {};

package/build/plugin.js

@@ -6,6 +6,7 @@ import { lowerCaseFtCssVariables } from "./rules/lower-case-ft-css-variables";
 import { ftCssVariableNames } from "./rules/ft-css-variable-names";
 import { customElementsRule } from "./rules/custom-elements";
 import { indexDefineImportRule } from "./rules/index-define-import";
+import { litAsyncLifecycleRule } from "./rules/lit-async-lifecycle";
 const plugin = {
     meta: {
         name: "eslint-plugin-fluid-topics",
@@ -20,6 +21,7 @@ const plugin = {
         "ft-css-variable-names": ftCssVariableNames,
         "custom-elements": customElementsRule,
         "index-define-imports": indexDefineImportRule,
+        "lit-async-lifecycle": litAsyncLifecycleRule,
     },
     configs: {
         recommended: {},
@@ -37,6 +39,7 @@ const flatConfigs = {
             "ft/number-property": "error",
             "ft/lower-case-ft-css-variables": "error",
             "ft/ft-css-variable-names": "error",
+            "ft/lit-async-lifecycle": "warn",
         },
     },
 };

package/build/rules/lit-async-lifecycle.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from "eslint";
+export declare const litAsyncLifecycleRule: Rule.RuleModule;

package/build/rules/lit-async-lifecycle.js

@@ -0,0 +1,63 @@
+const LIT_LIFECYCLE_METHODS = [
+    "willUpdate",
+    "willRender",
+    "updated",
+    "render",
+    "firstUpdated",
+    "update",
+];
+export const litAsyncLifecycleRule = {
+    meta: {
+        docs: {
+            description: "Warns when LIT lifecycle methods are marked as async, as LIT does not await them",
+            recommended: true,
+        },
+        fixable: "code",
+        hasSuggestions: false,
+        schema: [],
+        messages: {
+            asyncLifecycleMethod: "LIT lifecycle method '{{ methodName }}' should not be marked as async. LIT does not await this method, so any returned promise will be ignored.",
+        },
+    },
+    create(context) {
+        return {
+            "MethodDefinition": (node) => {
+                const tsMethod = node;
+                if (tsMethod.kind === "get" || tsMethod.kind === "set") {
+                    return;
+                }
+                const methodName = tsMethod.key.type === "Identifier"
+                    ? tsMethod.key.name
+                    : tsMethod.key.type === "Literal"
+                        ? String(tsMethod.key.value)
+                        : null;
+                if (!methodName || !LIT_LIFECYCLE_METHODS.includes(methodName)) {
+                    return;
+                }
+                const tsFunction = tsMethod.value;
+                if (tsFunction.async) {
+                    context.report({
+                        loc: tsMethod.loc,
+                        messageId: "asyncLifecycleMethod",
+                        data: {
+                            methodName,
+                        },
+                        fix: (fixer) => {
+                            var _a;
+                            const sourceCode = context.sourceCode;
+                            let token = sourceCode.getFirstToken(tsMethod);
+                            while (token && token.value !== "async") {
+                                token = sourceCode.getTokenAfter(token);
+                            }
+                            if (!token) {
+                                return null;
+                            }
+                            const blankTokenAfterAsync = sourceCode.getTokenAfter(token);
+                            return fixer.removeRange([token.range[0], (_a = blankTokenAfterAsync === null || blankTokenAfterAsync === void 0 ? void 0 : blankTokenAfterAsync.range[0]) !== null && _a !== void 0 ? _a : token.range[1]]);
+                        },
+                    });
+                }
+            },
+        };
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluid-topics/ft-eslint",
-    "version": "2.0.23",
+    "version": "2.0.25",
     "description": "ESlint rules for web components",
     "keywords": [
         "Lit"
@@ -21,5 +21,5 @@
     "dependencies": {
         "lit": "3.1.0"
     },
-    "gitHead": "e441ae21f5027730992e39b7dc728ac0f7b17dc0"
+    "gitHead": "f7582c9f28ac8fb59807834b4cbdcf09144478cf"
 }