From 2e5906c5fce99ad2307ccbf95279918736727517 Mon Sep 17 00:00:00 2001 From: Sweta Tanwar Date: Tue, 18 Nov 2025 21:22:22 +0530 Subject: [PATCH] doc: update readme to include node version --- packages/compat/README.md | 2 ++ packages/config-array/README.md | 2 ++ packages/config-helpers/README.md | 2 ++ packages/core/README.md | 4 ++++ packages/mcp/README.md | 4 ++++ packages/migrate-config/README.md | 4 ++++ packages/object-schema/README.md | 2 ++ packages/plugin-kit/README.md | 2 ++ 8 files changed, 22 insertions(+) diff --git a/packages/compat/README.md b/packages/compat/README.md index d6338b893..b87c2ef49 100644 --- a/packages/compat/README.md +++ b/packages/compat/README.md @@ -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 diff --git a/packages/config-array/README.md b/packages/config-array/README.md index 19af407e3..309a883da 100644 --- a/packages/config-array/README.md +++ b/packages/config-array/README.md @@ -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 diff --git a/packages/config-helpers/README.md b/packages/config-helpers/README.md index a06051357..7de2f5c14 100644 --- a/packages/config-helpers/README.md +++ b/packages/config-helpers/README.md @@ -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 diff --git a/packages/core/README.md b/packages/core/README.md index 700abb165..738a1b777 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -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 diff --git a/packages/mcp/README.md b/packages/mcp/README.md index aa68dcd3d..9da21c546 100644 --- a/packages/mcp/README.md +++ b/packages/mcp/README.md @@ -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: diff --git a/packages/migrate-config/README.md b/packages/migrate-config/README.md index 69601014c..e641cb38a 100644 --- a/packages/migrate-config/README.md +++ b/packages/migrate-config/README.md @@ -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: diff --git a/packages/object-schema/README.md b/packages/object-schema/README.md index a308915df..2d62f2c51 100644 --- a/packages/object-schema/README.md +++ b/packages/object-schema/README.md @@ -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 diff --git a/packages/plugin-kit/README.md b/packages/plugin-kit/README.md index 52da7a968..cd57eef02 100644 --- a/packages/plugin-kit/README.md +++ b/packages/plugin-kit/README.md @@ -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