@kazupon/eslint-config 0.6.0 → 0.7.0

package/README.md

@@ -17,7 +17,8 @@ ESLint config for @kazupon
   - `unicorn`
   - `prettier`
   - `jsonc`
-  - `vue`
+  - `vue`,
+  - `yml`
 - Support primitive eslint flat configuration
 - Support overrides for built-in configurations
   - `rules`
@@ -85,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", "json", "jsonc", "json5", "vue"],
+  "eslint.validate": ["javascript", "typescript", "json", "jsonc", "json5", "vue", "yaml"],
   // Enable flat configuration
   "eslint.useFlatConfig": true
 }
@@ -106,6 +107,7 @@ The following built-in configurations are supported:
 | `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

@@ -6,4 +6,5 @@ export * from './regexp';
 export * from './unicorn';
 export * from './prettier';
 export * from './jsonc';
+export * from './yml';
 export * from './vue';

package/dist/configs/index.d.ts

@@ -6,4 +6,5 @@ export * from './regexp';
 export * from './unicorn';
 export * from './prettier';
 export * from './jsonc';
+export * from './yml';
 export * from './vue';

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,7 +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_VUE = '**/*.vue';
 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,7 +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_VUE = '**/*.vue';
 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

@@ -99,10 +99,11 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
-const GLOB_VUE = '**/*.vue';
 const GLOB_JSON = '**/*.json';
 const GLOB_JSON5 = '**/*.json5';
 const GLOB_JSONC = '**/*.jsonc';
+const GLOB_YAML = '**/*.y?(a)ml';
+const GLOB_VUE = '**/*.vue';
 
 //#endregion
 //#region src/configs/typescript.ts
@@ -111,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, GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+		files: [GLOB_JS, GLOB_JSX, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_YAML],
 		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
@@ -242,6 +243,37 @@ async function jsonc(options = {}) {
 	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 = {}) {
@@ -284,4 +316,6 @@ exports.prettier = prettier;
 exports.regexp = regexp;
 exports.typescript = typescript;
 exports.unicorn = unicorn;
-exports.vue = vue;
+exports.vue = vue;
+exports.yaml = yaml;
+exports.yml = yml;

package/dist/index.js

@@ -74,10 +74,11 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
-const GLOB_VUE = '**/*.vue';
 const GLOB_JSON = '**/*.json';
 const GLOB_JSON5 = '**/*.json5';
 const GLOB_JSONC = '**/*.jsonc';
+const GLOB_YAML = '**/*.y?(a)ml';
+const GLOB_VUE = '**/*.vue';
 
 //#endregion
 //#region src/configs/typescript.ts
@@ -86,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, GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+		files: [GLOB_JS, GLOB_JSX, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_YAML],
 		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
@@ -217,6 +218,37 @@ async function jsonc(options = {}) {
 	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 = {}) {
@@ -249,4 +281,4 @@ async function vue(options = {}) {
 }
 
 //#endregion
-export { comments, defineConfig, javascript, jsdoc, jsonc, prettier, regexp, typescript, unicorn, 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.6.0",
+  "version": "0.7.0",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -49,12 +49,10 @@
     "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
     },
@@ -72,6 +70,12 @@
     },
     "eslint-plugin-vue": {
       "optional": true
+    },
+    "eslint-plugin-yml": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -86,6 +90,7 @@
     "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",
@@ -97,7 +102,7 @@
     "vitest": "^2.0.0"
   },
   "lint-staged": {
-    "*.{json,md,yml}": [
+    "*.{json,jsonc,json5,md,yml,yaml}": [
       "prettier --write"
     ],
     "*.{js,mjs,cjs}": [