generator-eslint !CI 

The ESLint generator for Yeoman. This generator is intended to aid development within the ESLint project. It is designed to work within the top-level eslint directory.

Installation

First and foremost, you must have Node.js and npm installed. If you don't have Node.js installed, please download and install the latest version.

> Requirements
>
> - Node.js ^20.19.0 || ^22.13.0 || >=24

You must also install Yeoman, if you don't have it installed already. To install Yeoman, you can run this command:

``sh
npm i -g yo
`

With Node.js and Yeoman installed, you can run this command:

`sh
npm i -g generator-eslint
`

Usage

The Yeoman generator currently supports the following commands:

$3

If you want to create a new ESLint plugin, make sure you're in the top-level directory where you want the plugin to be created and type:

`sh
yo eslint:plugin
`

You'll be prompted for information about your plugin and it will generate a package.json file, README, and source code for a stub plugin.

$3

If you want to create a new ESLint rule, make sure you're in the top-level directory of an ESLint repo clone or an ESLint plugin and type:

`sh
yo eslint:rule
``

You'll be prompted for some information and then it will generate the files necessary for a new rule, including the source file, a test file, and a documentation file.

License and Copyright

Copyright OpenJS Foundation and other contributors,

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