perf(@angular/cli): skip eager yargs help message formatting during command execution - #34087
Open
clydin wants to merge 1 commit into
Open
perf(@angular/cli): skip eager yargs help message formatting during command execution#34087clydin wants to merge 1 commit into
clydin wants to merge 1 commit into
Conversation
…ommand execution Whenever a subcommand is invoked, Yargs eagerly formats and caches the complete command help message via its internal cacheHelpMessage() method. This involves assembling layout tables with cliui, wrapping text with wrap-ansi, and evaluating Unicode string widths with string-width, even when the command succeeds and help output is never requested. Because the Angular CLI explicitly configures showHelpOnFail(false) and handles errors via a custom failure handler, this cached help message is never consumed in either the success or failure paths. Overriding cacheHelpMessage to a no-op when neither --help nor --json-help is requested eliminates roughly 15ms to 20ms of synchronous formatting overhead from the CLI startup path.
There was a problem hiding this comment.
Code Review
This pull request optimizes startup performance in the Angular CLI by disabling eager help message caching in yargs when help is not requested. The reviewer suggests adding defensive checks (optional chaining) when accessing yargs internal methods to prevent potential runtime crashes if the third-party library updates.
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.
Whenever a subcommand is invoked, Yargs eagerly formats and caches the complete command help message via its internal cacheHelpMessage() method. This involves assembling layout tables with cliui, wrapping text with wrap-ansi, and evaluating Unicode string widths with string-width, even when the command succeeds and help output is never requested.
Because the Angular CLI explicitly configures showHelpOnFail(false) and handles errors via a custom failure handler, this cached help message is never consumed in either the success or failure paths. Overriding cacheHelpMessage to a no-op when neither --help nor --json-help is requested eliminates roughly 15ms to 20ms of synchronous formatting overhead from the CLI startup path.