misc: add cli module diagram #6129
Merged
Conversation
This file contains 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
brendankenny
approved these changes
Sep 28, 2018
| @@ -8,6 +8,19 @@ | |||
| const fs = require('fs'); | |||
| const path = require('path'); | |||
|
|
|||
| /* | |||
| * The relationship between these CLI modules: | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
patrickhulce
approved these changes
Sep 28, 2018
| * index.js : only calls bin.js's begin() | ||
| * cli-flags.js : leverages yargs to read argv, outputs LH.CliFlags | ||
| * bin.js : CLI args processing. cwd, list/print commands | ||
| * run.js : chrome-launcher bits, calling lighthouse-core, output to Printer |
There was a problem hiding this comment.
part of me thinks the functionality here should be available from node more easily too, but that's tomorrow's problem :)
There was a problem hiding this comment.
we could turn cli/index.js into a module and expose it that way. That would let us side step dealing with what gets included in the extension/devtools bundle and let us keep the CLI the same. Biggest issue will probably be with letting you cleanly set up cliFlags not with a long string since we can currently assume defaults set via yargs.
exterkamp
approved these changes
Sep 28, 2018
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.
No description provided.