-
Notifications
You must be signed in to change notification settings - Fork 554
build(api-markdown-documenter): Simplify API-Extractor setup #24800
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build(api-markdown-documenter): Simplify API-Extractor setup #24800
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR simplifies the API-Extractor setup for the api-markdown-documenter package so that it can be versioned and published independently.
- Removed shared configuration extend and inlined API-Extractor configuration
- Updated export type paths in package.json to better reflect the package name and fixed the
/beta
path - Removed the obsolete api-extractor-lint.json file
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
File | Description |
---|---|
tools/api-markdown-documenter/package.json | Updated exports to use more descriptive type paths |
tools/api-markdown-documenter/api-extractor.json | Removed shared config extend and added inline API-Extractor settings |
tools/api-markdown-documenter/api-extractor-lint.json | Removed obsolete lint configuration file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a couple comments but looks good! :)
"reportFileName": "<unscopedPackageName>", | ||
"reportFolder": "<projectFolder>/api-report/", | ||
"reportTempFolder": "<projectFolder>/_api-extractor-temp/", | ||
"reportVariants": ["public", "beta"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where's @Alpha API document covering?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This package doesn't have any alpha APIs, so I removed the alpha report. It can be re-added as needed later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gogogo
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
This package is versioned and published independently from the rest of the repo. It was previously set up to use our shared base API-Extractor configs, which are configured for packages in release groups that version/publish many packages together.
Specific changes:
/beta
export path