@yasainet/eslint 0.0.30 → 0.0.31

package/README.md

@@ -10,6 +10,34 @@ Shared ESLint configuration for Next.js, Node.js and Deno.
 | `@yasainet/eslint/node` | `scripts/features/`            | Common rules only (WIP) |
 | `@yasainet/eslint/deno` | `supabase/functions/features/` | Common rules only (WIP) |
 
+## Directory Structure
+
+```text
+src/
+├── common/   # Shared rules for all environments
+├── next/     # Next.js-specific rules (hooks, components, directives)
+├── node/     # Node.js entry point (common rules only)
+└── deno/     # Deno entry point (entry-point boundary, _utils boundary, _lib boundary)
+```
+
+Each entry point enforces a feature-based architecture with the following convention in consuming projects:
+
+```text
+{featureRoot}/
+├── {feature}/
+│   ├── actions/        # *.action.ts — entry points (handleXxx)
+│   ├── services/       # *.service.ts — business logic
+│   ├── repositories/   # *.repo.ts — data access
+│   ├── types/          # *.type.ts
+│   ├── schemas/        # *.schema.ts
+│   ├── utils/          # *.util.ts
+│   └── constants/      # *.constant.ts
+├── shared/             # Cross-feature shared modules
+├── ...
+{libRoot}/              # *.lib.ts — library wrappers (e.g., supabase.lib.ts)
+{utilsRoot}/            # *.util.ts — top-level utilities
+```
+
 ## Setup
 
 ### Next.js + Node.js + Deno

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yasainet/eslint",
-  "version": "0.0.30",
+  "version": "0.0.31",
   "description": "ESLint",
   "type": "module",
   "exports": {

package/src/common/index.mjs

@@ -2,7 +2,7 @@ import { generatePrefixLibMapping } from "./constants.mjs";
 import { createImportsConfigs } from "./imports.mjs";
 import { createJsdocConfigs } from "./jsdoc.mjs";
 import { createLayersConfigs } from "./layers.mjs";
-import { createLibNamingConfigs, createNamingConfigs } from "./naming.mjs";
+import { createLibNamingConfigs, createNamingConfigs, createUtilsNamingConfigs } from "./naming.mjs";
 import { rulesConfigs } from "./rules.mjs";
 
 /** Build common configs scoped to the given feature root. */
@@ -15,6 +15,7 @@ export function createCommonConfigs(
     ...rulesConfigs,
     ...createNamingConfigs(featureRoot, prefixLibMapping),
     ...createLibNamingConfigs(featureRoot),
+    ...createUtilsNamingConfigs(featureRoot),
     ...createLayersConfigs(featureRoot),
     ...createImportsConfigs(featureRoot, prefixLibMapping, { banAliasImports }),
     ...createJsdocConfigs(featureRoot),

package/src/common/naming.mjs

@@ -21,6 +21,25 @@ export function createLibNamingConfigs(featureRoot) {
   ];
 }
 
+/** Scope utils naming rules to the utils root derived from the given feature root. */
+export function createUtilsNamingConfigs(featureRoot) {
+  const utilsRoot = featureRoot.replace(/features$/, "utils");
+  return [
+    {
+      name: "naming/top-level-utils",
+      files: [`${utilsRoot}/**/*.ts`],
+      ignores: [`${utilsRoot}/**/*.type.ts`],
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": "*.util" },
+        ],
+      },
+    },
+  ];
+}
+
 /** Scope naming rules to the given feature root. */
 export function createNamingConfigs(featureRoot, prefixLibMapping) {
   const prefixes = Object.keys(prefixLibMapping);