@kazupon/eslint-config 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,7 @@
 # @kazupon/eslint-config
 
-[![CI](https://github.com/kazupon/eslint-config/actions/workflows/ci.yml/badge.svg)](https://github.com/kazupon/eslint-config/actions/workflows/ci.yml)
-[![CI](https://github.com/kazupon/eslint-config/actions/workflows/ci.yml/badge.svg)](https://github.com/kazupon/eslint-config/actions/workflows/ci.yml)
+[![npm version][npm-version-src]][npm-version-href]
+[![CI][ci-src]][ci-href]
 
 ESLint config for @kazupon
 
@@ -12,6 +12,7 @@ ESLint config for @kazupon
   - `javascript`
   - `typescript`
   - `prettier`
+  - `vue`
 - Support primitive eslint flat configuration
 - Support overrides for built-in configurations
   - `rules`
@@ -79,7 +80,7 @@ Add the following settings to your `.vscode/settings.json`:
     "source.fixAll.eslint": "explicit"
   },
   // Enable eslint for supported languages
-  "eslint.validate": ["javascript", "typescript"],
+  "eslint.validate": ["javascript", "typescript", "vue"],
   // Enable flat configuration
   "eslint.experimental.useFlatConfig": true
 }
@@ -94,6 +95,7 @@ The following built-in configurations are supported:
 | `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                                       |
 
 You can use `import` syntax:
 
@@ -107,7 +109,7 @@ export default defineConfig(
 )
 ```
 
-## ⚖️ Comparing to [`@antfu/eslint-config`](https://github.com/antfu/eslint-config) an others
+## ⚖️ Comparing to [`@antfu/eslint-config`](https://github.com/antfu/eslint-config) and others
 
 - Respect the recommended config by the eslint plugin in built-in configurations
 - Customization is overriding it only
@@ -124,3 +126,12 @@ Thank you! ❤️
 ## ©️ License
 
 [MIT](http://opensource.org/licenses/MIT)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@kazupon/eslint-config?style=flat
+[npm-version-href]: https://npmjs.com/package/@kazupon/eslint-config
+[npm-downloads-src]: https://img.shields.io/npm/dm/@kazupon/eslint-config?style=flat
+[npm-downloads-href]: https://npmjs.com/package/@kazupon/eslint-config
+[ci-src]: https://github.com/kazupon/eslint-config/actions/workflows/ci.yml/badge.svg
+[ci-href]: https://github.com/kazupon/eslint-config/actions/workflows/ci.yml

package/dist/configs/index.d.cts

@@ -1,3 +1,4 @@
 export * from './javascript';
 export * from './typescript';
 export * from './prettier';
+export * from './vue';

package/dist/configs/index.d.ts

@@ -1,3 +1,4 @@
 export * from './javascript';
 export * from './typescript';
 export * from './prettier';
+export * from './vue';

package/dist/configs/vue.d.cts

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

package/dist/configs/vue.d.ts

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

package/dist/globs.d.cts

@@ -2,3 +2,4 @@ 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';

package/dist/globs.d.ts

@@ -2,3 +2,4 @@ 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';

package/dist/index.cjs

@@ -92,13 +92,14 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
+const GLOB_VUE = '**/*.vue';
 
 //#endregion
 //#region src/configs/typescript.ts
 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}`)];
+	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
 	return [...ts.configs.recommendedTypeChecked, {
 		files: [GLOB_JS, GLOB_JSX],
 		...ts.configs.disableTypeChecked
@@ -108,7 +109,7 @@ async function typescript(options = {}) {
 		languageOptions: {
 			parser: ts.parser,
 			parserOptions: {
-				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				extraFileExtensions: extraFileExtensions.map((ext) => `${ext}`),
 				sourceType: 'module',
 				...parserOptions
 			}
@@ -139,6 +140,37 @@ async function prettier(options = {}) {
 	}];
 }
 
+//#endregion
+//#region src/configs/vue.ts
+async function vue(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = {project: true} } = options;
+	const useTypeScript = !!options.typescript;
+	const vue$1 = await loadPlugin('eslint-plugin-vue');
+	const vueParser = vue$1.configs['flat/base'][1]['languageOptions']['parser'];
+	async function getTypeScriptParser() {
+		const ts = await loadPlugin('typescript-eslint');
+		return ts.parser;
+	}
+	const customConfig = {
+		name: '@kazupon/vue',
+		files: [GLOB_VUE],
+		rules: {...overrideRules}
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: vueParser,
+			parserOptions: {
+				sourceType: 'module',
+				parser: await getTypeScriptParser(),
+				ecmaFeatures: {jsx: true},
+				extraFileExtensions: ['.vue'],
+				...parserOptions
+			}
+		};
+	}
+	return [...vue$1.configs['flat/recommended'], customConfig];
+}
+
 //#endregion
 //#region src/index.ts
 var src_index_ns = {};
@@ -146,7 +178,8 @@ __export(src_index_ns, {
 	defineConfig: () => defineConfig,
 	javascript: () => javascript,
 	prettier: () => prettier,
-	typescript: () => typescript
+	typescript: () => typescript,
+	vue: () => vue
 });
 
 //#endregion

package/dist/index.js

@@ -60,13 +60,14 @@ const GLOB_JS = '**/*.?([cm])js';
 const GLOB_JSX = '**/*.?([cm])jsx';
 const GLOB_TS = '**/*.?([cm])ts';
 const GLOB_TSX = '**/*.?([cm])tsx';
+const GLOB_VUE = '**/*.vue';
 
 //#endregion
 //#region src/configs/typescript.ts
 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}`)];
