Skip to content

Commit 23a28d5

Browse files
committed
fix: fix readme files
1 parent 3b35416 commit 23a28d5

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ npx codemod@latest <codemod-name>
1818
For example:
1919

2020
```bash
21-
npx codemod@latest @eslint/v8-to-v9
21+
npx codemod@latest @eslint/v8-to-v9-config
2222
```
2323

2424
### From source

codemods/v9/custom-rules/README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Automatically migrate your custom ESLint rules from v8 to v9 format.
44

55
## Overview
66

7+
> [!CAUTION]
8+
> **Important:** Run this codemod only in directories containing ESLint rule files. It may incorrectly transform other JavaScript files that use `module.exports` to export functions.
9+
710
This codemod transforms your custom ESLint rules to be compatible with ESLint v9. It handles all breaking changes in the custom rule API, including context method removals, new rule structure requirements, and deprecated APIs.
811

912
## What This Codemod Does
@@ -44,14 +47,6 @@ npx codemod@latest run @eslint/v8-to-v9-custom-rules
4447
npx codemod@latest workflow run -w workflow.yaml
4548
```
4649

47-
You'll be prompted to provide paths to your rule files or directories:
48-
49-
```bash
50-
# The codemod will ask for paths during execution
51-
Enter custom rules paths (comma-separated):
52-
src/eslint-rules, lib/rules/custom-rule.js
53-
```
54-
5550
## Manual Steps Required
5651

5752
After running this codemod, you need to:

0 commit comments

Comments
 (0)