refactor(eslint): add eslint config

Author: codehz

bun.lock

@@ -0,0 +1,74 @@
+import tsPlugin from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import prettierPlugin from "eslint-plugin-prettier";
+
+/**
+ * ESLint flat config for the project.
+ * - TypeScript parser + plugin for typed linting
+ * - Prettier plugin to keep formatting enforced by ESLint
+ * - Basic overrides for test files and generated or output folders
+ */
+export default [
+  // ignore common build/artifact folders
+  {
+    ignores: ["dist/**", "build/**", "node_modules/**"],
+  },
+
+  // General JS/TS settings
+  {
+    files: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.cjs", "**/*.mjs"],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: ["./tsconfig.json"],
+        tsconfigRootDir: new URL(".", import.meta.url).pathname,
+        ecmaVersion: "latest",
+        sourceType: "module",
+      },
+      globals: {
+        // Bun testing / runtime globals (Bun provides `Bun` as global runtime)
+        Bun: "readonly",
+      },
+    },
+    // Plugins are loaded by name in the flat config as objects
+    plugins: {
+      "@typescript-eslint": tsPlugin,
+      prettier: prettierPlugin,
+    },
+    rules: {
+      // Prettier enforces formatting — run prettier as part of linting
+      "prettier/prettier": "error",
+
+      // Replace core ESLint `no-unused-vars` with TypeScript-aware rule
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+
+      // Type-only import enforcement for consistency
+      "@typescript-eslint/consistent-type-imports": "error",
+
+      // Allow some pragmatic leniency for lib code (disable if you want stricter checks)
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+    },
+  },
+
+  // Test files — bun.test uses describe/it/expect (similar to Jest), mark them as known
+  {
+    files: ["**/*.test.ts", "**/*.spec.ts"],
+    languageOptions: {
+      globals: {
+        describe: "readonly",
+        it: "readonly",
+        test: "readonly",
+        expect: "readonly",
+        beforeAll: "readonly",
+        afterAll: "readonly",
+      },
+    },
+    rules: {
+      // Tests often include non-null assertions and other patterns that are okay
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+    },
+  },
+];

eslint.config.mjs

@@ -17,7 +17,7 @@ const HealthId = component<Health>();
 class InputSystem implements System<[deltaTime: number]> {
   readonly dependencies: readonly System<[deltaTime: number]>[] = [];
 
-  update(deltaTime: number): void {
+  update(_deltaTime: number): void {
     console.log(`[InputSystem] Processing input at ${Date.now()}`);
     // 这里可以处理键盘/鼠标输入等
   }
@@ -54,7 +54,7 @@ class DamageSystem implements System<[deltaTime: number]> {
     this.query = world.createQuery([PositionId, HealthId]);
   }
 
-  update(deltaTime: number): void {
+  update(_deltaTime: number): void {
     console.log(`[DamageSystem] Applying damage based on position`);
 
     this.query.forEach([PositionId, HealthId], (entity, position, health) => {
@@ -76,7 +76,7 @@ class RenderSystem implements System<[deltaTime: number]> {
     this.query = world.createQuery([PositionId]);
   }
 
-  update(deltaTime: number): void {
+  update(_deltaTime: number): void {
     console.log(`[RenderSystem] Rendering entities`);
 
     this.query.forEach([PositionId], (entity, position) => {

examples/advanced-scheduling/demo.ts

@@ -4,6 +4,10 @@
   "type": "module",
   "devDependencies": {
     "@types/bun": "1.3.2",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-prettier": "^5.5.4",
     "husky": "^9.1.7",
     "lint-staged": "^16.2.6",
     "prettier": "^3.6.2",
@@ -14,14 +18,18 @@
     "test": "bun test",
     "demo": "bun run examples/simple/demo.ts",
     "release": "bun run scripts/release.ts",
-    "prepare": "husky"
+    "prepare": "husky",
+    "lint": "eslint --ext .ts,.tsx,.js --quiet",
+    "lint:fix": "eslint --ext .ts,.tsx,.js --fix",
+    "format": "prettier --write ."
   },
   "peerDependencies": {
     "typescript": "^5.9.3"
   },
   "lint-staged": {
     "*.{ts,tsx}": [
-      "prettier --write"
+      "prettier --write",
+      "eslint --fix"
     ],
     "*.{json,md}": [
       "prettier --write"

package.json

@@ -15,7 +15,7 @@ export async function build() {
 
   // 使用 Bun.build 构建所有入口点
   console.log("🔨 Building workflow library...");
-  const result = await tsdownBuild({
+  await tsdownBuild({
     entry: entrypoints,
     outDir: "dist",
     dts: true,

scripts/build.ts

@@ -115,7 +115,7 @@ describe("Archetype", () => {
     archetype.addEntity(entity2, new Map([[positionComponent, { x: 2, y: 2 }]]));
 
     const iteratedEntities: EntityId[] = [];
-    archetype.forEach((entityId, components) => {
+    archetype.forEach((entityId, _components) => {
       iteratedEntities.push(entityId);
     });
 
@@ -138,7 +138,6 @@ describe("Archetype", () => {
 
   it("should handle wildcard relations in forEachWithComponents", () => {
     // Create a relation component type: position relation from entity to entity
-    const positionRelation = relation(positionComponent, createEntityId(1026)); // Dummy target for type
     const wildcardPositionRelation = relation(positionComponent, "*");
 
     const entity1 = createEntityId(1024);

src/archetype.test.ts

@@ -288,9 +288,9 @@ describe("EntityIdManager", () => {
 
     it("should reuse IDs from freelist before allocating new ones", () => {
       const manager = new EntityIdManager();
-      const id1 = manager.allocate(); // 1024
+      manager.allocate(); // 1024
       const id2 = manager.allocate(); // 1025
-      const id3 = manager.allocate(); // 1026
+      manager.allocate(); // 1026
 
       manager.deallocate(id2);
       expect(manager.allocate()).toBe(id2); // Should reuse 1025

src/entity.test.ts

@@ -211,7 +211,8 @@ export function getIdType(
         case "wildcard":
           return "wildcard-relation";
       }
-    } catch (error) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (_error) {
       return "invalid"; // fallback for invalid relation IDs
     }
   }
@@ -274,7 +275,8 @@ export function getDetailedIdType(id: EntityId<any>):
         componentId: decoded.componentId,
         targetId: decoded.targetId as any,
       };
-    } catch (error) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (_error) {
       // Invalid relation ID
       return { type: "invalid" };
     }
@@ -317,7 +319,8 @@ export function inspectEntityId(id: EntityId<any>): string {
             ? `Component ID (${decoded.targetId})`
             : "Wildcard (*)";
       return `Relation ID: ${componentStr} -> ${targetStr}`;
-    } catch (error) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (_error) {
       return `Invalid Relation ID (${id})`;
     }
   }

src/entity.ts

@@ -1,4 +1,4 @@
-import { Archetype } from "./archetype";
+import type { Archetype } from "./archetype";
 import type { EntityId } from "./entity";
 import { getComponentIdFromRelationId, getDetailedIdType, isRelationId } from "./entity";
 

src/query-filter.ts

@@ -61,7 +61,7 @@ function performanceTest() {
   let totalTime = 0;
   for (let i = 0; i < iterations; i++) {
     const start = performance.now();
-    const entities = positionVelocityQuery.getEntitiesWithComponents([positionComponent, velocityComponent]);
+    positionVelocityQuery.getEntitiesWithComponents([positionComponent, velocityComponent]);
     const end = performance.now();
     totalTime += end - start;
   }
@@ -71,7 +71,7 @@ function performanceTest() {
   totalTime = 0;
   for (let i = 0; i < iterations; i++) {
     const start = performance.now();
-    positionVelocityQuery.forEach([positionComponent, velocityComponent], (entity, position, velocity) => {
+    positionVelocityQuery.forEach([positionComponent, velocityComponent], (_entity, _position, _velocity) => {
       // 空操作，只是为了测量遍历性能
     });
     const end = performance.now();