@kazupon/eslint-config 0.1.0 → 0.3.0

package/README.md

@@ -1,17 +1,19 @@
 # @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
 
 ## 🌟 Features
 
 - Flat configuration via `defineConfig` like [vite](https://vitejs.dev/config/)
-- Support built-in configurations
+- Support [built-in configurations](#built-in-configurations)
   - `javascript`
+  - `comments`
   - `typescript`
   - `prettier`
+  - `vue`
 - Support primitive eslint flat configuration
 - Support overrides for built-in configurations
   - `rules`
@@ -79,9 +81,9 @@ 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
+  "eslint.useFlatConfig": true
 }
 ```
 
@@ -89,11 +91,13 @@ 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                                       |
+| 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                                       |
+| `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 +111,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 +128,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/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,3 +1,5 @@
 export * from './javascript';
+export * from './comments';
 export * from './typescript';
 export * from './prettier';
+export * from './vue';

package/dist/configs/index.d.ts

@@ -1,3 +1,5 @@
 export * from './javascript';
+export * from './comments';
 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

@@ -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,29 +79,45 @@ 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';
 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}`)];
-	return [...ts.configs.recommendedTypeChecked, {
+	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
+	return [...(ts.configs.recommendedTypeChecked), {
 		files: [GLOB_JS, GLOB_JSX],
-		...ts.configs.disableTypeChecked
+		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
 		files,
 		languageOptions: {
 			parser: ts.parser,
 			parserOptions: {
-				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				extraFileExtensions: extraFileExtensions.map((ext) => `${ext}`),
 				sourceType: 'module',
 				...parserOptions
 			}
@@ -140,14 +149,41 @@ async function prettier(options = {}) {
 }
 
 //#endregion
-//#region src/index.ts
-var src_index_ns = {};
-__export(src_index_ns, {
-	defineConfig: () => defineConfig,
-	javascript: () => javascript,
-	prettier: () => prettier,
-	typescript: () => 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
-module.exports = __toCommonJS(src_index_ns)
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.comments = comments;
+exports.defineConfig = defineConfig;
+exports.javascript = javascript;
+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,29 +54,45 @@ 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';
 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}`)];
-	return [...ts.configs.recommendedTypeChecked, {
+	const files = options.files ?? [GLOB_TS, GLOB_TSX, ...extraFileExtensions.map((ext) => `**/*${ext}`)];
+	return [...(ts.configs.recommendedTypeChecked), {
 		files: [GLOB_JS, GLOB_JSX],
-		...ts.configs.disableTypeChecked
+		...(ts.configs.disableTypeChecked)
 	}, {
 		name: '@kazupon/typescipt/typescript-eslint',
 		files,
 		languageOptions: {
 			parser: ts.parser,
 			parserOptions: {
-				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				extraFileExtensions: extraFileExtensions.map((ext) => `${ext}`),
 				sourceType: 'module',
 				...parserOptions
 			}
@@ -108,4 +124,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 { comments, defineConfig, javascript, prettier, typescript, vue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kazupon/eslint-config",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "ESLint config for @kazupon",
   "keywords": [
     "config",
@@ -38,12 +38,14 @@
   "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-config-prettier": ">=9.1.0",
+    "eslint-plugin-vue": ">=9.24.0"
   },
   "peerDependenciesMeta": {
     "typescript-eslint": {
@@ -51,6 +53,9 @@
     },
     "eslint-config-prettier": {
       "optional": true
+    },
+    "eslint-plugin-vue": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -60,6 +65,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",