Skip to content

Commit 2d09b5e

Browse files
docs: standardize changelog format, add detail
1 parent d6a105d commit 2d09b5e

File tree

1 file changed

+65
-29
lines changed

1 file changed

+65
-29
lines changed

CHANGELOG.md

Lines changed: 65 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,95 @@
11
# Changelog
22

3-
## v0.3.0
3+
[npm history](https://www.npmjs.com/package/eslint-plugin-rxjs-x?activeTab=versions)
4+
5+
## v0.3.0 (2024-11-15)
6+
7+
### Breaking Changes
8+
9+
- **ban-operators**: improve type checking of banned operators, report error at usage instead of in import statement ([#25](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/25)) ([994ff25](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/994ff25391cc4efbb2f2cfa99c323c7280e9d1b5))
10+
- **throw-error**: stop linting regular `throw` statements ([#22](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/22)) ([02fdffd](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/02fdffde6b9376621b902d2ebbae4fb8080d29f1))
411

512
### Features
613

714
- **no-ignored-default-value**: new rule for enforcing `defaultValue` ([#15](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/15)) ([9bd896e](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/9bd896e0acb87cce2931ecda8b683fb5e9a8837c))
8-
- **ban-operators**!: improve type checking of banned operators, report error at usage instead of in import statement ([#25](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/25)) ([994ff25](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/994ff25391cc4efbb2f2cfa99c323c7280e9d1b5))
9-
- **throw-error**!: stop linting regular `throw` statements ([#22](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/22)) ([02fdffd](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/02fdffde6b9376621b902d2ebbae4fb8080d29f1))
1015

11-
## v0.2.4
16+
## v0.2.4 (2024-11-09)
1217

1318
### Features
1419

1520
- **macro**: deprecated ([#13](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/13)) ([39be258](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/39be258ad359bd1e79f057302d7ffe12954f9c14))
1621

17-
## v0.2.3
22+
## v0.2.3 (2024-11-08)
1823

19-
### Fixes
24+
### Bug Fixes
2025

2126
- **no-ignored-replay-buffer**: check config bufferSize ([#12](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/12)) ([ef2f886](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/ef2f8866684ed6f918eb8c465e90a1de8982186a))
2227

2328
### Chores
2429

25-
- rxjs as an optional peer dependency ([90b03e6](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/90b03e6a01e0357603eb6426638ca43e0f392dca))
30+
- change `rxjs` to an optional peer dependency ([90b03e6](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/90b03e6a01e0357603eb6426638ca43e0f392dca))
31+
32+
## v0.2.2 (2024-11-07)
33+
34+
### Breaking Changes
35+
36+
- TypeScript >=4.7.4 is required
2637

27-
## v0.2.2
38+
### Bug Fixes
2839

29-
- Fixed broken imports in ESM configs using typescript versions lower than 5.5.
40+
- fix broken imports in ESM configs using TypeScript versions lower than 5.5 ([#11](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/11)) ([1693df0](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/1693df0423acb1eb7cef237620ed31d2ee5520fa))
3041

31-
## v0.2.1
42+
## v0.2.1 (2024-11-07)
3243

33-
- Decreased minimum `typescript-eslint` version to ^8.1.0 (matches import-x plugin).
44+
### Chores
45+
46+
- decrease minimum `typescript-eslint` version to ^8.1.0 ([#10](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/10)) ([e7d0d70](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/e7d0d7078b50d1ef72c48318159a80ce481ef73c))
47+
48+
## v0.2.0 (2024-11-05)
3449

35-
## v0.2.0
50+
### Breaking Changes
3651

37-
- Improved CJS typing to avoid needing `.default`.
38-
- Added options documentation to rule docs.
52+
- improve CommonJS typing to avoid needing `.default` ([#4](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/4)) ([0b47390](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/0b473900c141403a1eb45e5a44fd2f2b43ebb6d5))
3953

40-
## v0.1.0
54+
### Documentation
4155

42-
- Replaced `tsutils` dependency with `ts-api-utils`.
43-
- Removed `tsutils-etc` dependency.
56+
- add options documentation to rule docs ([#6](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/6)) ([ee705d2](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/ee705d23efe7c779bfabb855e82130c664ba35c4))
4457

45-
## v0.0.2
58+
## v0.1.0 (2024-11-04)
4659

47-
- Fixed wrong types for CJS.
60+
### Breaking Changes
61+
62+
- TypeScript >=4.2.0 is required
63+
- `tslib` ^2.1.0 is required
64+
65+
### Chores
4866

49-
## v0.0.1
67+
- drop dependencies `tsutils` and `tsutils-etc`, add dependency `ts-api-utils` ([#3](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/3)) ([c64f9f6](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/c64f9f6bd810f7d114c9dac9f6ab72df1b2d2e31))
68+
69+
## v0.0.2 (2024-11-01)
70+
71+
### Bug Fixes
72+
73+
- fix wrong types for CommonJS ([#2](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/pull/2)) ([2d330aa](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/commit/2d330aa943f31bbb7831607c0573b9c8e41d8268))
74+
75+
## v0.0.1 (2024-11-01)
76+
77+
Initial prerelease version.
78+
79+
### Breaking Changes
80+
81+
- `eslint` ^8.57.0 || 9.0.0 is required
82+
- `typescript-eslint` ^8 is required
83+
- Node.js ^18.18.0 || ^20.9.0 || >= 21.1.0 is required
84+
85+
### Bug Fixes
86+
87+
- **no-implicit-any-catch**: fix `typeAnnotation` bug breaking linting.
88+
89+
### Chores
5090

51-
- Initial release after fork.
52-
- `eslint` ^8.57.0 || 9.0.0
53-
- `typescript-eslint` ^8
54-
- Node.js ^18.18.0 || ^20.9.0 || >= 21.1.0
55-
- Removed dependency `eslint-etc`.
56-
- Removed dependency `requireindex`.
57-
- Fixed `typeAnnotation` bug breaking no-implicit-any-catch.
58-
- Added `requiresTypeChecking` to `meta.docs` of relevant rules.
59-
- Switched from mocha to vitest.
91+
- drop dependency `eslint-etc`
92+
- drop dependency `requireindex`
93+
- add `rxjs` >=7 as peer dependency
94+
- add `requiresTypeChecking` to `meta.docs` of relevant rules
95+
- switch from mocha to vitest

0 commit comments

Comments
 (0)