feat(docs): add api-extractor config #300
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iankhou
had a problem deploying
to
integ-approval
GitHub Actions
Failure
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #300 +/- ##
==========================================
+ Coverage 85.24% 85.44% +0.19%
==========================================
Files 222 222
Lines 36898 36926 +28
Branches 4438 4462 +24
==========================================
+ Hits 31455 31552 +97
+ Misses 5348 5277 -71
- Partials 95 97 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
iankhou
changed the title
rix0rrr
reviewed
Apr 1, 2025
Contributor
There was a problem hiding this comment.
How/where are you planning to run API Extractor? I'd expect the script and the config to live side-by-side (unless there's a very good reason not to).
Also, if it must live here: I think I'd prefer all of our JSON files that are actually config to go through projen. So create a new projen.JsonFile in .projenrc.ts and put the config there I think.
Fixes #296 This change is to fix URLs that return 404 errors. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
…g does not find a specific count of resources (#251) Fixes #257 As described in the issue, `CcApiContextProviderPlugin` should have the way to ensure the result has exact one resource. This PR adds the `expectedMatchCount` option to restrict the length of results in `listResources()`. Unit tests are added and modified ensure the changes. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license --------- Co-authored-by: Rico Huijbers <[email protected]>
api-extractor doc generation and upload
auto-merge was automatically disabled
April 1, 2025 18:13
Pull request was closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allows us to invoke
api-extractorto get an outputted JSON file produced from source code and TSDocs.Ref: https://api-extractor.com/pages/setup/invoking/#4-running-the-tool
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license