@kazupon/eslint-config 0.31.1 → 0.33.0

package/dist/index.js

@@ -7,6 +7,7 @@ import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
 //#region src/config.ts
 /**
 * define eslint configurations
+*
 * @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
 * @returns {FlatConfigComposer} eslint flat configuration composer
 */
@@ -58,6 +59,7 @@ const GLOB_TESTS_TYPE = [`**/*.test-d.${GLOB_SRC_EXT}`, `**/*.spec-d.${GLOB_SRC_
 //#region src/utils.ts
 /**
 * load eslint plugin
+*
 * @param {string} name plugin name
 * @returns {Promise<T>} loaded plugin
 */
@@ -70,7 +72,9 @@ async function loadPlugin(name) {
 }
 /**
 * get TypeScript parser
+*
 * @description get the parser, which is `typescript-eslint` parser
+*
 * @returns {Promise<typeof import('typescript-eslint')['parser']>} TypeScript parser
 */
 async function getTypeScriptParser() {
@@ -79,6 +83,7 @@ async function getTypeScriptParser() {
 }
 /**
 * get glob source files
+*
 * @param {boolean} useTypeScript use TypeScript, default `false`
 * @returns {string[]} files
 */
@@ -95,6 +100,7 @@ function getGlobSourceFiles(useTypeScript = false) {
 /**
 * configure comments preset for the below plugins
 * - `@eslint-community/eslint-plugin-eslint-comments`
+*
 * @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
 * @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
 */
@@ -109,7 +115,8 @@ async function comments(options = {}) {
 		plugins: { "@eslint-community/eslint-comments": comments$1 },
 		rules: {
 			...comments$1.configs.recommended.rules,
-			...directives.rules
+			...directives.rules,
+			"@eslint-community/eslint-comments/require-description": ["error", { ignore: ["eslint-enable"] }]
 		}
 	}, ...kazupon.configs.comment.map((config) => ({
 		...config,
@@ -125,6 +132,7 @@ async function comments(options = {}) {
 //#region src/configs/css.ts
 /**
 * `@eslint/css` and overrides configuration options
+*
 * @param {CssOptions & OverridesOptions} options
 *  eslint css configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -160,6 +168,7 @@ async function css(options = {}) {
 //#region src/configs/html.ts
 /**
 * `@html-eslint/eslint-plugin` and overrides configuration options
+*
 * @param {HtmlOptions & OverridesOptions} options eslint configuration options for HTML
 * @returns {Promise<Linter.Config[]>}
 * eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
@@ -205,6 +214,7 @@ async function html(options = {}) {
 }
 /**
 * Resolve template engine syntax for html-eslint parser
+*
 * @param {HtmlOptions['templateEngineSyntax']} syntax - template engine syntax
 * @param {typeof import('@html-eslint/eslint-plugin').configs['flat/recommended']['languageOptions']['parser']} parser - html-eslint parser
 * @returns {{ [syntax: string]: string } | undefined} resolved template engine syntax, or undefined if no syntax is provided
@@ -229,6 +239,7 @@ const IMPORTS_FILES = [
 ];
 /**
 * `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
+*
 * @description if you want to use this preset, you need to put after `javascript` and `typescript` presets**
 * @param {ImportsOptions & OverridesOptions} options
 *  import configuration options
@@ -292,6 +303,7 @@ async function imports(options = {}) {
 //#region src/configs/javascript.ts
 /**
 * `@eslint/js` and overrides configuration options
+*
 * @param {JavaScriptOptions & OverridesOptions} options eslint configuration options for JavaScript
 * @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/js` and overrides
 */
@@ -330,8 +342,10 @@ async function javascript(options = {}) {
 //#region src/configs/jsdoc.ts
 /**
 * `eslint-plugin-jsdoc` and overrides configuration options
+*
 * @param {JsDocOptions & OverridesOptions} options
 * eslint configuration options for JavaScript
+*
 * @returns {Promise<Linter.Config[]>}
 * eslint flat configurations with `eslint-plugin-jsdoc` and overrides
 */
@@ -346,11 +360,54 @@ async function jsdoc(options = {}) {
 		return preset;
 	}
 	return [{
-		ignores: [GLOB_MARKDOWN],
+		files: [GLOB_SRC],
 		...jsdoc$1.configs[`flat/${resolvePreset()}`]
 	}, {
 		name: "@kazupon/jsdoc",
-		rules: { ...overrideRules }
+		files: [GLOB_SRC],
+		plugins: { jsdoc: jsdoc$1 },
+		rules: {
+			"jsdoc/require-jsdoc": ["error", {
+				publicOnly: true,
+				require: {
+					ArrowFunctionExpression: true,
+					ClassDeclaration: true,
+					ClassExpression: true,
+					FunctionDeclaration: true,
+					FunctionExpression: true,
+					MethodDefinition: true
+				},
+				contexts: [
+					"TSInterfaceDeclaration",
+					"TSTypeAliasDeclaration",
+					"TSPropertySignature",
+					"TSMethodSignature"
+				]
+			}],
+			"jsdoc/require-description": ["error", { contexts: [
+				"ArrowFunctionExpression",
+				"ClassDeclaration",
+				"ClassExpression",
+				"FunctionDeclaration",
+				"FunctionExpression",
+				"MethodDefinition",
+				"PropertyDefinition",
+				"VariableDeclaration",
+				"TSInterfaceDeclaration",
+				"TSTypeAliasDeclaration",
+				"TSPropertySignature",
+				"TSMethodSignature"
+			] }],
+			"jsdoc/tag-lines": [
+				"error",
+				"any",
+				{
+					startLines: 1,
+					applyToEndTag: false
+				}
+			],
+			...overrideRules
+		}
 	}];
 }
 
@@ -358,6 +415,7 @@ async function jsdoc(options = {}) {
 //#region src/configs/jsonc.ts
 /**
 * `eslint-plugin-jsonc` and overrides configuration options
+*
 * @param {JsoncOptions & OverridesOptions} options
 *  eslint jsonc configuration options for json, jsonc, json5
 * @returns {Promise<Linter.Config[]>}
@@ -403,6 +461,7 @@ async function jsonc(options = {}) {
 }
 /**
 * jsonc sort configurations
+*
 * @returns {Linter.Config[]} jsonc sort configurations
 */
 function jsoncSort() {
@@ -485,6 +544,7 @@ function jsoncSort() {
 //#region src/configs/markdown.ts
 /**
 * `@eslint/markdown` and overrides configuration options
+*
 * @param {MarkdownOptions & OverridesOptions} options
 *  eslint unicorn configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -535,6 +595,7 @@ const md = markdown;
 //#region src/configs/prettier.ts
 /**
 * `eslint-config-prettier` and overrides configuration options
+*
 * @param {PrettierOptions & OverridesOptions} options
 * eslint configuration options for Prettier
 * @returns {Promise<Linter.Config[]>}
@@ -556,6 +617,7 @@ async function prettier(options = {}) {
 //#region src/configs/promise.ts
 /**
 * `eslint-plugin-promise` and overrides configuration options
+*
 * @param {PromiseOptions & OverridesOptions} options
 *  eslint promise configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -577,6 +639,7 @@ async function promise(options = {}) {
 //#region src/configs/react.ts
 /**
 * `eslint-plugin-react` and overrides configuration options
+*
 * @param {ReactOptions & OverridesOptions} options
 *  eslint react configuration options for regular expressions
 * @returns {Promise<Linter.Config[]>}
@@ -625,6 +688,7 @@ async function react(options = {}) {
 //#region src/configs/regexp.ts
 /**
 * `eslint-plugin-regexp` and overrides configuration options
+*
 * @param {RegexpOptions & OverridesOptions} options
 *  eslint regexp configuration options for regular expressions
 * @returns {Promise<Linter.Config[]>}
@@ -647,6 +711,7 @@ async function regexp(options = {}) {
 //#region src/configs/stylistic.ts
 /**
 * `@stylistic/eslint-plugin` and overrides configuration options
+*
 * @param {StylisticOptions & OverridesOptions} options
 *  stylistic eslint plugin configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -692,6 +757,7 @@ async function stylistic(options = {}) {
 //#region src/configs/svelte.ts
 /**
 * `eslint-plugin-svelte` and overrides configuration options
+*
 * @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options
 * eslint configuration options for Vue
 * @returns {Promise<Linter.Config[]>}
@@ -728,6 +794,7 @@ async function svelte(options = {}) {
 //#region src/configs/toml.ts
 /**
 * `eslint-plugin-yml` and overrides configuration options
+*
 * @param {YmlOptions & OverridesOptions} options
 *  eslint yml configuration options for yml, yaml
 * @returns {Promise<Linter.Config[]>}
@@ -758,6 +825,7 @@ async function toml(options = {}) {
 //#region src/configs/typescript.ts
 /**
 * `typescript-eslint` and overrides configuration options
+*
 * @param {TypeScriptOptions & OverridesOptions} options
 * eslint configuration options for TypeScript
 * @returns {Promise<Linter.FlatConfig[]>}
@@ -820,6 +888,13 @@ async function typescript(options = {}) {
 					varsIgnorePattern: "^_",
 					ignoreRestSiblings: true
 				}],
+				"@typescript-eslint/ban-ts-comment": ["error", {
+					minimumDescriptionLength: 10,
+					"ts-check": false,
+					"ts-expect-error": "allow-with-description",
+					"ts-ignore": "allow-with-description",
+					"ts-nocheck": "allow-with-description"
+				}],
 				...overrideRules
 			}
 		}
@@ -830,6 +905,7 @@ async function typescript(options = {}) {
 //#region src/configs/unicorn.ts
 /**
 * `eslint-plugin-unicorn` and overrides configuration options
+*
 * @param {UnicornOptions & OverridesOptions} options
 *  eslint unicorn configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -853,6 +929,7 @@ async function unicorn(options = {}) {
 //#region src/configs/vitest.ts
 /**
 * `@vitest/eslint-plugin` and overrides configuration options
+*
 * @param {VitestOptions & OverridesOptions} options
 *  eslint vitest configuration options
 * @returns {Promise<Linter.Config[]>}
@@ -887,6 +964,7 @@ async function vitest(options = {}) {
 //#region src/configs/vue.ts
 /**
 * `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides configuration options
+*
 * @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
 * eslint configuration options for Vue
 * @returns {Promise<Linter.Config[]>}
@@ -965,6 +1043,7 @@ async function vue(options = {}) {
 //#region src/configs/yml.ts
 /**
 * `eslint-plugin-yml` and overrides configuration options
+*
 * @param {YmlOptions & OverridesOptions} options
 *  eslint yml configuration options for yml, yaml
 * @returns {Promise<Linter.Config[]>}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kazupon/eslint-config",
   "description": "ESLint config for @kazupon",
-  "version": "0.31.1",
+  "version": "0.33.0",
   "author": {
     "email": "kawakazu80@gmail.com",
     "name": "kazuya kawaguchi"
@@ -50,17 +50,17 @@
   },
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
-    "@eslint/js": "^9.28.0",
-    "@kazupon/eslint-plugin": "^0.4.0",
+    "@eslint/js": "^9.32.0",
+    "@kazupon/eslint-plugin": "^0.5.0",
     "@kazupon/jts-utils": "^0.6.0",
     "@stylistic/eslint-plugin": "^4.4.1",
     "eslint-flat-config-utils": "^2.1.0",
     "eslint-merge-processors": "^2.0.0",
-    "globals": "^16.2.0"
+    "globals": "^16.3.0"
   },
   "peerDependencies": {
     "@eslint/css": ">=0.5.0",
-    "@eslint/markdown": ">=6.1.0",
+    "@eslint/markdown": ">=7.0.0",
     "@html-eslint/eslint-plugin": ">=0.41.0",
     "@intlify/eslint-plugin-vue-i18n": ">=4.0.0",
     "@vitest/eslint-plugin": ">=1.0.0",
@@ -68,7 +68,7 @@
     "eslint-config-prettier": ">=9.1.0",
     "eslint-import-resolver-typescript": ">=3.6.0",
     "eslint-plugin-import": ">=2.31.0",
-    "eslint-plugin-jsdoc": ">=48.5.0",
+    "eslint-plugin-jsdoc": ">=51.0.0",
     "eslint-plugin-jsonc": ">=2.16.0",
     "eslint-plugin-module-interop": ">=0.3.0",
     "eslint-plugin-promise": ">=6.4.0",
@@ -172,48 +172,48 @@
     }
   },
   "devDependencies": {
-    "@eslint/compat": "^1.2.9",
-    "@eslint/css": "^0.8.1",
-    "@eslint/markdown": "^6.5.0",
-    "@html-eslint/eslint-plugin": "^0.41.0",
+    "@eslint/compat": "^1.3.1",
+    "@eslint/css": "^0.9.0",
+    "@eslint/markdown": "^7.1.0",
+    "@html-eslint/eslint-plugin": "^0.43.1",
     "@intlify/eslint-plugin-vue-i18n": "^4.0.1",
     "@kazupon/prettier-config": "^0.1.1",
     "@types/eslint": "^9.6.1",
-    "@types/node": "^22.15.30",
-    "@vitest/eslint-plugin": "^1.2.1",
-    "bumpp": "^10.1.1",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-import-resolver-typescript": "^4.4.3",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsdoc": "^50.7.1",
+    "@types/node": "^22.16.5",
+    "@vitest/eslint-plugin": "^1.3.4",
+    "bumpp": "^10.2.1",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^52.0.0",
     "eslint-plugin-jsonc": "^2.20.1",
     "eslint-plugin-module-interop": "^0.3.1",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
-    "eslint-plugin-regexp": "^2.8.0",
+    "eslint-plugin-regexp": "^2.9.0",
     "eslint-plugin-svelte": "^2.46.1",
     "eslint-plugin-toml": "^0.12.0",
     "eslint-plugin-unicorn": "^59.0.1",
     "eslint-plugin-unused-imports": "^4.1.4",
-    "eslint-plugin-vue": "^10.2.0",
+    "eslint-plugin-vue": "^10.3.0",
     "eslint-plugin-vue-composable": "^1.0.0",
-    "eslint-plugin-vue-scoped-css": "^2.10.0",
+    "eslint-plugin-vue-scoped-css": "^2.11.0",
     "eslint-plugin-vuejs-accessibility": "^2.4.1",
     "eslint-plugin-yml": "^1.18.0",
-    "eslint-typegen": "^2.2.0",
+    "eslint-typegen": "^2.3.0",
     "gh-changelogen": "^0.2.8",
-    "jiti": "^2.4.2",
-    "knip": "^5.60.2",
-    "lint-staged": "^16.1.0",
-    "prettier": "^3.5.3",
-    "svelte": "^5.33.17",
-    "tsdown": "^0.12.7",
+    "jiti": "^2.5.1",
+    "knip": "^5.62.0",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.6.2",
+    "svelte": "^5.37.1",
+    "tsdown": "^0.13.0",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.1",
-    "vitest": "^3.2.2"
+    "typescript-eslint": "^8.38.0",
+    "vitest": "^3.2.4"
   },
   "prettier": "@kazupon/prettier-config",
   "lint-staged": {
@@ -237,11 +237,11 @@
     "fix": "pnpm run --parallel --color \"/^fix:/\"",
     "fix:eslint": "eslint . --fix",
     "fix:knip": "knip --fix --no-exit-code",
-    "fix:prettier": "prettier . --write",
+    "fix:prettier": "prettier . --write --experimental-cli",
     "lint": "pnpm run --parallel --color \"/^lint:/\"",
     "lint:eslint": "eslint .",
     "lint:knip": "knip",
-    "lint:prettier": "prettier . --check",
+    "lint:prettier": "prettier . --check --experimental-cli",
     "release": "bumpp --commit \"release: v%s\" --all --push --tag",
     "test": "vitest run --typecheck",
     "typecheck": "tsc -p .",