UNPKG

code-migration-helpers

Version:

Provides useful (but currently not thorough) code migration helpers

github.com/softkave/code-migration-helpers

softkave/code-migration-helpers

84 lines (52 loc) • 2.15 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
72
73
74
75
76
77
78
79
80
81
82
83
84
# Softkave Code Migration Helper ## Overview A collection of useful code migration scripts. Currently provides the following: - Replacing/adding relative import extensions in code. E.g. `import some from "./thing"` can become `import some from "./thing.js"`. - Importing `vitest` test constructs in a test file. Useful when moving from `jest` to `vitest`. - Replacing filename extenstions for matching extensions. E.g. `some-file.js` can become `some-file.cjs`. **NOTE: modifications may not always be accurate, so it's best to work off a separate branch without any changes, incase you want to revert all changes and run again.** ## Install ### `npm` ```sh npm install code-migration-helpers -D ``` ### `npm` one time run ```sh npx code-migration-helpers --help ``` ## Usage ### `help` Prints help. ```sh npx code-migration-helpers help ``` ### `version` Prints version. ```sh npx code-migration-helpers version ``` ### `add-ext` Add extensions to relative `import` or `require` calls. Relative meaning `./some-file` or `../some-folder/some-file`. #### Arguments - `-f` - `Required` file or folder path. - `--from` - `Optional` extension to replace. If empty, all relative imports are considered in scope. - `--to` - `Optional` extension to replace with. If empty, it'll try to figure out the right extension. i.e. Imported files ending in [`.js`, `.ts`] become `.js`, [`.cjs`, `.cts`] become `.cjs`, [`.mjs`, `.mts`] become `.mjs`. ```sh npx code-migration-helpers add-ext -f="./fpath" ``` ### `jest-to-vitest` Imports `vitest` test constructs if found in files-in-scope. E.g. `expect`, `test`, `beforeAll`, etc. and also replaces calls to `jest.fn()` with `vi.fn()`. #### Arguments - `-f` - `Required` file or folder path. ```sh npx code-migration-helpers jest-to-vitest -f="./fpath" ``` ### `rename-ext` Renames file extensions for files-in-scope. E.g. `some-file.js` can become `some-file.cjs`. #### Arguments - `-f` - `Required` file or folder path. - `--from` - `Required` extension to replace. - `--to` - `Required` extension to replace with. ```sh npx code-migration-helpers jest-to-vitest -f="./fpath" ```