ESLint Rule Composer
Creates custom ESLint rules using the ESLint RuleTester API and AST Explorer patterns. Generates rule implementations with auto-fix suggestions based on estree node types and scope analysis.
Installation
Use the upstream install or setup path that matches your environment:
- npm init @eslint/config@latest
- npx eslint yourfile.js
Requirements and caveats from upstream:
- To use ESLint, you must have Node.js (^20.19.0, ^22.13.0, or >=24) installed and built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)
- node-linker=hoisted
Which Node.js versions does ESLint support?
Basic usage or getting-started notes:
If you use ESLint's TypeScript type definitions, TypeScript 5.3 or later is required.
npm Installation
Source: https://github.com/eslint/eslint
Extracted from upstream docs: https://raw.githubusercontent.com/eslint/eslint/HEAD/README.md