+	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
 	return [...ts.configs.recommendedTypeChecked, {
 		files: [GLOB_JS, GLOB_JSX],
 		...ts.configs.disableTypeChecked
@@ -76,7 +77,7 @@ async function typescript(options = {}) {
 		languageOptions: {
 			parser: ts.parser,
 			parserOptions: {
-				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				extraFileExtensions: extraFileExtensions.map((ext) => `${ext}`),
 				sourceType: 'module',
 				...parserOptions
 			}
@@ -108,4 +109,35 @@ async function prettier(options = {}) {
 }
 
 //#endregion
-export { defineConfig, javascript, prettier, typescript };
+//#region src/configs/vue.ts
+async function vue(options = {}) {
+	const { rules: overrideRules = {}, parserOptions = {project: true} } = options;
+	const useTypeScript = !!options.typescript;
+	const vue$1 = await loadPlugin('eslint-plugin-vue');
+	const vueParser = vue$1.configs['flat/base'][1]['languageOptions']['parser'];
+	async function getTypeScriptParser() {
+		const ts = await loadPlugin('typescript-eslint');
+		return ts.parser;
+	}
+	const customConfig = {
+		name: '@kazupon/vue',
+		files: [GLOB_VUE],
+		rules: {...overrideRules}
+	};
+	if (useTypeScript) {
+		customConfig.languageOptions = {
+			parser: vueParser,
+			parserOptions: {
+				sourceType: 'module',
+				parser: await getTypeScriptParser(),
+				ecmaFeatures: {jsx: true},
+				extraFileExtensions: ['.vue'],
+				...parserOptions
+			}
+		};
+	}
+	return [...vue$1.configs['flat/recommended'], customConfig];
+}
+
+//#endregion
+export { defineConfig, javascript, prettier, typescript, vue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kazupon/eslint-config",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -43,7 +43,8 @@
   "peerDependencies": {
     "eslint": ">=8.56.0 || >=9.0.0",
     "typescript-eslint": ">=7.0.0",
-    "eslint-config-prettier": ">=9.1.0"
+    "eslint-config-prettier": ">=9.1.0",
+    "eslint-plugin-vue": ">=9.24.0"
   },
   "peerDependenciesMeta": {
     "typescript-eslint": {
@@ -51,6 +52,9 @@
     },
     "eslint-config-prettier": {
       "optional": true
+    },
+    "eslint-plugin-vue": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -60,6 +64,7 @@
     "bumpp": "^9.4.1",
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-vue": "^9.27.0",
     "gh-changelogen": "^0.2.8",
     "lint-staged": "^15.2.7",
     "npm-run-all2": "^6.2.2",