Skip to content

Commit 4f669a5

Browse files
committed
Code cleanup, fixed test import, changelog, readme
1 parent d079b06 commit 4f669a5

File tree

12 files changed

+841
-757
lines changed

12 files changed

+841
-757
lines changed

.prettierrc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
"trailingComma": "none",
55
"printWidth": 120,
66
"arrowParens": "avoid",
7-
"singleQuote": true
7+
"singleQuote": true,
8+
"semi": false
89
}

CHANGELOG.md

Lines changed: 76 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,127 @@
11
# **streambuf** Changelog
22

3+
### [2.0.0] (4-jul-2024)
4+
5+
- Removed support for non-new constructor, changed export
6+
- Simplified file structure
7+
38
### [1.3.0] (29-jun-2024)
4-
- Added `readString0` and `writeString0` methods
5-
- Added `readIntLE`, `readIntBE`, `readUIntLE`, `readUIntBE`, `writeIntLE`, `writeIntBE`, `writeUIntLE`, `writeUIntBE` methods
6-
- Added `length` property to the StreamBuffer class
7-
- Added extra TS param typings
8-
- Added more tests
9-
- test for checking every numeric and write method is tested for length
10-
- test for checking if every Buffer read/write method is implemented in StreamBuffer
11-
- Added .prettierrc
12-
- Refactored deprecated Buffer method `slice` to `subarray`
9+
10+
- Added `readString0` and `writeString0` methods
11+
- Added `readIntLE`, `readIntBE`, `readUIntLE`, `readUIntBE`, `writeIntLE`, `writeIntBE`, `writeUIntLE`, `writeUIntBE` methods
12+
- Added `length` property to the StreamBuffer class
13+
- Added extra TS param typings
14+
- Added more tests
15+
- test for checking every numeric and write method is tested for length
16+
- test for checking if every Buffer read/write method is implemented in StreamBuffer
17+
- Added .prettierrc
18+
- Refactored deprecated Buffer method `slice` to `subarray`
1319

1420
### [1.2.3] (20-aug-2022)
15-
- Code test coverage increased to 100%
16-
- Boundary checks for `setPos`/`seek` and `skip`
21+
22+
- Code test coverage increased to 100%
23+
- Boundary checks for `setPos`/`seek` and `skip`
1724

1825
### [1.2.0 - 1.2.2] (16-aug-2022)
19-
- TypeScript rewrite
20-
- Major performance improvements for numeric read and write methods
21-
- Added CHANGELOG
26+
27+
- TypeScript rewrite
28+
- Major performance improvements for numeric read and write methods
29+
- Added CHANGELOG
2230

2331
### [1.1.4] (01-jan-2022)
24-
- Added BigInt support
32+
33+
- Added BigInt support
2534

2635
### [1.1.3] (31-dec-2021)
27-
- Removed Travis CI integration
28-
- Added GitHub Actions integration
29-
- Added `readChar` and `writeChar`
30-
- Added `writeString7`
31-
- Fix: prevent `skip`/`seek`/`setPos` from going out of bounds
36+
37+
- Removed Travis CI integration
38+
- Added GitHub Actions integration
39+
- Added `readChar` and `writeChar`
40+
- Added `writeString7`
41+
- Fix: prevent `skip`/`seek`/`setPos` from going out of bounds
3242

3343
### [1.1.2] (19-feb-2021)
34-
- Minor changes to README and package.json keywords
44+
45+
- Minor changes to README and package.json keywords
3546

3647
### [1.1.1] (18-feb-2021)
37-
- Minor changes to README
48+
49+
- Minor changes to README
3850

3951
### [1.1.0] (18-feb-2021)
40-
- Replaced ava with aqa because of the constant dependabot security issues with ava's numerous dependencies
52+
53+
- Replaced ava with aqa because of the constant dependabot security issues with ava's numerous dependencies
4154

4255
### [merge] (16-feb-2021)
43-
- dependabot ini bump due to security issue in ini (through ava)
56+
57+
- dependabot ini bump due to security issue in ini (through ava)
4458

4559
### [merge] (10-dec-2020)
46-
- dependabot ini bump due to security issue in lodash (through ava)
60+
61+
- dependabot ini bump due to security issue in lodash (through ava)
4762

4863
### [1.0.13] (06-apr-2020)
49-
- Updated ava from 1.1.0 to 3.6.0 following npm audit issues
50-
- Added keywords to package.json
64+
65+
- Updated ava from 1.1.0 to 3.6.0 following npm audit issues
66+
- Added keywords to package.json
5167

5268
### [1.0.12] (05-apr-2020)
53-
- Updated package-lock.json due to a security issue in lodash (through ava)
69+
70+
- Updated package-lock.json due to a security issue in lodash (through ava)
5471

5572
### [1.0.11] (17-jul-2019)
56-
- Updated package-lock.json due to a security issue in lodash (through ava)
73+
74+
- Updated package-lock.json due to a security issue in lodash (through ava)
5775

5876
### [1.0.10] (28-jun-2019)
59-
- Updated package-lock.json due to a security issue in js-yaml (through ava)
77+
78+
- Updated package-lock.json due to a security issue in js-yaml (through ava)
6079

6180
### [1.0.9] (25-jan-2019)
62-
- Updated ava from 0.24.0 to 1.1.0 following npm audit issues
81+
82+
- Updated ava from 0.24.0 to 1.1.0 following npm audit issues
6383

6484
### [1.0.8] (30-dec-2017)
65-
- Added Travis CI integration and fancy build status badge
85+
86+
- Added Travis CI integration and fancy build status badge
6687

6788
### [1.0.7] (29-dec-2017)
68-
- Added 7-bit integer methods and tests
69-
- Added the API to the README
89+
90+
- Added 7-bit integer methods and tests
91+
- Added the API to the README
7092

7193
### [1.0.6] (29-dec-2017)
72-
- Added xFloat and xDouble Buffer methods support
94+
95+
- Added xFloat and xDouble Buffer methods support
7396

7497
### [1.0.5] (29-dec-2017)
75-
- Added write methods, so streambuf is no longer a read-only library
98+
99+
- Added write methods, so streambuf is no longer a read-only library
76100

77101
### [1.0.4] (28-dec-2017)
78-
- Minor README change
102+
103+
- Minor README change
79104

80105
### [1.0.3] (28-dec-2017)
81-
- Added many tests
82-
- Rewrote integer methods
83-
- Added LICENSE
106+
107+
- Added many tests
108+
- Rewrote integer methods
109+
- Added LICENSE
84110

85111
### [1.0.2] (27-dec-2017)
86-
- Added usage and examples to README
112+
113+
- Added usage and examples to README
87114

88115
### [1.0.1] (27-dec-2017)
89-
- Added README
116+
117+
- Added README
90118

91119
### [1.0.0] (27-dec-2017)
92-
- Initial release
93-
- Created git repository
94-
- Published NPM package
120+
121+
- Initial release
122+
- Created git repository
123+
- Published NPM package
95124

96125
### [local] (06-jan-2015)
97-
- Very first version! Originally used StreamBuffer to read and walk through old game data files and extract images and sounds
126+
127+
- Very first version! Originally used StreamBuffer to read and walk through old game data files and extract images and sounds

0 commit comments

Comments
 (0)