![\"@tada5hi/eslint-config\"](\"https://raw.githubusercontent.com/tada5hi/javascript/HEAD/packages/eslint-config/assets/logo.svg\"){kind=logo}
\n\n \n
\n Shared ESLint flat config for JavaScript projects, with optional TypeScript and Vue support.\n
\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [JavaScript](#javascript)\n - [TypeScript](#typescript)\n - [Vue](#vue)\n - [Vue + TypeScript](#vue--typescript)\n - [Options](#options)\n - [User Overrides](#user-overrides)\n- [Auto-Detection](#auto-detection)\n- [License](#license)\n\n## Installation\n\n```bash\nnpm install --save-dev @tada5hi/eslint-config eslint\n```\n\nFor TypeScript support, also install:\n\n```bash\nnpm install --save-dev typescript-eslint typescript\n```\n\nFor Vue support, also install:\n\n```bash\nnpm install --save-dev eslint-plugin-vue\n```\n\n## Usage\n\nCreate an `eslint.config.js` (or `eslint.config.mjs`) in your project root.\nThe package exports an async factory function that returns an ESLint flat config array.\n\n### JavaScript\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig();\n```\n\n### TypeScript\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig({\n typescript: true,\n});\n```\n\nWith type-aware linting:\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig({\n typescript: { project: './tsconfig.json' },\n});\n```\n\n### Vue\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig({\n vue: true,\n});\n```\n\n### Vue + TypeScript\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig({\n typescript: { project: './tsconfig.json' },\n vue: true,\n});\n```\n\n### Options\n\n| Option | Type | Default | Description |\n|--------|------|---------|-------------|\n| `typescript` | `boolean \\| TypeScriptOptions` | auto-detect | Enable TypeScript rules. Pass `{ project: './tsconfig.json' }` for type-aware linting, or `{ project: true }` for `projectService`. |\n| `vue` | `boolean \\| VueOptions` | auto-detect | Enable Vue rules. When TypeScript is also enabled, the TS parser is automatically configured for `.vue` files. |\n\n### User Overrides\n\nAdditional flat config objects can be passed as variadic arguments after the options:\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig(\n { typescript: true },\n {\n rules: {\n 'no-console': 'off',\n },\n },\n {\n ignores: ['dist/**'],\n },\n);\n```\n\n## Auto-Detection\n\nWhen `typescript` or `vue` options are not explicitly set, the factory auto-detects whether to enable them by checking if the `typescript` or `vue` packages are installed. This means in most cases you can simply use:\n\n```js\nimport eslintConfig from '@tada5hi/eslint-config';\n\nexport default eslintConfig();\n```\n\n## What's Included\n\nThe config always includes these rule sets:\n\n- **JavaScript** - `@eslint/js` recommended + best-practice rules, ES6+ enforcement\n- **Stylistic** - `@stylistic/eslint-plugin` for indent (4 spaces), quotes (single), max line length (150)\n- **Imports** - `eslint-plugin-import-x` for import ordering, cycle detection, and more\n- **Unicorn** - `eslint-plugin-unicorn` for modern JS patterns (node: protocol, Array.isArray, etc.)\n\nConditionally adds:\n\n- **TypeScript** - `typescript-eslint` recommended rules, base-rule swaps, type-aware rules\n- **Vue** - `eslint-plugin-vue` flat/recommended, html-indent (4 spaces), TS parser for `.vue` files\n\n## License\n\nMade with 💚\n\nPublished under [MIT License](./LICENSE).\n","readmeFilename":"README.MD"}