feat: classify unsnapshotable subpaths with actionable skip reasons#101
Merged
Conversation
Contributor
API Changes Report
Summary
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check |
commit: |
This was referenced Jun 12, 2026
Merged
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When API Extractor cannot snapshot a subpath, the skip reason in the report was AE's raw error, complete with "You have encountered a software defect. Please consider reporting the issue to the maintainers of this application." That made real packaging problems in the analyzed repo read like break-check bugs (see the three skips on clerk/javascript#8827).
describeExtractionFailurenow translates the four AE failure shapes we pinned down into actionable reasons: an ambient entry point (which AE can never analyze, rushstack #1176), and three variants of an unresolvable type name, which usually means the published types are broken for consumers. Anything unrecognized passes through with only the boilerplate stripped. Matching is on message strings; that is safe because AE is pinned exactly and a bump already mandates a break-check major. Reasons are run-scoped and never persisted, so no schema or discovery version changes.Verified against the three real failures in clerk/javascript: all three now report the friendly reasons on stderr.