@kazupon/eslint-config 0.2.0 → 0.4.0

package/README.md

@@ -7,10 +7,12 @@ ESLint config for @kazupon
 
 ## 🌟 Features
 
-- Flat configuration via `defineConfig` like [vite](https://vitejs.dev/config/)
-- Support built-in configurations
+- 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
@@ -82,7 +84,7 @@ Add the following settings to your `.vscode/settings.json`:
   // Enable eslint for supported languages
   "eslint.validate": ["javascript", "typescript", "vue"],
   // Enable flat configuration
-  "eslint.experimental.useFlatConfig": true
+  "eslint.useFlatConfig": true
 }
 ```
 
@@ -90,12 +92,14 @@ Add the following settings to your `.vscode/settings.json`:
 
 The following built-in configurations are supported:
 
-| Configuration | Powered by eslint plugin or package                                              | Need to install eslint plugin or package? |
-| ------------- | -------------------------------------------------------------------------------- | ----------------------------------------- |
-| `javascript`  | [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                         | no (built-in)                             |
-| `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)           | 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                                       |
+| Configuration | Powered by eslint plugin or package                                                            | Need to install eslint plugin or package? |
+| ------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------- |
+| `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                                       |
 
 You can use `import` syntax:
 

package/dist/configs/comments.d.cts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface CommentsOptions {}
+export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/comments.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface CommentsOptions {}
+export declare function comments(options?: ((CommentsOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/index.d.cts

@@ -1,4 +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,4 +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

@@ -7,12 +7,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-	for (var name in all) __defProp(target, name, {
-		get: all[name],
-		enumerable: true
-	});
-};
 var __copyProps = (to, from, except, desc) => {
 	if (from && typeof from === 'object' || typeof from === 'function') for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
 		key = keys[i];
@@ -27,7 +21,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	value: mod,
 	enumerable: true
 }) : target, mod));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, '__esModule', {value: true}), mod);
 
 //#endregion
 const { FlatConfigComposer } = __toESM(require("eslint-flat-config-utils"));
@@ -43,7 +36,7 @@ function defineConfig(...configs) {
 //#region src/utils.ts
 async function interopDefault(mod) {
 	const resolved = await mod;
-	return resolved.default || resolved;
+	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
 	try {
@@ -61,7 +54,7 @@ async function javascript(options = {}) {
 	const js = await loadPlugin('@eslint/js');
 	return [{
 		name: 'eslint/defaults/rules',
-		...js.configs.recommended
+		...(js.configs.recommended)
 	}, {
 		name: '@kazupon/javascript/@eslint/js',
 		languageOptions: {
@@ -86,6 +79,21 @@ async function javascript(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/comments.ts
+async function comments(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const comments$1 = await loadPlugin('eslint-plugin-eslint-comments');
+	return [{
+		name: 'eslint-comments/recommended',
+		plugins: {'eslint-comments': comments$1},
+		rules: {...(comments$1.configs.recommended.rules)}
+	}, {
+		name: '@kazupon/eslint-comments',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/globs.ts
 const GLOB_JS = '**/*.?([cm])js';
@@ -100,9 +108,9 @@ async function typescript(options = {}) {
 	const { rules: overrideRules = {}, extraFileExtensions = [], parserOptions = {project: true} } = options;
 	const ts = await loadPlugin('typescript-eslint');
 	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
-	return [...ts.configs.recommendedTypeChecked, {
+	return [...(ts.configs.recommendedTypeChecked), {
 		files: [GLOB_JS, GLOB_JSX],
-		...ts.configs.disableTypeChecked
+		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
 		files,
@@ -129,6 +137,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 = {}) {
@@ -168,19 +199,15 @@ async function vue(options = {}) {
 			}
 		};
 	}
-	return [...vue$1.configs['flat/recommended'], customConfig];
+	return [...(vue$1.configs['flat/recommended']), customConfig];
 }
 
 //#endregion
-//#region src/index.ts
-var src_index_ns = {};
-__export(src_index_ns, {
-	defineConfig: () => defineConfig,
-	javascript: () => javascript,
-	prettier: () => prettier,
-	typescript: () => typescript,
-	vue: () => vue
-});
-
-//#endregion
-module.exports = __toCommonJS(src_index_ns)
+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

@@ -11,7 +11,7 @@ function defineConfig(...configs) {
 //#region src/utils.ts
 async function interopDefault(mod) {
 	const resolved = await mod;
-	return resolved.default || resolved;
+	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
 	try {
@@ -29,7 +29,7 @@ async function javascript(options = {}) {
 	const js = await loadPlugin('@eslint/js');
 	return [{
 		name: 'eslint/defaults/rules',
-		...js.configs.recommended
+		...(js.configs.recommended)
 	}, {
 		name: '@kazupon/javascript/@eslint/js',
 		languageOptions: {
@@ -54,6 +54,21 @@ async function javascript(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/comments.ts
+async function comments(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const comments$1 = await loadPlugin('eslint-plugin-eslint-comments');
+	return [{
+		name: 'eslint-comments/recommended',
+		plugins: {'eslint-comments': comments$1},
+		rules: {...(comments$1.configs.recommended.rules)}
+	}, {
+		name: '@kazupon/eslint-comments',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/globs.ts
 const GLOB_JS = '**/*.?([cm])js';
@@ -68,9 +83,9 @@ async function typescript(options = {}) {
 	const { rules: overrideRules = {}, extraFileExtensions = [], parserOptions = {project: true} } = options;
 	const ts = await loadPlugin('typescript-eslint');
 	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
-	return [...ts.configs.recommendedTypeChecked, {
+	return [...(ts.configs.recommendedTypeChecked), {
 		files: [GLOB_JS, GLOB_JSX],
-		...ts.configs.disableTypeChecked
+		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
 		files,
@@ -97,6 +112,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 = {}) {
@@ -136,8 +174,8 @@ async function vue(options = {}) {
 			}
 		};
 	}
-	return [...vue$1.configs['flat/recommended'], customConfig];
+	return [...(vue$1.configs['flat/recommended']), customConfig];
 }
 
 //#endregion
-export { 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.2.0",
+  "version": "0.4.0",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -38,13 +38,15 @@
   "dependencies": {
     "@eslint/js": "^9.0.0",
     "eslint-flat-config-utils": "^0.2.5",
+    "eslint-plugin-eslint-comments": "^3.2.0",
     "globals": "^15.8.0"
   },
   "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": {
@@ -53,6 +55,9 @@
     "eslint-config-prettier": {
       "optional": true
     },
+    "eslint-plugin-jsdoc": {
+      "optional": true
+    },
     "eslint-plugin-vue": {
       "optional": true
     }
@@ -64,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",