Getting Started
Installation
Install and set up @eienjs/eslint-config using the interactive CLI wizard or manual configuration.
You can set up @eienjs/eslint-config in seconds using the interactive CLI wizard or by installing the package manually.
Interactive CLI Wizard (Recommended)
Run the CLI wizard in your project root to automatically install required dependencies, generate eslint.config.js, migrate any existing .eslintignore, and configure .vscode/settings.json:
pnpm dlx @eienjs/eslint-config@latest
npx @eienjs/eslint-config@latest
bunx @eienjs/eslint-config@latest
See the CLI Wizard guide for non-interactive flags and framework templates.
Manual Installation
Install the packages
Install @eienjs/eslint-config and eslint as development dependencies:
pnpm add -D @eienjs/eslint-config eslint
npm install -D @eienjs/eslint-config eslint
yarn add -D @eienjs/eslint-config eslint
If you plan to enable optional integrations such as
adonisjs, nuxt, astro, formatters, or erasableSyntaxOnly, see Frameworks for their respective optional peer dependencies.Create the configuration file
Create eslint.config.js (or eslint.config.mjs if your package.json does not have "type": "module") in your project root:
eslint.config.js
import eienjs from '@eienjs/eslint-config';
export default eienjs();
Add lint scripts to package.json
Add scripts to check and auto-fix files across your repository:
package.json
{
"scripts": {
"lint": "eslint . --fix",
"lint:check": "eslint ."
}
}
Verify the setup
Run the lint check command to verify everything works:
pnpm run lint:check
Next Steps
- Learn how to customize every preset option in Configuration.
- Configure your IDE for auto-fix on save in Editor Integration.