ESLint Config Inspector

A visual tool for inspecting and understanding your ESLint flat configs.

Usage

Go to the project root that contains eslint.config.js and run:

npx @eslint/config-inspector@latest

Visit http://localhost:7777/ to view and play with your ESLint config. Changes to the config file will be updated automatically.

Run npx @eslint/config-inspector --help to see all the CLI options available.

Online Preview

Or play it right in your browser now:

Static Build

It is also possible to build a static web app for your ESLint config:

npx @eslint/config-inspector build

This will generate a Single-Page Application (SPA) under dist/__eslint-config-inspector, with the snapshot of the current ESLint config. You can deploy it somewhere, or use it for comparison etc.

Run npx @eslint/config-inspector build --help to see all the CLI options available.

Contributing

We operate under the ESLint Contributor Guidelines, so please be sure to read them before contributing. If you're not sure where to dig in, check out the issues.

Development

This project uses the following stack:

• pnpm for package management
• Nuxt & Vue for the app
• devframe for the dev server, RPC transport, and static build
• UnoCSS for styling
• With attributify mode enabled
• Use ESLint for linting and formatting

To start the development server:

• Install dependencies via pnpm install (we highly recommend you to enable corepack enable first)
• Run pnpm cli:dev to build the SPA once and start the inspector at http://localhost:7777
• Run pnpm dev to iterate on Vue components with HMR (the payload fetch will fail without the inspector running)

To test the production build:

• Run pnpm build to build the inspector tool and the CLI
• Run pnpm start to start the production server at http://localhost:7777

License

Apache-2.0 License

Sponsors

The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. Become a Sponsor to get your logo on our READMEs and website.

Platinum Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Technology Sponsors

Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.