@yasainet/eslint 0.1.1 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yasainet/eslint",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Shared ESLint configuration for Next.js projects with feature-based architecture",
   "type": "module",
   "exports": {
@@ -23,6 +23,7 @@
   "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/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,