Skip to content

Commit 9836ef1

Browse files
committed
Prepare for v3.0.0
1 parent 833069f commit 9836ef1

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## v3.0.0
4+
5+
- **\[Breaking changes\]** Drop older Node.js version (now ensures v20.19.5 or later)
6+
- **\[Maybe breaking changes\]** Change following enum types to `const` object and `type` definition:
7+
- `VersionFileFlags`
8+
- `VersionFileOS`
9+
- `VersionFileDriverSubtype`
10+
- `VersionFileFontSubtype`
11+
- `VersionFileType`
12+
- (development) Update devDependencies packages excluding `typescript`
13+
314
## v2.0.3
415

516
- Fix icon item image size to ignore biImageSize when biCompression is BI_RGB (#56)

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ To use in command line, consider using [resedit-js-cli](https://www.npmjs.com/pa
1212
The demo page: [resedit demo](https://www.pg-fl.jp/program/resedit/index.en.htm)
1313

1414
- [Install](#install)
15+
- [Migrate from v2.x to v3.x](#migrate-from-v2x-to-v3x)
1516
- [Migrate from v1.x to v2.x](#migrate-from-v1x-to-v2x)
1617
- [Supported formats](#supported-formats)
1718
- [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)
2627
npm install resedit
2728
```
2829

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+
2942
## Migrate from v1.x to v2.x
3043

3144
- If you use from ES module (.mjs) and load by using `import`, no need for migration.

0 commit comments

Comments
 (0)