@yasainet/eslint 0.0.3 → 0.0.4

package/README.md

@@ -8,34 +8,42 @@ Shared ESLint configuration for feature-based architecture.
 npm install -D @yasainet/eslint eslint
 ```
 
-## Usage
+## Entry Points
+
+| Entry                   | Feature Root                   | Description                                                                         |
+| ----------------------- | ------------------------------ | ----------------------------------------------------------------------------------- |
+| `@yasainet/eslint/next` | `src/features/`                | Common rules + Next.js-specific rules (hooks, components, directives, lib-boundary) |
+| `@yasainet/eslint/node` | `scripts/features/`            | Common rules only                                                                   |
+| `@yasainet/eslint/deno` | `supabase/functions/features/` | Common rules only                                                                   |
 
-### Next.js
+## Usage
 
 ```js
 // eslint.config.mjs
+import { eslintConfig as nextEslintConfig } from "@yasainet/eslint/next";
+import { eslintConfig as nodeEslintConfig } from "@yasainet/eslint/node";
+import { eslintConfig as denoEslintConfig } from "@yasainet/eslint/deno";
 import { defineConfig, globalIgnores } from "eslint/config";
 import nextVitals from "eslint-config-next/core-web-vitals";
 import nextTs from "eslint-config-next/typescript";
