Repository navigation
chore: check the entries of the API report with api-report 0.5.7 - #173
Merged
Merged
Conversation
The option entriesOnly of api-report fails check:api when a declaration of the report is in a chunk of the bundler. It replaces the local test of the chunks. The test of the counts of docs/API-REVIEW.md stays. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
The check that the API report names only the declaration files of the entry points moves from a local test to
api-report0.5.7, with its new optionentriesOnly.What changes
package.jsonhas"apiReport": { "entriesOnly": true }.pnpm check:api(CI runs it) now fails when a declaration of the report is in a chunk of the bundler, and the error names the file and the names.@mark1russell7/api-reportgoes from^0.5.3to^0.5.7.src/api-report.test.tsno longer has its own check of the chunks (theentryFileshelper and one test). The test of the counts ofdocs/API-REVIEW.mdstays. The header comment names the option that replaces the removed test.The check fails when it must. I put a fake chunk in the build of
polite-crawler-mcp(leak-AbCd1234.d.mts, re-exported fromindex.d.mts).pnpm check:apiexited with 1: "The report of polite-crawler-mcp has declarations in files that are not the declaration file of an entry (the option entriesOnly): build/leak.chunk.d.mts (leakedName)." After a clean build, it exited with 0.The lockfile:
api-report0.5.7 brings@mark1russell7/conventions0.41.13 for itself. The root keeps 0.41.10 until the next batch update of the dev tools.Version: none. No published file changes.
Local checks: a build of both packages,
pnpm check:api(0 on the clean build, 1 on the planted chunk),vitest run src/api-report.test.ts(1 pass), prettier and ste-lint on the changed files.🤖 Generated with Claude Code