[kbn-docs-utils] Improve CLI output and single-plugin/package build performance#254835
Open
clintandrewhall wants to merge 3 commits intoelastic:mainfrom
Open
[kbn-docs-utils] Improve CLI output and single-plugin/package build performance#254835clintandrewhall wants to merge 3 commits intoelastic:mainfrom
clintandrewhall wants to merge 3 commits intoelastic:mainfrom
Conversation
…erformance - Refactor metrics output to use structured table helpers (`printIssueTable`, `printMissingExportsTable`) and improve GitHub links with line-number anchors via `getLink`. - Introduce two-pass plugin discovery so filtered builds receive an `allPlugins` list for accurate cross-reference resolution while scoping the TypeScript project to a single plugin's directory for faster compilation. - Gate aggregate documentation (plugin directory, deprecation summaries) behind a check for both `pluginFilter` and `packageFilter` to avoid writing partial data.
clintandrewhall
added
review
Team:Operations
Contributor
|
Pinging @elastic/kibana-operations (Team:Operations) |
Contributor
💚 Build Succeeded
Metrics [docs]Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
|
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
2 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.
Summary
Makes
@kbn/docs-utilsCLI output easier to read and single-plugin builds noticeably faster.Note
This PR is a subset of #247688 for ease of review.
This PR was written with Cursor and
claude-4.5-opus-high.--pluginor--package, the TypeScript project only loads files from that directory instead of the entire repo. Cross-references still resolve correctly thanks to a two-pass plugin discovery.Example output
Commits
984c53f81c02c6Test plan
yarn test:type_check --project packages/kbn-docs-utils/tsconfig.jsonpasses.yarn test:jest packages/kbn-docs-utils— 326/326 tests pass.node scripts/build_api_docs) produces identical output.node scripts/build_api_docs --plugin <id>) completes faster and produces correct cross-references.