comply with eslint rules

meowbmw · meowbmw · commit 49e069152ebc · 2025-05-13T17:36:31.000+08:00
diff --git a/.c8rc.json b/.c8rc.json
@@ -1,13 +1,11 @@
 {
   "all": true,
-  "include": [
-    "dist/plugins/rules/**/*.js"
-  ],
+  "include": ["dist/plugins/rules/**/*.js"],
   "reporter": ["text", "html", "lcov"],
   "report-dir": "./coverage",
   "check-coverage": true,
   "branches": 95,
   "lines": 95,
   "functions": 95,
   "statements": 95
-}
+}
diff --git a/index.js b/index.js
@@ -1,5 +1,5 @@
-import perfPlugin from "./dist/plugins/perf-plugin.js";
-import asPlugin from "./dist/plugins/as-plugin.js";
+import perfPlugin from "./dist/plugins/perfPlugin.js";
+import asPlugin from "./dist/plugins/asPlugin.js";
 
 export default {
   rules: {
diff --git a/package.json b/package.json
@@ -1,6 +1,9 @@
 {
   "name": "assemblyscript-eslint-plugin",
   "version": "1.0.0",
+  "engines": {
+    "node": ">=16.6.0"
+  },
   "description": "Provides linting plugin for assemblyscript",
   "keywords": [
     "assemblyscript",
@@ -44,6 +47,7 @@
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.14.1",
     "@typescript-eslint/rule-tester": "^8.30.1",
+    "@typescript-eslint/utils": "^8.32.1",
     "c8": "^10.1.3",
     "cspell": "^9.0.1",
     "mocha": "^11.2.2",
diff --git a/plugins/asPlugin.ts b/plugins/asPlugin.ts
@@ -5,9 +5,9 @@
  * It detects patterns that are either not supported in AssemblyScript
  * or violate best practices specific to the language.
  */
-import dontOmitElse from "./rules/dont-omit-else.js";
-import noSpread from "./rules/no-spread.js";
-import noUnsupportedKeyword from "./rules/no-unsupported-keyword.js";
+import dontOmitElse from "./rules/dontOmitElse.js";
+import noSpread from "./rules/noSpread.js";
+import noUnsupportedKeyword from "./rules/noUnsupportedKeyword.js";
 
 export default {
   rules: {
diff --git a/plugins/perfPlugin.ts b/plugins/perfPlugin.ts
@@ -4,7 +4,7 @@
  * This plugin provides rules for detecting and fixing potential performance issues
  * in AssemblyScript code.
  */
-import arrayInitStyle from "./rules/array-init-style.js";
+import arrayInitStyle from "./rules/arrayInitStyle.js";
 
 export default {
   rules: {
diff --git a/plugins/rules/arrayInitStyle.ts b/plugins/rules/arrayInitStyle.ts
@@ -1,5 +1,5 @@
-import { ESLintUtils } from "@typescript-eslint/utils";
-import createRule from "../utils/create-rule.js";
+import { ESLintUtils, AST_NODE_TYPES } from "@typescript-eslint/utils";
+import createRule from "../utils/createRule.js";
 
 /**
  * Rule: Array Initializer
@@ -35,9 +35,9 @@ const arrayInitStyle: ESLintUtils.RuleModule<
       VariableDeclarator(node) {
         const typeAnnotation = node.id.typeAnnotation?.typeAnnotation;
         if (
-          typeAnnotation?.type === "TSArrayType" &&
-          typeAnnotation.elementType?.type === "TSTypeReference" &&
-          node.init?.type === "ArrayExpression" &&
+          typeAnnotation?.type === AST_NODE_TYPES.TSArrayType &&
+          typeAnnotation.elementType?.type === AST_NODE_TYPES.TSTypeReference &&
+          node.init?.type === AST_NODE_TYPES.ArrayExpression &&
           node.init.elements.length === 0
         ) {
           // Ensure node.init is not null before passing to fixer
diff --git a/plugins/rules/dontOmitElse.ts b/plugins/rules/dontOmitElse.ts
@@ -1,6 +1,6 @@
-import { TSESTree } from "@typescript-eslint/utils";
+import { TSESTree, AST_NODE_TYPES } from "@typescript-eslint/utils";
 import { RuleListener, RuleModule } from "@typescript-eslint/utils/ts-eslint";
-import createRule from "../utils/create-rule.js";
+import createRule from "../utils/createRule.js";
 
 /**
  * Rule: Dont Omit Else
@@ -10,6 +10,30 @@ import createRule from "../utils/create-rule.js";
  * GOOD
  * if (x) { } else { }
  */
+
+// Helper function to check if a node will lead to early exit
+function isEarlyExitStatement(node: TSESTree.Node): boolean {
+  // Return true if the node will lead to early exit
+  return (
+    node.type === AST_NODE_TYPES.ReturnStatement ||
+    node.type === AST_NODE_TYPES.ThrowStatement ||
+    node.type === AST_NODE_TYPES.BreakStatement ||
+    node.type === AST_NODE_TYPES.ContinueStatement
+  );
+}
+// Check if statement or block doesn't contain early exit statement
+function hasTerminatingStatement(node: TSESTree.Node) {
+  // Handle different statement types
+  if (node.type === AST_NODE_TYPES.BlockStatement) {
+    // For block statements, check the last statement in the block
+    const lastStatement = node.body.length > 0 ? node.body.at(-1) : null;
+    return lastStatement ? isEarlyExitStatement(lastStatement) : false;
+  } else {
+    // For single statements (no curly braces), check the statement directly
+    return isEarlyExitStatement(node);
+  }
+}
+
 const dontOmitElse: RuleModule<"omittedElse", [], unknown, RuleListener> =
   createRule({
     name: "dont-omit-else",
@@ -31,33 +55,12 @@ const dontOmitElse: RuleModule<"omittedElse", [], unknown, RuleListener> =
       function isElseIfChain(node: TSESTree.IfStatement) {
         const ancestors = context.sourceCode.getAncestors(node);
         const parent = ancestors.at(-1);
-        return parent?.type === "IfStatement" && parent.alternate === node;
-      }
-
-      // Helper function to check if a node will lead to early exit
-      function isEarlyExitStatement(node: TSESTree.Node): boolean {
-        // Return true if the node will lead to early exit
         return (
-          node.type === "ReturnStatement" ||
-          node.type === "ThrowStatement" ||
-          node.type === "BreakStatement" ||
-          node.type === "ContinueStatement"
+          parent?.type === AST_NODE_TYPES.IfStatement &&
+          parent.alternate === node
         );
       }
 
-      // Check if statement or block doesn't contain early exit statement
-      function hasTerminatingStatement(node: TSESTree.Node) {
-        // Handle different statement types
-        if (node.type === "BlockStatement") {
-          // For block statements, check the last statement in the block
-          const lastStatement = node.body.length > 0 ? node.body.at(-1) : null;
-          return lastStatement ? isEarlyExitStatement(lastStatement) : false;
-        } else {
-          // For single statements (no curly braces), check the statement directly
-          return isEarlyExitStatement(node);
-        }
-      }
-
       return {
         IfStatement(node) {
           // Skip if this is already an else-if
diff --git a/plugins/rules/noSpread.ts b/plugins/rules/noSpread.ts
@@ -1,5 +1,5 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-import createRule from "../utils/create-rule.js";
+import createRule from "../utils/createRule.js";
 
 /**
  * Rule: No Spread
diff --git a/plugins/rules/noUnsupportedKeyword.ts b/plugins/rules/noUnsupportedKeyword.ts
@@ -1,5 +1,5 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-import createRule from "../utils/create-rule.js";
+import createRule from "../utils/createRule.js";
 
 /**
  * Rule: No Unsupported Keywords
diff --git a/plugins/utils/createRule.ts b/plugins/utils/createRule.ts
diff --git a/tests/asPlugin.test.ts b/tests/asPlugin.test.ts
@@ -3,13 +3,15 @@
  *
  * This file imports and runs individual rule tests from the rules directory.
  */
-import { describe } from "mocha";
+import { describe, it } from "mocha";
 
 // Import individual rule tests to run them as part of the test suite
-import "./rules/dont-omit-else.test.js";
-import "./rules/no-spread.test.js";
-import "./rules/no-unsupported-keyword.test.js";
+import "./rules/dontOmitElse.test.js";
+import "./rules/noSpread.test.js";
+import "./rules/noUnsupportedKeyword.test.js";
+import "./rules/arrayInitStyle.test.js";
 
 describe("AssemblyScript ESLint Plugin", () => {
   // Test suite is composed of individual rule tests imported above
+  it("loads all rule tests successfully", () => {});
 });
diff --git a/tests/perfPlugin.test.ts b/tests/perfPlugin.test.ts
@@ -6,8 +6,9 @@
 import { describe } from "mocha";
 
 // Import individual rule tests to run them as part of the test suite
-import "./rules/array-init-style.test.js";
+import "./rules/arrayInitStyle.test.js";
 
 describe("AssemblyScript Performance ESLint Plugin", () => {
   // Test suite is composed of individual rule tests imported above
+  it("loads all rule tests successfully", () => {});
 });
diff --git a/tests/rules/arrayInitStyle.test.ts b/tests/rules/arrayInitStyle.test.ts
@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import { createRuleTester } from "../utils/test-utils.js";
-import arrayInitStyle from "../../plugins/rules/array-init-style.js";
+import { createRuleTester } from "../utils/testUtils.js";
+import arrayInitStyle from "../../plugins/rules/arrayInitStyle.js";
 
 describe("Rule: array-init-style", () => {
   const ruleTester = createRuleTester();
diff --git a/tests/rules/dontOmitElse.test.ts b/tests/rules/dontOmitElse.test.ts
@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import { createRuleTester } from "../utils/test-utils.js";
-import dontOmitElse from "../../plugins/rules/dont-omit-else.js";
+import { createRuleTester } from "../utils/testUtils.js";
+import dontOmitElse from "../../plugins/rules/dontOmitElse.js";
 
 describe("Rule: dont-omit-else", () => {
   const ruleTester = createRuleTester();
diff --git a/tests/rules/noSpread.test.ts b/tests/rules/noSpread.test.ts
@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import { createRuleTester } from "../utils/test-utils.js";
-import noSpread from "../../plugins/rules/no-spread.js";
+import { createRuleTester } from "../utils/testUtils.js";
+import noSpread from "../../plugins/rules/noSpread.js";
 
 describe("Rule: no-spread", () => {
   const ruleTester = createRuleTester();
diff --git a/tests/rules/noUnsupportedKeyword.test.ts b/tests/rules/noUnsupportedKeyword.test.ts
@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import { createRuleTester } from "../utils/test-utils.js";
-import noUnsupportedKeyword from "../../plugins/rules/no-unsupported-keyword.js";
+import { createRuleTester } from "../utils/testUtils.js";
+import noUnsupportedKeyword from "../../plugins/rules/noUnsupportedKeyword.js";
 
 describe("Rule: no-unsupported-keyword", () => {
   const ruleTester = createRuleTester();
diff --git a/tests/utils/testUtils.ts b/tests/utils/testUtils.ts
