@kazupon/eslint-config 0.3.0 → 0.4.1

package/README.md

@@ -7,11 +7,12 @@ ESLint config for @kazupon
 
 ## 🌟 Features
 
-- Flat configuration via `defineConfig` like [vite](https://vitejs.dev/config/)
+- Flat configuration via [vite](https://vitejs.dev/config/) flavor `defineConfig`
 - Support [built-in configurations](#built-in-configurations)
   - `javascript`
   - `comments`
   - `typescript`
+  - `jsdoc`
   - `prettier`
   - `vue`
 - Support primitive eslint flat configuration
@@ -96,6 +97,7 @@ The following built-in configurations are supported:
 | `javascript`  | [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                                       | no (built-in)                             |
 | `comments`    | [`eslint-plugin-eslint-comments`](https://www.npmjs.com/package/eslint-plugin-eslint-comments) | no (built-in)                             |
 | `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)                         | yes                                       |
+| `jsdoc`       | [`eslint-plugin-jsdoc`](https://www.npmjs.com/package/eslint-plugin-jsdoc)                     | yes                                       |
 | `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)               | yes                                       |
 | `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                         | yes                                       |
 

package/dist/configs/index.d.cts

@@ -1,5 +1,6 @@
 export * from './javascript';
 export * from './comments';
 export * from './typescript';
+export * from './jsdoc';
 export * from './prettier';
 export * from './vue';

package/dist/configs/index.d.ts

@@ -1,5 +1,6 @@
 export * from './javascript';
 export * from './comments';
 export * from './typescript';
+export * from './jsdoc';
 export * from './prettier';
 export * from './vue';

package/dist/configs/jsdoc.d.cts

@@ -0,0 +1,7 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface JsDocOptions {
+	typescript?: (('syntax') | ('flavor'));
+	error?: boolean;
+}
+export declare function jsdoc(options?: ((JsDocOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/jsdoc.d.ts

@@ -0,0 +1,7 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface JsDocOptions {
+	typescript?: (('syntax') | ('flavor'));
+	error?: boolean;
+}
+export declare function jsdoc(options?: ((JsDocOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/index.cjs

@@ -39,12 +39,11 @@ async function interopDefault(mod) {
 	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
-	try {
-		return interopDefault(import(name));
-	} catch (e) {
-		console.error(e);
+	const mod = await import(name).catch((err) => {
+		console.error(err);
 		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
-	}
+	});
+	return interopDefault(mod);
 }
 
 //#endregion
@@ -137,6 +136,29 @@ async function typescript(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/jsdoc.ts
+async function jsdoc(options = {}) {
+	const { rules: overrideRules = {}, typescript: typescript$1, error = false } = options;
+	const jsdoc$1 = await loadPlugin('eslint-plugin-jsdoc');
+	function resolvePreset() {
+		let preset = 'recommended';
+		if (typescript$1 === 'syntax') {
+			preset = `${preset}-typescript`;
+		} else if (typescript$1 === 'flavor') {
+			preset = `${preset}-typescript-flavor`;
+		}
+		if (error) {
+			preset = `${preset}-error`;
+		}
+		return preset;
+	}
+	return [jsdoc$1.configs[`flat/${resolvePreset()}`], {
+		name: '@kazupon/jsdoc',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/prettier.ts
 async function prettier(options = {}) {
@@ -184,6 +206,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 exports.comments = comments;
 exports.defineConfig = defineConfig;
 exports.javascript = javascript;
+exports.jsdoc = jsdoc;
 exports.prettier = prettier;
 exports.typescript = typescript;
 exports.vue = vue;

package/dist/index.js

@@ -14,12 +14,11 @@ async function interopDefault(mod) {
 	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
-	try {
-		return interopDefault(import(name));
-	} catch (e) {
-		console.error(e);
+	const mod = await import(name).catch((err) => {
+		console.error(err);
 		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
-	}
+	});
+	return interopDefault(mod);
 }
 
 //#endregion
@@ -112,6 +111,29 @@ async function typescript(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/jsdoc.ts
+async function jsdoc(options = {}) {
+	const { rules: overrideRules = {}, typescript: typescript$1, error = false } = options;
+	const jsdoc$1 = await loadPlugin('eslint-plugin-jsdoc');
+	function resolvePreset() {
+		let preset = 'recommended';
+		if (typescript$1 === 'syntax') {
+			preset = `${preset}-typescript`;
+		} else if (typescript$1 === 'flavor') {
+			preset = `${preset}-typescript-flavor`;
+		}
+		if (error) {
+			preset = `${preset}-error`;
+		}
+		return preset;
+	}
+	return [jsdoc$1.configs[`flat/${resolvePreset()}`], {
+		name: '@kazupon/jsdoc',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/prettier.ts
 async function prettier(options = {}) {
@@ -155,4 +177,4 @@ async function vue(options = {}) {
 }
 
 //#endregion
-export { comments, defineConfig, javascript, prettier, typescript, vue };
+export { comments, defineConfig, javascript, jsdoc, prettier, typescript, vue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kazupon/eslint-config",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -43,9 +43,10 @@
   },
   "peerDependencies": {
     "eslint": ">=8.56.0 || >=9.0.0",
-    "typescript-eslint": ">=7.0.0",
     "eslint-config-prettier": ">=9.1.0",
-    "eslint-plugin-vue": ">=9.24.0"
+    "eslint-plugin-jsdoc": ">=48.5.0",
+    "eslint-plugin-vue": ">=9.24.0",
+    "typescript-eslint": ">=7.0.0"
   },
   "peerDependenciesMeta": {
     "typescript-eslint": {
@@ -54,6 +55,9 @@
     "eslint-config-prettier": {
       "optional": true
     },
+    "eslint-plugin-jsdoc": {
+      "optional": true
+    },
     "eslint-plugin-vue": {
       "optional": true
     }
@@ -65,6 +69,7 @@
     "bumpp": "^9.4.1",
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsdoc": "^48.5.2",
     "eslint-plugin-vue": "^9.27.0",
     "gh-changelogen": "^0.2.8",
     "lint-staged": "^15.2.7",
@@ -73,7 +78,8 @@
     "tsdown": "^0.2.3",
     "tsx": "^4.16.2",
     "typescript": "^5.5.3",
-    "typescript-eslint": "^7.15.0"
+    "typescript-eslint": "^7.15.0",
+    "vitest": "^1.6.0"
   },
   "lint-staged": {
     "*.{json,md,yml}": [
@@ -99,6 +105,7 @@
     "fix:prettier": "prettier . --write",
     "fix:eslint": "eslint . --fix",
     "dev": "pnpx @eslint/config-inspector --config eslint.config.ts",
+    "test": "vitest",
     "build": "tsdown",
     "build:inspector": "pnpm build && pnpx @eslint/config-inspector build",
     "typecheck": "tsc -p ."