You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ To use in command line, consider using [resedit-js-cli](https://www.npmjs.com/pa
12
12
The demo page: [resedit demo](https://www.pg-fl.jp/program/resedit/index.en.htm)
13
13
14
14
-[Install](#install)
15
+
-[Migrate from v2.x to v3.x](#migrate-from-v2x-to-v3x)
15
16
-[Migrate from v1.x to v2.x](#migrate-from-v1x-to-v2x)
16
17
-[Supported formats](#supported-formats)
17
18
-[Parsing signed executables](#parsing-signed-executables)
@@ -26,6 +27,18 @@ The demo page: [resedit demo](https://www.pg-fl.jp/program/resedit/index.en.htm)
26
27
npm install resedit
27
28
```
28
29
30
+
## Migrate from v2.x to v3.x
31
+
32
+
This major version up includes 'Change requirements of Node.js version (_v20.19.5 or later_ is required)' and 'Remove TypeScript enum usage' only. If your code base (project) meets following conditions, you can safely upgrade to v3.x (without no more actions):
33
+
34
+
- You uses resedit v2.x
35
+
- If you use v1.x, please follow [Migrate from v1.x to v2.x](#migrate-from-v1x-to-v2x).
36
+
- The code base already uses Node.js v20.19.5 or later (including v22, v24, or higher)
37
+
- Node.js v18 or earlier is already end-of-life. Upgrade to v22 or v24 is recommended.
38
+
- For using Node.js v20, upgrading to v20.19.5 or later would not be difficult.
39
+
- Following enum's members are not used or used only as values: `VersionFileFlags`, `VersionFileOS`, `VersionFileDriverSubtype`, `VersionFileFontSubtype`, and `VersionFileType`
40
+
- If you use the members as types (e.g. `let x: VersionFileFlags.Debug`), rewrite with using `typeof` (e.g, `let x: typeof VersionFileFlags.Debug`).
41
+
29
42
## Migrate from v1.x to v2.x
30
43
31
44
- If you use from ES module (.mjs) and load by using `import`, no need for migration.
0 commit comments