Skip to content

docs: update readme to include node version #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: update readme to include node version #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/compat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ This package contains functions that allow you to wrap existing ESLint rules, pl

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

For Node.js and compatible runtimes:

```shell
Expand Down
2 changes: 2 additions & 0 deletions packages/config-array/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ A config array is a way of managing configurations that are based on glob patter

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

For Node.js and compatible runtimes:

```shell
Expand Down
2 changes: 2 additions & 0 deletions packages/config-helpers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Helper utilities for creating ESLint configuration.

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

For Node.js and compatible runtimes:

```shell
Expand Down
4 changes: 4 additions & 0 deletions packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ This package is the future home of the rewritten, runtime-agnostic ESLint core.

Right now, it exports the core types necessary to implement language plugins.

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

## License

Apache 2.0
Expand Down
4 changes: 4 additions & 0 deletions packages/mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

[Model Context Protocol](https://modelcontextprotocol.io) (MCP) server for ESLint.

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

## Usage

The ESLint MCP server is designed to be run by an IDE-based MCP client like [Visual Studio Code's Copilot](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode). The command is:
Expand Down
4 changes: 4 additions & 0 deletions packages/migrate-config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ This tool currently works well for the following config file formats:

If you are using a JavaScript configuration file (`.eslintrc.js`, `.eslintrc.cjs`, `.eslintrc.mjs`), this tool currently is only capable of migrating the _evaluated_ configuration. That means any logic you may have inside of the file will be lost. If your configuration file is mostly static, then you'll get a good result; if your configuration file is more complex (using functions, calculating paths, etc.) then this tool will not provide an equivalent configuration file.

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

## Usage

You can run this package on the command line without installing it first by using `npx` or a similar tool:
Expand Down
2 changes: 2 additions & 0 deletions packages/object-schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A JavaScript object merge/validation utility where you can define a different me

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

For Node.js and compatible runtimes:

```shell
Expand Down
2 changes: 2 additions & 0 deletions packages/plugin-kit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A collection of utilities to help build ESLint plugins.

## Installation

Prerequisites: Node.js (^20.19.0, ^22.13.0, or >=24) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

For Node.js and compatible runtimes:

```shell
Expand Down