@kazupon/eslint-config 0.5.0 → 0.7.0

package/README.md

@@ -14,8 +14,11 @@ ESLint config for @kazupon
   - `typescript`
   - `jsdoc`
   - `regexp`
+  - `unicorn`
   - `prettier`
-  - `vue`
+  - `jsonc`
+  - `vue`,
+  - `yml`
 - Support primitive eslint flat configuration
 - Support overrides for built-in configurations
   - `rules`
@@ -83,7 +86,7 @@ Add the following settings to your `.vscode/settings.json`:
     "source.fixAll.eslint": "explicit"
   },
   // Enable eslint for supported languages
-  "eslint.validate": ["javascript", "typescript", "vue"],
+  "eslint.validate": ["javascript", "typescript", "json", "jsonc", "json5", "vue", "yaml"],
   // Enable flat configuration
   "eslint.useFlatConfig": true
 }
@@ -100,8 +103,11 @@ The following built-in configurations are supported:
 | `typescript`  | [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)                         | yes                                       |
 | `jsdoc`       | [`eslint-plugin-jsdoc`](https://www.npmjs.com/package/eslint-plugin-jsdoc)                     | yes                                       |
 | `regexp`      | [`eslint-plugin-regexp`](https://www.npmjs.com/package/eslint-plugin-regexp)                   | yes                                       |
+| `unicorn`     | [`eslint-plugin-unicorn`](https://www.npmjs.com/package/eslint-plugin-unicorn)                 | yes                                       |
 | `prettier`    | [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)               | yes                                       |
+| `jsonc`       | [`eslint-plugin-jsonc`](https://www.npmjs.com/package/eslint-plugin-jsonc)                     | yes                                       |
 | `vue`         | [`eslint-plugin-vue`](https://www.npmjs.com/package/eslint-plugin-vue)                         | yes                                       |
+| `yml`         | [`eslint-plugin-yml`](https://www.npmjs.com/package/eslint-plugin-yml)                         | yes                                       |
 
 You can use `import` syntax:
 

package/dist/configs/index.d.cts

@@ -3,5 +3,8 @@ export * from './comments';
 export * from './typescript';
 export * from './jsdoc';
 export * from './regexp';
+export * from './unicorn';
 export * from './prettier';
+export * from './jsonc';
+export * from './yml';
 export * from './vue';

package/dist/configs/index.d.ts

@@ -3,5 +3,8 @@ export * from './comments';
 export * from './typescript';
 export * from './jsdoc';
 export * from './regexp';
+export * from './unicorn';
 export * from './prettier';
+export * from './jsonc';
+export * from './yml';
 export * from './vue';

package/dist/configs/jsdoc.d.cts

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

package/dist/configs/jsdoc.d.ts

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

package/dist/configs/jsonc.d.cts

@@ -0,0 +1,9 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface JsoncOptions {
+	json?: boolean;
+	jsonc?: boolean;
+	json5?: boolean;
+	prettier?: boolean;
+}
+export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/jsonc.d.ts

@@ -0,0 +1,9 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface JsoncOptions {
+	json?: boolean;
+	jsonc?: boolean;
+	json5?: boolean;
+	prettier?: boolean;
+}
+export declare function jsonc(options?: ((JsoncOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/unicorn.d.cts

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

package/dist/configs/unicorn.d.ts

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

package/dist/configs/yml.d.cts

@@ -0,0 +1,7 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface YmlOptions {
+	prettier?: boolean;
+}
+export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+export declare const yaml: typeof yml;

package/dist/configs/yml.d.ts

@@ -0,0 +1,7 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface YmlOptions {
+	prettier?: boolean;
+}
+export declare function yml(options?: ((YmlOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;
+export declare const yaml: typeof yml;

package/dist/globs.d.cts

@@ -2,4 +2,8 @@ export declare const GLOB_JS = '**/*.?([cm])js';
 export declare const GLOB_JSX = '**/*.?([cm])jsx';
 export declare const GLOB_TS = '**/*.?([cm])ts';
 export declare const GLOB_TSX = '**/*.?([cm])tsx';
+export declare const GLOB_JSON = '**/*.json';
+export declare const GLOB_JSON5 = '**/*.json5';
+export declare const GLOB_JSONC = '**/*.jsonc';
+export declare const GLOB_YAML = '**/*.y?(a)ml';
 export declare const GLOB_VUE = '**/*.vue';

package/dist/globs.d.ts

@@ -2,4 +2,8 @@ export declare const GLOB_JS = '**/*.?([cm])js';
 export declare const GLOB_JSX = '**/*.?([cm])jsx';
 export declare const GLOB_TS = '**/*.?([cm])ts';
 export declare const GLOB_TSX = '**/*.?([cm])tsx';
+export declare const GLOB_JSON = '**/*.json';
+export declare const GLOB_JSON5 = '**/*.json5';
+export declare const GLOB_JSONC = '**/*.jsonc';
+export declare const GLOB_YAML = '**/*.y?(a)ml';
 export declare const GLOB_VUE = '**/*.vue';

package/dist/index.cjs

@@ -39,8 +39,8 @@ async function interopDefault(mod) {
 	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
-	const mod = await import(name).catch((err) => {
-		console.error(err);
+	const mod = await import(name).catch((error) => {
+		console.error(error);
 		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
 	});
 	return interopDefault(mod);
@@ -99,6 +99,10 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
+const GLOB_JSON = '**/*.json';
+const GLOB_JSON5 = '**/*.json5';
+const GLOB_JSONC = '**/*.jsonc';
+const GLOB_YAML = '**/*.y?(a)ml';
 const GLOB_VUE = '**/*.vue';
 
 //#endregion
@@ -108,7 +112,7 @@ async function typescript(options = {}) {
 	const ts = await loadPlugin('typescript-eslint');
 	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
 	return [...(ts.configs.recommendedTypeChecked), {
-		files: [GLOB_JS, GLOB_JSX],
+		files: [GLOB_JS, GLOB_JSX, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_YAML],
 		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
@@ -173,6 +177,17 @@ async function regexp(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/unicorn.ts
+async function unicorn(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const unicorn$1 = await loadPlugin('eslint-plugin-unicorn');
+	return [unicorn$1.configs['flat/recommended'], {
+		name: '@kazupon/unicorn',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/prettier.ts
 async function prettier(options = {}) {
@@ -184,6 +199,81 @@ async function prettier(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/jsonc.ts
+async function jsonc(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const kinds = [options.json ? 'json' : '', options.jsonc ? 'jsonc' : '', options.json5 ? 'json5' : ''];
+	const usePrettier = !!options.prettier;
+	const jsonc$1 = await loadPlugin('eslint-plugin-jsonc');
+	const configs = [];
+	const defaultRules = {'jsonc/sort-keys': ['warn', 'asc', {
+		caseSensitive: true,
+		natural: false,
+		minKeys: 2,
+		allowLineSeparatedGroups: false
+	}]};
+	for (const kind of kinds) {
+		if (kind) {
+			configs.push(...jsonc$1.configs[`flat/recommended-with-${kind}`].map((config, index) => {
+				return config.name ? config : {
+					name: `jsonc/flat/recommended-with-${kind}/${index}`,
+					...config
+				};
+			}));
+		}
+	}
+	if (usePrettier) {
+		configs.push(...jsonc$1.configs['flat/prettier'].map((config, index) => {
+			return config.name ? config : {
+				name: `jsonc/flat/prettier/${index}`,
+				...config
+			};
+		}));
+	}
+	const overriddenConfig = {
+		name: '@kazupon/jsonc',
+		files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+		rules: {
+			...defaultRules,
+			...overrideRules
+		}
+	};
+	configs.push(overriddenConfig);
+	return configs;
+}
+
+//#endregion
+//#region src/configs/yml.ts
+async function yml(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const usePrettier = !!options.prettier;
+	const yml$1 = await loadPlugin('eslint-plugin-yml');
+	const configs = [];
+	configs.push(...yml$1.configs['flat/standard'].map((config, index) => {
+		return config.name ? config : {
+			name: `yml/flat/standard/${index}`,
+			...config
+		};
+	}));
+	if (usePrettier) {
+		configs.push(...yml$1.configs['flat/prettier'].map((config, index) => {
+			return config.name ? config : {
+				name: `yml/flat/prettier/${index}`,
+				...config
+			};
+		}));
+	}
+	const overriddenConfig = {
+		name: '@kazupon/yml',
+		files: [GLOB_YAML],
+		rules: {...overrideRules}
+	};
+	configs.push(overriddenConfig);
+	return configs;
+}
+const yaml = yml;
+
 //#endregion
 //#region src/configs/vue.ts
 async function vue(options = {}) {
@@ -221,7 +311,11 @@ exports.comments = comments;
 exports.defineConfig = defineConfig;
 exports.javascript = javascript;
 exports.jsdoc = jsdoc;
+exports.jsonc = jsonc;
 exports.prettier = prettier;
 exports.regexp = regexp;
 exports.typescript = typescript;
-exports.vue = vue;
+exports.unicorn = unicorn;
+exports.vue = vue;
+exports.yaml = yaml;
+exports.yml = yml;

package/dist/index.js

@@ -14,8 +14,8 @@ async function interopDefault(mod) {
 	return (resolved).default || resolved;
 }
 async function loadPlugin(name) {
-	const mod = await import(name).catch((err) => {
-		console.error(err);
+	const mod = await import(name).catch((error) => {
+		console.error(error);
 		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
 	});
 	return interopDefault(mod);
@@ -74,6 +74,10 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
+const GLOB_JSON = '**/*.json';
+const GLOB_JSON5 = '**/*.json5';
+const GLOB_JSONC = '**/*.jsonc';
+const GLOB_YAML = '**/*.y?(a)ml';
 const GLOB_VUE = '**/*.vue';
 
 //#endregion
@@ -83,7 +87,7 @@ async function typescript(options = {}) {
 	const ts = await loadPlugin('typescript-eslint');
 	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
 	return [...(ts.configs.recommendedTypeChecked), {
-		files: [GLOB_JS, GLOB_JSX],
+		files: [GLOB_JS, GLOB_JSX, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_YAML],
 		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
@@ -148,6 +152,17 @@ async function regexp(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/unicorn.ts
+async function unicorn(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const unicorn$1 = await loadPlugin('eslint-plugin-unicorn');
+	return [unicorn$1.configs['flat/recommended'], {
+		name: '@kazupon/unicorn',
+		rules: {...overrideRules}
+	}];
+}
+
 //#endregion
 //#region src/configs/prettier.ts
 async function prettier(options = {}) {
@@ -159,6 +174,81 @@ async function prettier(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/jsonc.ts
+async function jsonc(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const kinds = [options.json ? 'json' : '', options.jsonc ? 'jsonc' : '', options.json5 ? 'json5' : ''];
+	const usePrettier = !!options.prettier;
+	const jsonc$1 = await loadPlugin('eslint-plugin-jsonc');
+	const configs = [];
+	const defaultRules = {'jsonc/sort-keys': ['warn', 'asc', {
+		caseSensitive: true,
+		natural: false,
+		minKeys: 2,
+		allowLineSeparatedGroups: false
+	}]};
+	for (const kind of kinds) {
+		if (kind) {
+			configs.push(...jsonc$1.configs[`flat/recommended-with-${kind}`].map((config, index) => {
+				return config.name ? config : {
+					name: `jsonc/flat/recommended-with-${kind}/${index}`,
+					...config
+				};
+			}));
+		}
+	}
+	if (usePrettier) {
+		configs.push(...jsonc$1.configs['flat/prettier'].map((config, index) => {
+			return config.name ? config : {
+				name: `jsonc/flat/prettier/${index}`,
+				...config
+			};
+		}));
+	}
+	const overriddenConfig = {
+		name: '@kazupon/jsonc',
+		files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+		rules: {
+			...defaultRules,
+			...overrideRules
+		}
+	};
+	configs.push(overriddenConfig);
+	return configs;
+}
+
+//#endregion
+//#region src/configs/yml.ts
+async function yml(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const usePrettier = !!options.prettier;
+	const yml$1 = await loadPlugin('eslint-plugin-yml');
+	const configs = [];
+	configs.push(...yml$1.configs['flat/standard'].map((config, index) => {
+		return config.name ? config : {
+			name: `yml/flat/standard/${index}`,
+			...config
+		};
+	}));
+	if (usePrettier) {
+		configs.push(...yml$1.configs['flat/prettier'].map((config, index) => {
+			return config.name ? config : {
+				name: `yml/flat/prettier/${index}`,
+				...config
+			};
+		}));
+	}
+	const overriddenConfig = {
+		name: '@kazupon/yml',
+		files: [GLOB_YAML],
+		rules: {...overrideRules}
+	};
+	configs.push(overriddenConfig);
+	return configs;
+}
+const yaml = yml;
+
 //#endregion
 //#region src/configs/vue.ts
 async function vue(options = {}) {
@@ -191,4 +281,4 @@ async function vue(options = {}) {
 }
 
 //#endregion
-export { comments, defineConfig, javascript, jsdoc, prettier, regexp, typescript, vue };
+export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, regexp, typescript, unicorn, vue, yaml, yml };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kazupon/eslint-config",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -45,25 +45,37 @@
     "eslint": ">=8.56.0 || >=9.0.0",
     "eslint-config-prettier": ">=9.1.0",
     "eslint-plugin-jsdoc": ">=48.5.0",
+    "eslint-plugin-jsonc": ">=2.16.0",
     "eslint-plugin-regexp": ">=2.6.0",
+    "eslint-plugin-unicorn": ">=54.0.0",
     "eslint-plugin-vue": ">=9.24.0",
+    "eslint-plugin-yml": ">=1.14.0",
     "typescript-eslint": ">=7.0.0"
   },
   "peerDependenciesMeta": {
-    "typescript-eslint": {
-      "optional": true
-    },
     "eslint-config-prettier": {
       "optional": true
     },
     "eslint-plugin-jsdoc": {
       "optional": true
     },
+    "eslint-plugin-jsonc": {
+      "optional": true
+    },
     "eslint-plugin-regexp": {
       "optional": true
     },
+    "eslint-plugin-unicorn": {
+      "optional": true
+    },
     "eslint-plugin-vue": {
       "optional": true
+    },
+    "eslint-plugin-yml": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -74,8 +86,11 @@
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jsdoc": "^48.5.2",
+    "eslint-plugin-jsonc": "^2.16.0",
     "eslint-plugin-regexp": "^2.6.0",
+    "eslint-plugin-unicorn": "^54.0.0",
     "eslint-plugin-vue": "^9.27.0",
+    "eslint-plugin-yml": "^1.14.0",
     "gh-changelogen": "^0.2.8",
     "lint-staged": "^15.2.7",
     "npm-run-all2": "^6.2.2",
@@ -87,7 +102,7 @@
     "vitest": "^2.0.0"
   },
   "lint-staged": {
-    "*.{json,md,yml}": [
+    "*.{json,jsonc,json5,md,yml,yaml}": [
       "prettier --write"
     ],
     "*.{js,mjs,cjs}": [