# generator-eslint

> A Yeoman generator for creating ESLint plugins/rules

Latest version **6.1.1** (published 2026-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-eslint
pnpm add generator-eslint
yarn add generator-eslint
bun add generator-eslint
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 6.1.1 |
| Published | 2026-08-01 |
| First published | 2014-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | ^20.19.0 \|\| ^22.13.0 \|\| >=24 |
| Dependencies | 1 |
| Unpacked size | 21 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 246 |
| Author | ESLint |
| Maintainers | openjsfoundation, eslintbot |
| Keywords | eslint, yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-eslint
- Repository: https://github.com/eslint/generator-eslint
- Issues: https://github.com/eslint/generator-eslint/issues
- Funding: https://opencollective.com/eslint
- npm.io page: https://npm.io/package/generator-eslint

## Dependencies (1)

- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^8.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 6.1.1 (latest) — 2026-08-01
- 6.1.0 — 2026-03-09
- 6.0.0 — 2026-01-30
- 5.2.2 — 2025-10-07
- 5.2.1 — 2025-09-22
- 5.2.0 — 2025-07-21
- 5.1.3 — 2025-07-02
- 5.1.2 — 2024-12-30
- 5.1.1 — 2024-10-19
- 5.1.0 — 2024-05-24
- 5.0.0 — 2024-01-12
- 4.1.5 — 2023-07-31
- 4.1.3 — 2023-02-28
- 4.1.1 — 2022-12-31
- 4.1.0 — 2022-12-14
- … 18 more at https://npm.io/package/generator-eslint/versions

## README

# generator-eslint ![CI](https://github.com/eslint/generator-eslint/workflows/CI/badge.svg) [![NPM version](https://img.shields.io/npm/v/generator-eslint.svg?style=flat)](https://npmjs.org/package/generator-eslint)

The ESLint generator for [Yeoman](https://yeoman.io/). This generator is intended to aid development within the [ESLint](https://eslint.org/) project. It is designed to work within the top-level `eslint` directory.

## Installation

First and foremost, you must have [Node.js](https://nodejs.org/) 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:

### eslint:plugin

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.

### eslint:rule

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, <www.openjsf.org>

[MIT License](https://en.wikipedia.org/wiki/MIT_License)

<!-- markdownlint-disable MD033 -->
<!-- NOTE: This section is autogenerated. Do not manually edit.-->
<!--sponsorsstart-->

## Sponsors

The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate)
to get your logo on our READMEs and [website](https://eslint.org/sponsors).

<h3>Platinum Sponsors</h3>
<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a></p><h3>Gold Sponsors</h3>
<p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a> <a href="https://www.coderabbit.ai/?utm_source=cr_org&utm_medium=github"><img src="https://avatars.githubusercontent.com/u/132028505" alt="CodeRabbit" height="96"></a></p><h3>Silver Sponsors</h3>
<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/d472863/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/2d6c3b6/logo.png" alt="Liftoff" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://opensource.sap.com"><img src="https://avatars.githubusercontent.com/u/2531208" alt="SAP" height="32"></a> <a href="https://apuesdeportivas.es/"><img src="https://images.opencollective.com/apuesdeportivas-es/6ecf644/avatar.png" alt="apuesdeportivas.es" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://citadel-ai.com"><img src="https://avatars.githubusercontent.com/u/75781367" alt="Citadel AI" height="32"></a></p>
<h3>Technology Sponsors</h3>
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.
<p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>
<!--sponsorsend-->
<!-- markdownlint-enable MD033 -->

---
_Source: https://npm.io/package/generator-eslint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
