README: update CLI help with latest. Give common examples #2182
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
|
it's super tall: can you add this guy into the .wrap(yargs.terminalWidth())
|
paulirish
reviewed
May 8, 2017
lighthouse-cli/bin.ts
Outdated
| @@ -52,6 +52,12 @@ const cliFlags = yargs | |||
| .showHelpOnFail(false, 'Specify --help for available options') | |||
|
|
|||
| .usage('$0 url') | |||
| .example('$0 url --view', 'Opens the HTML report in a browser after the run completes') | |||
There was a problem hiding this comment.
IMO we should just use "lighthouse" rather than whatever $0 resolves to.
how about with brackets on the url too: lighthouse <url> --view
| @@ -209,7 +216,7 @@ function getDebuggableChrome(flags: {skipAutolaunch: boolean, port: number, sele | |||
| chromeFlags: string}): Promise<ChromeLauncher> { | |||
| const chromeLauncher = new ChromeLauncher({ | |||
| port: flags.port, | |||
| additionalFlags: flags.chromeFlags.split(' '), | |||
| chromeFlags: flags.chromeFlags.split(' '), | |||
There was a problem hiding this comment.
this is a breaking change and some other folks rely on the API, but @samccone's work here will break them too and hopefully have some docs so its easy to do the right thing.
all that said, +1 to this change.
There was a problem hiding this comment.
Yea, I figure we're covered under the 2.0 veil
readme.md
Outdated
| --interactive Open Lighthouse in interactive mode [boolean] | ||
|
|
||
| Examples: | ||
| lighthouse-cli/index.js url --view Opens the HTML report in a browser |
There was a problem hiding this comment.
i'd repeat this paste with the new terminalWidth change, for less wrapping.
|
PTAL |
paulirish
approved these changes
May 8, 2017
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.
--help--helpadditionalFlags->chromeFlagsso we're consistent. It's confusing that we use--chrome-flagsin some places (LH CLI) andadditionalFlagsin other places (chrome-debug,ChromeLauncher).--chrome-flagsbetter signals that these flags are Chrome specific and not Lighthouse flags.