Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: add --print-config flag #6107

Merged
merged 5 commits into from
Sep 27, 2018
Merged

cli: add --print-config flag #6107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef9757b
cli: add --print-config flag
brendankenny Sep 26, 2018
aab4134
readme
brendankenny Sep 26, 2018
1c45b83
lotsofeedback
brendankenny Sep 26, 2018
5e1629e
Merge branch 'master' into printconfig
brendankenny Sep 26, 2018
b3af33a
more
brendankenny Sep 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 31 additions & 29 deletions lighthouse-cli/bin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const commands = require('./commands/commands.js');
const printer = require('./printer.js');
const getFlags = require('./cli-flags.js').getFlags;
const runLighthouse = require('./run').runLighthouse;
const generateConfig = require('../lighthouse-core/index.js').generateConfig;

const log = require('lighthouse-logger');
const pkg = require('../package.json');
Expand Down Expand Up @@ -45,18 +46,18 @@ if (cliFlags.listTraceCategories) {
const url = cliFlags._[0];

/** @type {LH.Config.Json|undefined} */
let config;
let configJson;
if (cliFlags.configPath) {
// Resolve the config file path relative to where cli was called.
cliFlags.configPath = path.resolve(process.cwd(), cliFlags.configPath);
config = /** @type {LH.Config.Json} */ (require(cliFlags.configPath));
configJson = /** @type {LH.Config.Json} */ (require(cliFlags.configPath));
} else if (cliFlags.preset) {
if (cliFlags.preset === 'mixed-content') {
// The mixed-content audits require headless Chrome (https://crbug.com/764505).
cliFlags.chromeFlags = `${cliFlags.chromeFlags} --headless`;
}

config = require(`../lighthouse-core/config/${cliFlags.preset}-config.js`);
configJson = require(`../lighthouse-core/config/${cliFlags.preset}-config.js`);
}

// set logging preferences
Expand Down Expand Up @@ -94,34 +95,35 @@ if (cliFlags.extraHeaders) {
/**
* @return {Promise<LH.RunnerResult|void>}
*/
function run() {
return Promise.resolve()
.then(_ => {
// By default, cliFlags.enableErrorReporting is undefined so the user is
// prompted. This can be overriden with an explicit flag or by the cached
// answer returned by askPermission().
if (typeof cliFlags.enableErrorReporting === 'undefined') {
return askPermission().then(answer => {
cliFlags.enableErrorReporting = answer;
});
}
})
.then(_ => {
Sentry.init({
url,
flags: cliFlags,
environmentData: {
name: 'redacted', // prevent sentry from using hostname
environment: isDev() ? 'development' : 'production',
release: pkg.version,
tags: {
channel: 'cli',
},
},
});
async function run() {
if (cliFlags.printConfig) {
const config = generateConfig(configJson, cliFlags);
process.stdout.write(config.getPrintString());
return;
}
Copy link
Member Author

@brendankenny brendankenny Sep 26, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this needed to be in the full flow of the cli since it turns out process.stdout.write (and by extension console.log) isn't flushed or waited on by process.exit(), so the exit can come mid write and the JSON output will be truncated. Since index.js just requires this module (running the top-level code) and calls run(), this needed some way to prevent getting to run() without calling process.exit(), so...here we are.

(and might as well switch to async/await while in here)


return runLighthouse(url, cliFlags, config);
// By default, cliFlags.enableErrorReporting is undefined so the user is
// prompted. This can be overriden with an explicit flag or by the cached
// answer returned by askPermission().
if (typeof cliFlags.enableErrorReporting === 'undefined') {
cliFlags.enableErrorReporting = await askPermission();
}
if (cliFlags.enableErrorReporting) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this check isn't strictly necessary (Sentry.init itself checks for enableErrorReporting), but added this just to reassure anyone reading this file and not digging in farther

Sentry.init({
url,
flags: cliFlags,
environmentData: {
name: 'redacted', // prevent sentry from using hostname
environment: isDev() ? 'development' : 'production',
release: pkg.version,
tags: {
channel: 'cli',
},
},
});
}

return runLighthouse(url, cliFlags, configJson);
}

module.exports = {
Expand Down
20 changes: 12 additions & 8 deletions lighthouse-cli/cli-flags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function getFlags(manualArgv) {

.group(
[
'save-assets', 'list-all-audits', 'list-trace-categories', 'additional-trace-categories',
'save-assets', 'list-all-audits', 'list-trace-categories', 'print-config', 'additional-trace-categories',
'config-path', 'preset', 'chrome-flags', 'port', 'hostname', 'emulated-form-factor',
'max-wait-for-load', 'enable-error-reporting', 'gather-mode', 'audit-mode',
'only-audits', 'only-categories', 'skip-audits',
Expand Down Expand Up @@ -100,6 +100,7 @@ function getFlags(manualArgv) {
'only-audits': 'Only run the specified audits',
'only-categories': 'Only run the specified categories',
'skip-audits': 'Run everything except these audits',
'print-config': 'Print the normalized config for the given config and options, then exit.',
})
// set aliases
.alias({'gather-mode': 'G', 'audit-mode': 'A'})
Expand All @@ -118,7 +119,7 @@ function getFlags(manualArgv) {
// boolean values
.boolean([
'disable-storage-reset', 'disable-device-emulation', 'save-assets', 'list-all-audits',
'list-trace-categories', 'view', 'verbose', 'quiet', 'help',
'list-trace-categories', 'view', 'verbose', 'quiet', 'help', 'print-config',
])
.choices('output', printer.getValidOutputOptions())
.choices('emulated-form-factor', ['mobile', 'desktop', 'none'])
Expand All @@ -142,16 +143,19 @@ function getFlags(manualArgv) {
.default('enable-error-reporting', undefined) // Undefined so prompted by default
.check(/** @param {LH.CliFlags} argv */ (argv) => {
// Lighthouse doesn't need a URL if...
// - We're in auditMode (and we have artifacts already)
// - We're just listing the available options.
// If one of these don't apply, stop the program and ask for a url.
const isListMode = argv.listAllAudits || argv.listTraceCategories;
// - We're just printing the config.
// - We're in auditMode (and we have artifacts already)
// If one of these don't apply, if no URL, stop the program and ask for one.
const isPrintSomethingMode = argv.listAllAudits || argv.listTraceCategories || argv.printConfig;
const isOnlyAuditMode = !!argv.auditMode && !argv.gatherMode;
if (!isListMode && !isOnlyAuditMode && argv._.length === 0) {
throw new Error('Please provide a url');
if (isPrintSomethingMode || isOnlyAuditMode) {
return true;
} else if (argv._.length > 0) {
return true;
}

return true;
throw new Error('Please provide a url');
})
.epilogue(
'For more information on Lighthouse, see https://developers.google.com/web/tools/lighthouse/.')
Expand Down
Loading