UNPKG

@orderly.network/codemod

Version:

`orderly-codemod` is a command-line tool to help you migrate the package import and `OrderlyAppProvider` configuration from v1 to v2

71 lines (45 loc) • 1.63 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Orderly Codemod `orderly-codemod` is a command-line tool to help you migrate the package import and `OrderlyAppProvider` configuration from v1 to v2 ## Usage ```bash npx @orderly.network/codemod [OPTION] PATH ``` - `PATH`: Specifies the file or directory path to be transformed (required). ### Options - `-p, --parser <string>` Specifies the parser for source files. Supported options: - `babel` - `babylon` - `flow` - `ts` - `tsx` Default: `tsx`. Please note that when using TypeScript, you need to use the tsx parser; otherwise, the codemod cannot be correctly applied! - `--ext, --extensions <string>` Specifies file extensions to transform, with multiple extensions separated by commas. Default: `tsx`. - `-i, --ignore <string>` Specifies a glob pattern to ignore files. Default: `node_modules`. ### Examples - **Scan all `.tsx` files in a specified directory with default settings:** ```bash npx @orderly.network/codemod src/ ``` - **Custom extensions:** ```bash npx @orderly.network/codemod --extensions jsx src/ ``` - **Ignore files in the `dist` folder:** ```bash npx @orderly.network/codemod --ignore dist src/ ``` Note: Applying a codemod may disrupt your existing code formatting, so don’t forget to run prettier and/or eslint after applying the codemod! ### Help Run the following command to display help information: ```bash npx @orderly.network/codemod --help ``` ### Error Handling If no file or directory path is provided, the tool will display an error message: ``` Error: You have to provide at least one file/directory to transform. ```