@api-extractor-tools/eslint-plugin 0.1.0-alpha.2 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +43 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,48 @@
|
|
|
1
1
|
# @api-extractor-tools/eslint-plugin
|
|
2
2
|
|
|
3
|
+
## 0.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#49](https://github.com/mike-north/api-extractor-tools/pull/49) [`f30c449`](https://github.com/mike-north/api-extractor-tools/commit/f30c449e69eb052722b15e38863ef23312523c6b) Thanks [@mike-north](https://github.com/mike-north)! - feat: add ESLint plugin for API Extractor authoring-time feedback
|
|
8
|
+
|
|
9
|
+
New ESLint plugin providing authoring-time feedback aligned with API Extractor validations:
|
|
10
|
+
- `api-extractor/missing-release-tag`: Detects exported symbols missing release tags (@public, @beta, @alpha, @internal)
|
|
11
|
+
- `api-extractor/override-keyword`: Requires TypeScript `override` keyword when @override TSDoc tag is present
|
|
12
|
+
- `api-extractor/package-documentation`: Ensures entry point files have @packageDocumentation comment
|
|
13
|
+
|
|
14
|
+
Features:
|
|
15
|
+
- Auto-discovery of api-extractor.json configuration
|
|
16
|
+
- Severity levels read from API Extractor config
|
|
17
|
+
- Sharable 'recommended' config for both flat and legacy ESLint formats
|
|
18
|
+
- Auto-fix support for override-keyword rule
|
|
19
|
+
|
|
20
|
+
- [#204](https://github.com/mike-north/api-extractor-tools/pull/204) [`3accc97`](https://github.com/mike-north/api-extractor-tools/commit/3accc97733d1b21eb7bbbe82b122a347e9b5ea76) Thanks [@mike-north](https://github.com/mike-north)! - fix: enforce @packageDocumentation only on package barrel files
|
|
21
|
+
|
|
22
|
+
The `package-documentation` rule now automatically detects whether a file is a package entry point by examining the nearest `package.json`. Barrel files are required to have the `@packageDocumentation` tag, and non-barrel files report an error if the tag is present. Previously the rule required the tag on every file regardless of whether it was an entry point.
|
|
23
|
+
|
|
24
|
+
### Patch Changes
|
|
25
|
+
|
|
26
|
+
- [#182](https://github.com/mike-north/api-extractor-tools/pull/182) [`d77d4d1`](https://github.com/mike-north/api-extractor-tools/commit/d77d4d1657641e16dc98736b88ece121c3d27563) Thanks [@mike-north](https://github.com/mike-north)! - Integrate declaration-file-normalizer into build pipelines and add comprehensive test coverage.
|
|
27
|
+
|
|
28
|
+
**Test Coverage Improvements:**
|
|
29
|
+
- Added comprehensive test suite for declaration-file-normalizer (64 tests total)
|
|
30
|
+
- Improved coverage from 8.39% to 67.97%
|
|
31
|
+
- Coverage breakdown:
|
|
32
|
+
- index.ts: 96.77% statements, 92.3% branch coverage
|
|
33
|
+
- normalizer.ts: 100% coverage
|
|
34
|
+
- parser.ts: 86.56% statements, 66.66% branch coverage
|
|
35
|
+
- writer.ts: 90.9% statements, 66.66% branch coverage
|
|
36
|
+
- Added test suites for parser, writer, index orchestration, and CLI
|
|
37
|
+
|
|
38
|
+
**Build Pipeline Integration:**
|
|
39
|
+
- Integrated declaration-file-normalizer into build pipeline for all packages using API Extractor
|
|
40
|
+
- Build flow is now: `tsc → declaration-file-normalizer → api-extractor`
|
|
41
|
+
- This ensures stable union/intersection type ordering in API reports across builds
|
|
42
|
+
|
|
43
|
+
**Configuration:**
|
|
44
|
+
- Fixed vitest.config.mts to properly track index.ts coverage
|
|
45
|
+
|
|
3
46
|
## 0.1.0-alpha.2
|
|
4
47
|
|
|
5
48
|
### Minor Changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@api-extractor-tools/eslint-plugin",
|
|
3
|
-
"version": "0.1.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "ESLint plugin providing authoring-time feedback for API Extractor",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/eslint-plugin-public.d.ts",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"tsd": "^0.33.0",
|
|
42
42
|
"typescript": "5.8.3",
|
|
43
43
|
"vitest": "^4.0.15",
|
|
44
|
-
"@api-extractor-tools/declaration-file-normalizer": "0.1.0
|
|
44
|
+
"@api-extractor-tools/declaration-file-normalizer": "0.1.0"
|
|
45
45
|
},
|
|
46
46
|
"scripts": {
|
|
47
47
|
"clean": "rm -rf dist",
|