@kazupon/eslint-config 0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 kazuya kawaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,126 @@
+# @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)
+
+ESLint config for @kazupon
+
+## 🌟 Features
+
+- Flat configuration via `defineConfig` like [vite](https://vitejs.dev/config/)
+- Support built-in configurations
+  - `javascript`
+  - `typescript`
+  - `prettier`
+- Support primitive eslint flat configuration
+- Support overrides for built-in configurations
+  - `rules`
+
+## 💿 Installation
+
+```sh
+npm i -D @kazupon/eslint-config
+```
+
+## 🚀 Usage
+
+### Configurations
+
+Add create `eslint.config.mjs` in your project root:
+
+```js
+// eslint.config.mjs
+import { defineConfig, javascript } from '@kazupon/eslint-config'
+
+// You can put flat configurations (`Linter.FlatConfig | Linter.FlatConfig[]`)
+export default defineConfig(
+  // built-in configurations
+  javascript({
+    // override rules
+    rules: {
+      'no-console': 'error'
+    }
+  }),
+  // You can put primitive flat configuration, and override it!
+  {
+    ignores: ['**/dist/**' /* something ignores ... */]
+  }
+)
+```
+
+> [!IMPORTANT]
+> Support flat configuration only, **not supported Legacy style (`.eslintrc`)**
+
+### Lint with npm scripts `package.json`
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### Lint with VS Code `settings.json`
+
+You can lint and auto fix.
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+
+Add the following settings to your `.vscode/settings.json`:
+
+```jsonc
+{
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  // Enable eslint for supported languages
+  "eslint.validate": ["javascript", "typescript"],
+  // Enable flat configuration
+  "eslint.experimental.useFlatConfig": true
+}
+```
+
+## 🔨Built-in configurations
+
+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                                       |
+
+You can use `import` syntax:
+
+```js
+import { defineConfig, javascript, typescript } from '@kazupon/eslint-config'
+
+export default defineConfig(
+  javascript(/* ... */),
+  typescript(/* ... */)
+  // ...
+)
+```
+
+## ⚖️ Comparing to [`@antfu/eslint-config`](https://github.com/antfu/eslint-config) an others
+
+- Respect the recommended config by the eslint plugin in built-in configurations
+- Customization is overriding it only
+
+## 💖 Credit
+
+This eslint config is inspired by:
+
+- [`@antfu/eslint-config`](https://github.com/antfu/eslint-config), created by [Anthony Fu](https://github.com/antfu)
+- [`@sxzz/eslint-config`](https://github.com/sxzz/eslint-config), created by [Kevin Deng 三咲智子](https://github.com/sxzz)
+
+Thank you! ❤️
+
+## ©️ License
+
+[MIT](http://opensource.org/licenses/MIT)

package/dist/config.d.cts

@@ -0,0 +1,4 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import type { Linter } from 'eslint';
+import type { Awaitable } from './types';
+export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;

package/dist/config.d.ts

@@ -0,0 +1,4 @@
+import { FlatConfigComposer } from 'eslint-flat-config-utils';
+import type { Linter } from 'eslint';
+import type { Awaitable } from './types';
+export declare function defineConfig(...configs: (Awaitable<((Linter.FlatConfig) | ((Linter.FlatConfig)[]))>)[]): FlatConfigComposer;

package/dist/configs/index.d.cts

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

package/dist/configs/index.d.ts

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

package/dist/configs/javascript.d.cts

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

package/dist/configs/javascript.d.ts

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

package/dist/configs/prettier.d.cts

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

package/dist/configs/prettier.d.ts

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

package/dist/configs/typescript.d.cts

@@ -0,0 +1,11 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface TypeScriptOptions {
+	extraFileExtensions?: (string)[];
+	parserOptions?: TypeScriptParserOptions;
+}
+export interface TypeScriptParserOptions {
+	project?: ((boolean) | (string) | ((string)[]));
+	tsconfigRootDir?: string;
+}
+export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/configs/typescript.d.ts

@@ -0,0 +1,11 @@
+import type { Linter } from 'eslint';
+import type { OverridesOptions } from '../types';
+export interface TypeScriptOptions {
+	extraFileExtensions?: (string)[];
+	parserOptions?: TypeScriptParserOptions;
+}
+export interface TypeScriptParserOptions {
+	project?: ((boolean) | (string) | ((string)[]));
+	tsconfigRootDir?: string;
+}
+export declare function typescript(options?: ((TypeScriptOptions) & (OverridesOptions))): Promise<(Linter.FlatConfig)[]>;

package/dist/globs.d.cts

@@ -0,0 +1,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';

package/dist/globs.d.ts

@@ -0,0 +1,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';

package/dist/index.cjs

@@ -0,0 +1,153 @@
+"use strict";
+
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+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];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, 'default', {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, '__esModule', {value: true}), mod);
+
+//#endregion
+const { FlatConfigComposer } = __toESM(require("eslint-flat-config-utils"));
+const { default: globals } = __toESM(require("globals"));
+
+//#region src/config.ts
+function defineConfig(...configs) {
+	const baseConfigs = [];
+	return new FlatConfigComposer().append(...baseConfigs, ...configs);
+}
+
+//#endregion
+//#region src/utils.ts
+async function interopDefault(mod) {
+	const resolved = await mod;
+	return resolved.default || resolved;
+}
+async function loadPlugin(name) {
+	try {
+		return interopDefault(import(name));
+	} catch (e) {
+		console.error(e);
+		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
+	}
+}
+
+//#endregion
+//#region src/configs/javascript.ts
+async function javascript(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const js = await loadPlugin('@eslint/js');
+	return [{
+		name: 'eslint/defaults/rules',
+		...js.configs.recommended
+	}, {
+		name: '@kazupon/javascript/@eslint/js',
+		languageOptions: {
+			ecmaVersion: 2022,
+			globals: {
+				...globals.browser,
+				...globals.node,
+				...globals.es2022,
+				document: 'readonly',
+				navigator: 'readonly',
+				window: 'readonly'
+			},
+			parserOptions: {
+				ecmaFeatures: {jsx: true},
+				ecmaVersion: 2022,
+				sourceType: 'module'
+			},
+			sourceType: 'module'
+		},
+		linterOptions: {reportUnusedDisableDirectives: true},
+		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';
+
+//#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, {
+		files: [GLOB_JS, GLOB_JSX],
+		...ts.configs.disableTypeChecked
+	}, {
+		name: '@kazupon/typescipt/typescript-eslint',
+		files,
+		languageOptions: {
+			parser: ts.parser,
+			parserOptions: {
+				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				sourceType: 'module',
+				...parserOptions
+			}
+		},
+		rules: {
+			'@typescript-eslint/no-unused-vars': ['error', {
+				args: 'all',
+				argsIgnorePattern: '^_',
+				caughtErrors: 'all',
+				caughtErrorsIgnorePattern: '^_',
+				destructuredArrayIgnorePattern: '^_',
+				varsIgnorePattern: '^_',
+				ignoreRestSiblings: true
+			}],
+			...overrideRules
+		}
+	}];
+}
+
+//#endregion
+//#region src/configs/prettier.ts
+async function prettier(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const prettier$1 = await loadPlugin('eslint-config-prettier');
+	return [prettier$1, {
+		name: '@kazupon/prettier',
+		rules: {...overrideRules}
+	}];
+}
+
+//#endregion
+//#region src/index.ts
+var src_index_ns = {};
+__export(src_index_ns, {
+	defineConfig: () => defineConfig,
+	javascript: () => javascript,
+	prettier: () => prettier,
+	typescript: () => typescript
+});
+
+//#endregion
+module.exports = __toCommonJS(src_index_ns)

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './configs';

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './configs';

package/dist/index.js

@@ -0,0 +1,111 @@
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+import { default as globals } from "globals";
+
+//#region src/config.ts
+function defineConfig(...configs) {
+	const baseConfigs = [];
+	return new FlatConfigComposer().append(...baseConfigs, ...configs);
+}
+
+//#endregion
+//#region src/utils.ts
+async function interopDefault(mod) {
+	const resolved = await mod;
+	return resolved.default || resolved;
+}
+async function loadPlugin(name) {
+	try {
+		return interopDefault(import(name));
+	} catch (e) {
+		console.error(e);
+		throw new Error(`Failed to load eslint plugin '${name}'. Please install it!`);
+	}
+}
+
+//#endregion
+//#region src/configs/javascript.ts
+async function javascript(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const js = await loadPlugin('@eslint/js');
+	return [{
+		name: 'eslint/defaults/rules',
+		...js.configs.recommended
+	}, {
+		name: '@kazupon/javascript/@eslint/js',
+		languageOptions: {
+			ecmaVersion: 2022,
+			globals: {
+				...globals.browser,
+				...globals.node,
+				...globals.es2022,
+				document: 'readonly',
+				navigator: 'readonly',
+				window: 'readonly'
+			},
+			parserOptions: {
+				ecmaFeatures: {jsx: true},
+				ecmaVersion: 2022,
+				sourceType: 'module'
+			},
+			sourceType: 'module'
+		},
+		linterOptions: {reportUnusedDisableDirectives: true},
+		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';
+
+//#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, {
+		files: [GLOB_JS, GLOB_JSX],
+		...ts.configs.disableTypeChecked
+	}, {
+		name: '@kazupon/typescipt/typescript-eslint',
+		files,
+		languageOptions: {
+			parser: ts.parser,
+			parserOptions: {
+				extraFileExtensions: extraFileExtensions.map((ext) => `.${ext}`),
+				sourceType: 'module',
+				...parserOptions
+			}
+		},
+		rules: {
+			'@typescript-eslint/no-unused-vars': ['error', {
+				args: 'all',
+				argsIgnorePattern: '^_',
+				caughtErrors: 'all',
+				caughtErrorsIgnorePattern: '^_',
+				destructuredArrayIgnorePattern: '^_',
+				varsIgnorePattern: '^_',
+				ignoreRestSiblings: true
+			}],
+			...overrideRules
+		}
+	}];
+}
+
+//#endregion
+//#region src/configs/prettier.ts
+async function prettier(options = {}) {
+	const { rules: overrideRules = {} } = options;
+	const prettier$1 = await loadPlugin('eslint-config-prettier');
+	return [prettier$1, {
+		name: '@kazupon/prettier',
+		rules: {...overrideRules}
+	}];
+}
+
+//#endregion
+export { defineConfig, javascript, prettier, typescript };

package/dist/utils.d.cts

@@ -0,0 +1,4 @@
+import type { Awaitable, InteropModuleDefault } from './types';
+export declare function toArray<T>(value: ((T) | ((T)[]))): (T)[];
+export declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+export declare function loadPlugin<T = unknown>(name: string): Promise<T>;

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import type { Awaitable, InteropModuleDefault } from './types';
+export declare function toArray<T>(value: ((T) | ((T)[]))): (T)[];
+export declare function interopDefault<T>(mod: Awaitable<T>): Promise<InteropModuleDefault<T>>;
+export declare function loadPlugin<T = unknown>(name: string): Promise<T>;

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@kazupon/eslint-config",
+  "version": "0.1.0",
+  "description": "ESLint config for @kazupon",
+  "keywords": [
+    "config",
+    "eslint"
+  ],
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/kazupon",
+  "bugs": {
+    "url": "https://github.com/kazupon/eslint-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kazupon/eslint-config.git"
+  },
+  "homepage": "https://github.com/kazupon/eslint-config#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">= 18.18"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@eslint/js": "^9.0.0",
+    "eslint-flat-config-utils": "^0.2.5",
+    "globals": "^15.8.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.56.0 || >=9.0.0",
+    "typescript-eslint": ">=7.0.0",
+    "eslint-config-prettier": ">=9.1.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript-eslint": {
+      "optional": true
+    },
+    "eslint-config-prettier": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@kazupon/prettier-config": "^0.1.1",
+    "@types/eslint": "^8.56.10",
+    "@types/node": "^20.14.9",
+    "bumpp": "^9.4.1",
+    "eslint": "^9.6.0",
+    "eslint-config-prettier": "^9.1.0",
+    "gh-changelogen": "^0.2.8",
+    "lint-staged": "^15.2.7",
+    "npm-run-all2": "^6.2.2",
+    "prettier": "^3.3.2",
+    "tsdown": "^0.2.3",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.15.0"
+  },
+  "lint-staged": {
+    "*.{json,md,yml}": [
+      "prettier --write"
+    ],
+    "*.{js,mjs,cjs}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.ts?(x)": [
+      "prettier --parser=typescript --write",
+      "eslint --fix"
+    ]
+  },
+  "prettier": "@kazupon/prettier-config",
+  "scripts": {
+    "changelog": "gh-changelogen --repo=kazupon/eslint-config",
+    "release": "bumpp --commit \"release: v%s\" --all --push --tag",
+    "lint": "run-p \"lint:* {@}\" --",
+    "lint:prettier": "prettier . --check",
+    "lint:eslint": "eslint .",
+    "fix": "run-p \"fix:* {@}\" --",
+    "fix:prettier": "prettier . --write",
+    "fix:eslint": "eslint . --fix",
+    "dev": "pnpx @eslint/config-inspector --config eslint.config.ts",
+    "build": "tsdown",
+    "build:inspector": "pnpm build && pnpx @eslint/config-inspector build",
+    "typecheck": "tsc -p ."
+  }
+}