Skip to content

docs: add eslint-plugin-node migration guide - #561

Merged
aladdin-add merged 1 commit into
eslint-community:masterfrom
raisulchowdhury:codex-178-migration-docs
Aug 6, 2026
Merged

aladdin-add merged 1 commit into
eslint-community:masterfrom
raisulchowdhury:codex-178-migration-docs

Conversation

@raisulchowdhury

Copy link
Copy Markdown

Summary

  • Add a migration guide for users moving from eslint-plugin-node to eslint-plugin-n.
  • Document package, legacy and flat-config, rule-prefix, inline-comment, and shared-settings changes.
  • Link the guide from the README.

Closes #178

Validation: markdownlint passes for the README and guide; Prettier and git diff --check pass.

AI assistance: OpenAI Codex assisted with the implementation and validation; the contributor reviewed the final diff and current configuration semantics.

Assisted-by: OpenAI Codex
Signed-off-by: raisulchowdhury <34920788+raisulchowdhury@users.noreply.github.com>
Copilot AI review requested due to automatic review settings August 1, 2026 18:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ’‘ Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 07f34f2778

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with πŸ‘.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/migration.md

```js
import n from "eslint-plugin-n"
import { defineConfig } from "eslint/config"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the flat-config example compatible with supported ESLint

For users migrating while remaining on ESLint 8.57.1 or an earlier ESLint 9 releaseβ€”versions this package explicitly supportsβ€”defineConfig with extends is unavailable, so this example fails before linting begins. Show the broadly compatible export default [n.configs["flat/recommended-module"]] form, or clearly state the newer ESLint version required and provide the compatible alternative.

Useful? React with πŸ‘Β / πŸ‘Ž.

@aladdin-add aladdin-add left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! πŸ’―

@aladdin-add
aladdin-add merged commit 4138d4e into eslint-community:master Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add docs migrating from eslint-plugin-node

3 participants