-import { eslintConfig } from "@yasainet/eslint/next";
 
 export default defineConfig([
   ...nextVitals,
   ...nextTs,
-  globalIgnores([".next/**", "out/**", "build/**", "next-env.d.ts"]),
-  ...eslintConfig,
+  // Override default ignores of eslint-config-next.
+  globalIgnores([
+    // Default ignores of eslint-config-next:
+    ".next/**",
+    "out/**",
+    "build/**",
+    "next-env.d.ts",
+  ]),
+  ...nextEslintConfig,
+  ...nodeEslintConfig,
+  ...denoEslintConfig,
 ]);
 ```
 
-### Node.js
-
-```js
-// eslint.config.mjs
-import { eslintConfig } from "@yasainet/eslint/node";
-
-export default eslintConfig;
-```
-
 ## Release
 
 1. Update `version` in `package.json`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yasainet/eslint",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "ESLint",
   "type": "module",
   "exports": {
@@ -11,6 +11,10 @@
     "./node": {
       "types": "./src/node/index.d.mts",
       "default": "./src/node/index.mjs"
+    },
+    "./deno": {
+      "types": "./src/deno/index.d.mts",
+      "default": "./src/deno/index.mjs"
     }
   },
   "files": [

package/src/common/constants.mjs

@@ -20,12 +20,6 @@ function findProjectRoot() {
 
 const PROJECT_ROOT = findProjectRoot();
 
-export const FEATURE_ROOTS = [
-  "src/features",
-  "scripts/features",
-  "supabase/functions/features",
-];
-
 const EXCLUDE_LIST = ["proxy.ts", "types"];
 
 function generatePrefixLibMapping() {
@@ -68,5 +62,6 @@ function generatePrefixLibMapping() {
 
 export const PREFIX_LIB_MAPPING = generatePrefixLibMapping();
 
-export const featuresGlob = (subpath) =>
-  FEATURE_ROOTS.map((root) => `${root}/${subpath}`);
+export const featuresGlob = (featureRoot, subpath) => [
+  `${featureRoot}/${subpath}`,
+];

package/src/common/imports.mjs

@@ -112,22 +112,26 @@ function makeConfig(name, files, ...patternArrays) {
   };
 }
 
-function generateImportConfigs() {
-  const configs = [];
-
-  configs.push({
+/** @description Next.js-only: restrict @/lib imports to repositories */
+export const libBoundaryConfigs = [
+  {
     name: "imports/lib-boundary",
     files: ["src/**/*.{ts,tsx}"],
     ignores: ["src/lib/**", "src/proxy.ts", "src/app/sitemap.ts"],
     rules: {
       "no-restricted-imports": ["error", { patterns: LIB_BOUNDARY_PATTERNS }],
     },
-  });
+  },
+];
+
+/** @description Scope import restriction rules to the given feature root */
+export function createImportsConfigs(featureRoot) {
+  const configs = [];
 
   configs.push(
     makeConfig(
       "repositories",
-      ["**/repositories/*.ts"],
+      [`${featureRoot}/**/repositories/*.ts`],
       LAYER_PATTERNS.repositories,
       LATERAL_PATTERNS.repositories,
     ),
@@ -139,7 +143,7 @@ function generateImportConfigs() {
     configs.push(
       makeConfig(
         `repositories/${prefix}`,
-        [`**/repositories/${prefix}.repo.ts`],
+        [`${featureRoot}/**/repositories/${prefix}.repo.ts`],
         LAYER_PATTERNS.repositories,
         LATERAL_PATTERNS.repositories,
         patterns,
@@ -150,7 +154,7 @@ function generateImportConfigs() {
   configs.push(
     makeConfig(
       "services",
-      ["**/services/*.ts"],
+      [`${featureRoot}/**/services/*.ts`],
       LAYER_PATTERNS.services,
       LATERAL_PATTERNS.services,
       LIB_BOUNDARY_PATTERNS,
@@ -160,7 +164,7 @@ function generateImportConfigs() {
   configs.push(
     makeConfig(
       "actions",
-      ["**/actions/*.ts"],
+      [`${featureRoot}/**/actions/*.ts`],
       LAYER_PATTERNS.actions,
       LATERAL_PATTERNS.actions,
       LIB_BOUNDARY_PATTERNS,
@@ -171,7 +175,7 @@ function generateImportConfigs() {
     configs.push(
       makeConfig(
         `actions/${prefix}`,
-        [`**/actions/${prefix}.action.ts`],
+        [`${featureRoot}/**/actions/${prefix}.action.ts`],
         LAYER_PATTERNS.actions,
         LATERAL_PATTERNS.actions,
         CARDINALITY_PATTERNS[prefix],
@@ -182,5 +186,3 @@ function generateImportConfigs() {
 
   return configs.filter(Boolean);
 }
-
-export const importsConfigs = generateImportConfigs();

package/src/common/index.mjs

@@ -1,13 +1,16 @@
-import { importsConfigs } from "./imports.mjs";
-import { jsdocConfigs } from "./jsdoc.mjs";
-import { layersConfigs } from "./layers.mjs";
-import { namingConfigs } from "./naming.mjs";
+import { createImportsConfigs } from "./imports.mjs";
+import { createJsdocConfigs } from "./jsdoc.mjs";
+import { createLayersConfigs } from "./layers.mjs";
+import { createNamingConfigs } from "./naming.mjs";
 import { rulesConfigs } from "./rules.mjs";
 
-export const commonConfigs = [
-  ...rulesConfigs,
-  ...namingConfigs,
-  ...layersConfigs,
-  ...importsConfigs,
-  ...jsdocConfigs,
-];
+/** @description Build common configs scoped to the given feature root */
+export function createCommonConfigs(featureRoot) {
+  return [
+    ...rulesConfigs,
+    ...createNamingConfigs(featureRoot),
+    ...createLayersConfigs(featureRoot),
+    ...createImportsConfigs(featureRoot),
+    ...createJsdocConfigs(featureRoot),
+  ];
+}

package/src/common/jsdoc.mjs

@@ -2,38 +2,41 @@ import jsdocPlugin from "eslint-plugin-jsdoc";
 
 import { featuresGlob } from "./constants.mjs";
 
-export const jsdocConfigs = [
-  {
-    name: "jsdoc",
-    files: [
-      ...featuresGlob("**/repositories/*.ts"),
-      ...featuresGlob("**/services*/*.ts"),
-      ...featuresGlob("**/utils*/*.ts"),
-    ],
-    plugins: {
-      jsdoc: jsdocPlugin,
-    },
-    rules: {
-      "jsdoc/require-jsdoc": [
-        "warn",
-        {
-          publicOnly: true,
-          require: {
-            FunctionDeclaration: true,
-            ArrowFunctionExpression: true,
-            FunctionExpression: true,
-          },
-          checkGetters: false,
-          checkSetters: false,
-          checkConstructors: false,
-        },
-      ],
-      "jsdoc/require-description": [
-        "warn",
-        {
-          contexts: ["any"],
-        },
+/** @description Scope JSDoc rules to the given feature root */
+export function createJsdocConfigs(featureRoot) {
+  return [
+    {
+      name: "jsdoc",
+      files: [
+        ...featuresGlob(featureRoot, "**/repositories/*.ts"),
+        ...featuresGlob(featureRoot, "**/services*/*.ts"),
+        ...featuresGlob(featureRoot, "**/utils*/*.ts"),
       ],
+      plugins: {
+        jsdoc: jsdocPlugin,
+      },
+      rules: {
+        "jsdoc/require-jsdoc": [
+          "warn",
+          {
+            publicOnly: true,
+            require: {
+              FunctionDeclaration: true,
+              ArrowFunctionExpression: true,
+              FunctionExpression: true,
+            },
+            checkGetters: false,
+            checkSetters: false,
+            checkConstructors: false,
+          },
+        ],
+        "jsdoc/require-description": [
+          "warn",
+          {
+            contexts: ["any"],
+          },
+        ],
+      },
     },
-  },
-];
+  ];
+}

package/src/common/layers.mjs

@@ -1,35 +1,38 @@
-export const layersConfigs = [
-  {
-    name: "layers/repositories",
-    files: ["**/repositories/*.ts"],
-    rules: {
-      "no-restricted-syntax": [
-        "error",
-        {
-          selector: "TryStatement",
-          message:
-            "try-catch is not allowed in repositories. Error handling belongs in actions.",
-        },
-        {
-          selector: "IfStatement",
-          message:
-            "if statements are not allowed in repositories. Conditional logic belongs in services.",
-        },
-      ],
+/** @description Scope layer rules to the given feature root */
+export function createLayersConfigs(featureRoot) {
+  return [
+    {
+      name: "layers/repositories",
+      files: [`${featureRoot}/**/repositories/*.ts`],
+      rules: {
+        "no-restricted-syntax": [
+          "error",
+          {
+            selector: "TryStatement",
+            message:
+              "try-catch is not allowed in repositories. Error handling belongs in actions.",
+          },
+          {
+            selector: "IfStatement",
+            message:
+              "if statements are not allowed in repositories. Conditional logic belongs in services.",
+          },
+        ],
+      },
     },
-  },
-  {
-    name: "layers/services",
-    files: ["**/services/*.ts"],
-    rules: {
-      "no-restricted-syntax": [
-        "error",
-        {
-          selector: "TryStatement",
-          message:
-            "try-catch is not allowed in services. Error handling belongs in actions.",
-        },
-      ],
+    {
+      name: "layers/services",
+      files: [`${featureRoot}/**/services/*.ts`],
+      rules: {
+        "no-restricted-syntax": [
+          "error",
+          {
+            selector: "TryStatement",
+            message:
+              "try-catch is not allowed in services. Error handling belongs in actions.",
+          },
+        ],
+      },
     },
-  },
-];
+  ];
+}

package/src/common/naming.mjs

@@ -4,147 +4,152 @@ import { actionHandleServiceRule } from "./local-plugins/action-handle-service.m
 
 const prefixPattern = `@(${Object.keys(PREFIX_LIB_MAPPING).join("|")})`;
 
-export const namingConfigs = [
-  {
-    name: "naming/services",
-    files: featuresGlob("**/services/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": `${prefixPattern}.service` },
-      ],
+/** @description Scope naming rules to the given feature root */
+export function createNamingConfigs(featureRoot) {
+  return [
+    {
+      name: "naming/services",
+      files: featuresGlob(featureRoot, "**/services/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": `${prefixPattern}.service` },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/repositories",
-    files: featuresGlob("**/repositories/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": `${prefixPattern}.repo` },
-      ],
+    {
+      name: "naming/repositories",
+      files: featuresGlob(featureRoot, "**/repositories/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": `${prefixPattern}.repo` },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/types",
-    files: featuresGlob("*/types/*.type.ts"),
-    ignores: featuresGlob("shared/types/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*/types/*.ts": "<1>" },
-        { ignoreMiddleExtensions: true },
-      ],
+    {
+      name: "naming/types",
+      files: featuresGlob(featureRoot, "*/types/*.type.ts"),
+      ignores: featuresGlob(featureRoot, "shared/types/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*/types/*.ts": "<1>" },
+          { ignoreMiddleExtensions: true },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/types-shared",
-    files: featuresGlob("shared/types/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": "+([a-z0-9_-]).type" },
-      ],
+    {
+      name: "naming/types-shared",
+      files: featuresGlob(featureRoot, "shared/types/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": "+([a-z0-9_-]).type" },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/schemas",
-    files: featuresGlob("**/schemas/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": "+([a-z0-9-]).schema" },
-      ],
+    {
+      name: "naming/schemas",
+      files: featuresGlob(featureRoot, "**/schemas/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": "+([a-z0-9-]).schema" },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/utils",
-    files: featuresGlob("*/utils/*.util.ts"),
-    ignores: featuresGlob("shared/utils/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*/utils/*.ts": "<1>" },
-        { ignoreMiddleExtensions: true },
-      ],
+    {
+      name: "naming/utils",
+      files: featuresGlob(featureRoot, "*/utils/*.util.ts"),
+      ignores: featuresGlob(featureRoot, "shared/utils/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*/utils/*.ts": "<1>" },
+          { ignoreMiddleExtensions: true },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/utils-shared",
-    files: featuresGlob("shared/utils/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": "+([a-z0-9_-]).util" },
-      ],
+    {
+      name: "naming/utils-shared",
+      files: featuresGlob(featureRoot, "shared/utils/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": "+([a-z0-9_-]).util" },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/constants",
-    files: featuresGlob("**/constants/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": "+([a-z0-9-]).constant" },
-      ],
+    {
+      name: "naming/constants",
+      files: featuresGlob(featureRoot, "**/constants/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": "+([a-z0-9-]).constant" },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/actions",
-    files: featuresGlob("**/actions/*.ts"),
-    plugins: { "check-file": checkFile },
-    rules: {
-      "check-file/filename-naming-convention": [
-        "error",
-        { "**/*.ts": `${prefixPattern}.action` },
-      ],
+    {
+      name: "naming/actions",
+      files: featuresGlob(featureRoot, "**/actions/*.ts"),
+      plugins: { "check-file": checkFile },
+      rules: {
+        "check-file/filename-naming-convention": [
+          "error",
+          { "**/*.ts": `${prefixPattern}.action` },
+        ],
+      },
     },
-  },
-  {
-    name: "naming/actions-export",
-    files: featuresGlob("**/actions/*.ts"),
-    rules: {
-      "no-restricted-syntax": [
-        "error",
-        {
-          selector:
-            "ExportNamedDeclaration > FunctionDeclaration[id.name!=/^handle[A-Z]/]",
-          message:
-            "Exported functions in actions must start with 'handle' (e.g., handleGetComics).",
-        },
-      ],
-    },
-  },
-  {
-    name: "naming/actions-handle-service",
-    files: featuresGlob("**/actions/*.ts"),
-    plugins: {
-      local: { rules: { "action-handle-service": actionHandleServiceRule } },
+    {
+      name: "naming/actions-export",
+      files: featuresGlob(featureRoot, "**/actions/*.ts"),
+      rules: {
+        "no-restricted-syntax": [
+          "error",
+          {
+            selector:
+              "ExportNamedDeclaration > FunctionDeclaration[id.name!=/^handle[A-Z]/]",
+            message:
+              "Exported functions in actions must start with 'handle' (e.g., handleGetComics).",
+          },
+        ],
+      },
     },
-    rules: {
-      "local/action-handle-service": "error",
-    },
-  },
-  {
-    name: "naming/features-ts-only",
-    files: featuresGlob("**/*.tsx"),
-    rules: {
-      "no-restricted-syntax": [
-        "error",
-        {
-          selector: "Program",
-          message:
-            "features/ must only contain .ts files. Components belong in src/components/.",
+    {
+      name: "naming/actions-handle-service",
+      files: featuresGlob(featureRoot, "**/actions/*.ts"),
+      plugins: {
+        local: {
+          rules: { "action-handle-service": actionHandleServiceRule },
         },
-      ],
+      },
+      rules: {
+        "local/action-handle-service": "error",
+      },
+    },
+    {
+      name: "naming/features-ts-only",
+      files: featuresGlob(featureRoot, "**/*.tsx"),
+      rules: {
+        "no-restricted-syntax": [
+          "error",
+          {
+            selector: "Program",
+            message:
+              "features/ must only contain .ts files. Components belong in src/components/.",
+          },
+        ],
+      },
     },
-  },
-];
+  ];
+}

package/src/deno/index.d.mts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+
+export declare const eslintConfig: Linter.Config[];

package/src/deno/index.mjs

@@ -0,0 +1,5 @@
+import { createCommonConfigs } from "../common/index.mjs";
+
+export const eslintConfig = [
+  ...createCommonConfigs("supabase/functions/features"),
+];

package/src/next/index.mjs

@@ -1,10 +1,12 @@
-import { commonConfigs } from "../common/index.mjs";
+import { createCommonConfigs } from "../common/index.mjs";
+import { libBoundaryConfigs } from "../common/imports.mjs";
 
 import { directivesConfigs } from "./directives.mjs";
 import { namingConfigs } from "./naming.mjs";
 
 export const eslintConfig = [
-  ...commonConfigs,
+  ...createCommonConfigs("src/features"),
+  ...libBoundaryConfigs,
   ...namingConfigs,
   ...directivesConfigs,
 ];

package/src/next/naming.mjs

@@ -1,10 +1,9 @@
-import { featuresGlob } from "../common/constants.mjs";
 import { checkFile } from "../common/plugins.mjs";
 
 export const namingConfigs = [
   {
     name: "naming/hooks",
-    files: featuresGlob("**/hooks/*.ts"),
+    files: ["src/features/**/hooks/*.ts"],
     plugins: { "check-file": checkFile },
     rules: {
       "check-file/filename-naming-convention": [
@@ -16,7 +15,7 @@ export const namingConfigs = [
   },
   {
     name: "naming/hooks-export",
-    files: featuresGlob("**/hooks/*.ts"),
+    files: ["src/features/**/hooks/*.ts"],
     rules: {
       "no-restricted-syntax": [
         "error",

package/src/node/index.mjs

@@ -1,3 +1,3 @@
-import { commonConfigs } from "../common/index.mjs";
+import { createCommonConfigs } from "../common/index.mjs";
 
-export const eslintConfig = [...commonConfigs];
+export const eslintConfig = [...createCommonConfigs("scripts/features")];