@yasainet/eslint 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,106 @@
+# @yasainet/eslint
+
+Shared ESLint configuration for Next.js projects with feature-based architecture.
+
+## Install
+
+```sh
+npm install -D @yasainet/eslint eslint eslint-config-next
+```
+
+## Usage
+
+```js
+// eslint.config.mjs
+import { eslintConfig } from "@yasainet/eslint";
+
+export default eslintConfig;
+```
+
+## Rules
+
+### Base
+
+Next.js recommended presets (core-web-vitals + typescript) with additional rules:
+
+- `@typescript-eslint/consistent-type-imports` — enforce `type` imports
+- `@typescript-eslint/no-unused-vars` — disallow unused variables (allows `_` prefix)
+- `no-console` — warn on `console.*`
+- `simple-import-sort` — auto-sort imports/exports
+- `@stylistic/quotes` — enforce double quotes
+- `react-you-might-not-need-an-effect` — detect unnecessary `useEffect`
+
+### Naming
+
+Enforces file naming conventions inside `features/`:
+
+| Directory       | Pattern              | Example            |
+| --------------- | -------------------- | ------------------ |
+| `domains/`      | `{prefix}.domain.ts` | `server.domain.ts` |
+| `repositories/` | `{prefix}.repo.ts`   | `server.repo.ts`   |
+| `actions/`      | `{prefix}.action.ts` | `server.action.ts` |
+| `hooks/`        | `use{Name}.ts`       | `useAuth.ts`       |
+| `types/`        | `{name}.type.ts`     | `comic.type.ts`    |
+| `schemas/`      | `{name}.schema.ts`   | `comic.schema.ts`  |
+| `util/`         | `{name}.util.ts`     | `format.util.ts`   |
+| `constants/`    | `{name}.constant.ts` | `api.constant.ts`  |
+
+Additionally:
+
+- `features/**` — `.ts` only (components belong in `src/components/`)
+- `components/**` — `.tsx` only (logic belongs in `src/features/`)
+
+### Layers
+
+Enforces dependency direction between layers:
+
+```
+hooks → actions → domains → repositories
+```
+
+- **Repositories** — cannot import domains/actions/hooks, no `try-catch` or `if`
+- **Domains** — cannot import actions/hooks, no `try-catch`
+- **Actions** — cannot import hooks, exports must start with `handle`
+- **Hooks** — exports must start with `use`
+
+Cross-feature imports within the same layer are prohibited.
+
+### Cardinality
+
+Each action can only import its matching domain:
+
+- `server.action.ts` → `server.domain.ts`
+- `client.action.ts` → `client.domain.ts`
+- `admin.action.ts` → `admin.domain.ts`
+
+### Directives
+
+Enforces `"use server"` / `"use client"` directives:
+
+- `server.action.ts` / `admin.action.ts` — must start with `"use server"`
+- `client.action.ts` — must NOT have `"use server"`
+- `hooks/*.ts` — must start with `"use client"`
+
+### Imports
+
+Each `{prefix}.repo.ts` can only import its corresponding lib (auto-generated from `src/lib/`):
+
+- `server.repo.ts` → `@/lib/supabase/server`
+- `client.repo.ts` → `@/lib/supabase/client`
+
+## Release
+
+1. Update `version` in `package.json`
+2. Commit and push to `main`
+3. Create and push a tag:
+
+```sh
+git tag v0.2.0
+git push --tags
+```
+
+4. GitHub Actions will automatically publish to npm
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yasainet/eslint",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Shared ESLint configuration for Next.js projects with feature-based architecture",
   "type": "module",
   "exports": {
@@ -17,9 +17,13 @@
   ],
   "author": "yasainet",
   "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
     "@stylistic/eslint-plugin": "^5.9.0",
     "eslint-plugin-check-file": "^3.3.1",
+    "eslint-plugin-jsdoc": "^62.7.1",
     "eslint-plugin-react-you-might-not-need-an-effect": "^0.5.6",
     "eslint-plugin-simple-import-sort": "^12.1.1"
   },

package/src/index.mjs

@@ -8,12 +8,14 @@
  * - cardinality: Action-domain relationships
  * - directives: "use server" / "use client" requirements
  * - imports: Repository import restrictions (prefix → lib mapping)
+ * - jsdoc: JSDoc description requirements for exported functions
  */
 
 import { baseConfigs, ignoresConfig, sharedRulesConfig } from "./base.mjs";
 import { cardinalityConfigs } from "./cardinality.mjs";
 import { directivesConfigs } from "./directives.mjs";
 import { importsConfigs } from "./imports.mjs";
+import { jsdocConfigs } from "./jsdoc.mjs";
 import { layersConfigs } from "./layers.mjs";
 import { namingConfigs } from "./naming.mjs";
 
@@ -30,4 +32,5 @@ export const eslintConfig = [
   ...cardinalityConfigs,
   ...directivesConfigs,
   ...importsConfigs,
+  ...jsdocConfigs,
 ];

package/src/jsdoc.mjs

@@ -0,0 +1,46 @@
+/**
+ * @fileoverview JSDoc configuration for the abstraction layer.
+ *
+ * Enforces a single rule: every exported function must have a description.
+ * Types are handled by TypeScript (machine layer), not JSDoc.
+ */
+
+import jsdocPlugin from "eslint-plugin-jsdoc";
+
+import { featuresGlob } from "./constants.mjs";
+
+/**
+ * JSDoc configurations requiring descriptions on exported functions.
+ * @type {import("eslint").Linter.Config[]}
+ */
+export const jsdocConfigs = [
+  {
+    name: "jsdoc",
+    files: [...featuresGlob("**/*.ts"), "src/components/**/*.tsx"],
+    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/naming.mjs

@@ -15,6 +15,10 @@
  * - features/**: .ts only (no .tsx — components belong in src/components/)
  * - components/**:  .tsx only (no .ts — logic belongs in src/features/)
  *
+ * Component naming:
+ * - components/ *.tsx: PascalCase (e.g., Button.tsx, AlertDialog.tsx)
+ * - components/shared/ui/ : excluded (shadcn/ui uses kebab-case)
+ *
  * Valid prefixes are defined in PREFIX_LIB_MAPPING (constants.mjs).
  */
 
@@ -149,4 +153,16 @@ export const namingConfigs = [
       ],
     },
   },
+  {
+    name: "naming/components-pascal-case",
+    files: ["src/components/**/*.tsx"],
+    ignores: ["src/components/shared/ui/**"],
+    plugins: { "check-file": checkFile },
+    rules: {
+      "check-file/filename-naming-convention": [
+        "error",
+        { "**/*.tsx": "PASCAL_CASE" },
+      ],
+    },
+  },
 ];

package/src/plugins.mjs

@@ -4,6 +4,7 @@
 
 import stylistic from "@stylistic/eslint-plugin";
 import checkFile from "eslint-plugin-check-file";
+import jsdocPlugin from "eslint-plugin-jsdoc";
 import reactYouMightNotNeedAnEffect from "eslint-plugin-react-you-might-not-need-an-effect";
 import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
 
@@ -14,12 +15,14 @@ import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
 export const plugins = {
   "@stylistic": stylistic,
   "check-file": checkFile,
+  jsdoc: jsdocPlugin,
   "react-you-might-not-need-an-effect": reactYouMightNotNeedAnEffect,
   "simple-import-sort": simpleImportSortPlugin,
 };
 
 export {
   checkFile,
+  jsdocPlugin,
   reactYouMightNotNeedAnEffect,
   simpleImportSortPlugin,
   stylistic,