Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 3.05 KB

README.md

File metadata and controls

77 lines (47 loc) · 3.05 KB


ESLint Config Inspector

npm version npm downloads

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

Screenshot 1 Screenshot 2

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 .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:

To start the development server:

To test the production build:

License

Apache-2.0 License