Skip to content

chore: better logger #1179

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

Merged
ematipico merged 1 commit into from
Jan 21, 2020
Merged

chore: better logger #1179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@
require('v8-compile-cache');

const importLocal = require('import-local');
const logger = require('./lib/utils/logger');

// Prefer the local installation of webpack-cli
if (importLocal(__filename)) {
return;
}
process.title = 'webpack';
process.cliLogger = require('webpack-log')({
name: 'webpack',
});

const updateNotifier = require('update-notifier');
const packageJson = require('./package.json');
Expand All @@ -24,7 +22,7 @@ const notifier = updateNotifier({
});

if (notifier.update) {
process.cliLogger.info(`Update available: ${notifier.update.latest}`);
logger.info(`Update available: ${notifier.update.latest}`);
}

const semver = require('semver');
Expand All @@ -33,7 +31,7 @@ const version = packageJson.engines.node;

if (!semver.satisfies(process.version, version)) {
const rawVersion = version.replace(/[^\d\.]*/, '');
process.cliLogger.error('webpack CLI requires at least Node v' + rawVersion + '. ' + 'You have ' + process.version + '.\n' + 'See https://webpack.js.org/ ' + 'for migration help and similar.');
logger.error('webpack CLI requires at least Node v' + rawVersion + '. ' + 'You have ' + process.version + '.\n' + 'See https://webpack.js.org/ ' + 'for migration help and similar.');
process.exit(1);
}

Expand Down
9 changes: 5 additions & 4 deletions lib/bootstrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
const WebpackCLI = require('./webpack-cli');
const { core, commands } = require('./utils/cli-flags');
const cmdArgs = require('command-line-args');
const logger = require('./utils/logger');

require('./utils/process-log');

Expand Down Expand Up @@ -65,7 +66,7 @@ async function runCLI(cli, commandIsUsed) {
args._unknown
.filter(e => e)
.forEach(unknown => {
process.cliLogger.warn('Unknown argument:', unknown);
logger.warn('Unknown argument:', unknown);
});
}
const result = await cli.run(args, core);
Expand All @@ -74,7 +75,7 @@ async function runCLI(cli, commandIsUsed) {
}
} catch (err) {
if (err.name === 'UNKNOWN_VALUE') {
process.cliLogger.error(`Parse Error (unknown argument): ${err.value}`);
logger.error(`Parse Error (unknown argument): ${err.value}`);
return;
} else if (err.name === 'ALREADY_SET') {
const argsMap = {};
Expand All @@ -99,9 +100,9 @@ async function runCLI(cli, commandIsUsed) {

await cli.run(args, core);
process.stdout.write('\n');
process.cliLogger.warn('Duplicate flags found, defaulting to last set value');
logger.warn('Duplicate flags found, defaulting to last set value');
} else {
process.cliLogger.error(err);
logger.error(err);
return;
}
}
Expand Down
6 changes: 4 additions & 2 deletions lib/commands/external.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/* eslint-disable @typescript-eslint/explicit-function-return-type */
const { prompt } = require('inquirer');
const chalk = require('chalk');
const logger = require('../utils/logger');

class ExternalCommand {
static async runCommand(command, args = []) {
const cp = require('child_process');
Expand All @@ -13,7 +15,7 @@ class ExternalCommand {
reject(error);
});

executedCommand.on('exit', code => {
executedCommand.on('exit', () => {
resolve();
});
});
Expand All @@ -37,7 +39,7 @@ class ExternalCommand {
const options = [isYarn ? 'add' : 'install', '-D', scopeName];

const commandToBeRun = `${packageManager} ${options.join(' ')}`;
process.cliLogger.error(`The command moved into a separate package: ${chalk.keyword('orange')(name)}\n`);
logger.error(`The command moved into a separate package: ${chalk.keyword('orange')(name)}\n`);
const question = `Would you like to install ${name}? (That will run ${chalk.green(commandToBeRun)})`;
const { installConfirm } = await prompt([
{
Expand Down
21 changes: 11 additions & 10 deletions lib/groups/advanced.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/* eslint-disable @typescript-eslint/explicit-function-return-type */
const GroupHelper = require('../utils/group-helper');
const logger = require('../utils/logger');

class AdvancedGroup extends GroupHelper {
constructor(options) {
Expand All @@ -15,7 +16,7 @@ class AdvancedGroup extends GroupHelper {
name = name.substring(0, p);
}
} catch (e) {
process.cliLogger.error('Invalid plugin arguments ' + name + ' (' + e + ').');
logger.error('Invalid plugin arguments ' + name + ' (' + e + ').');
process.exit(-1); // eslint-disable-line
}

Expand All @@ -24,20 +25,20 @@ class AdvancedGroup extends GroupHelper {
const resolve = require('enhanced-resolve');
path = resolve.sync(process.cwd(), name);
} catch (e) {
process.cliLogger.error('Cannot resolve plugin ' + name + '.');
logger.error('Cannot resolve plugin ' + name + '.');
process.exit(-1); // eslint-disable-line
}
let Plugin;
try {
Plugin = require(path);
} catch (e) {
process.cliLogger.error('Cannot load plugin ' + name + '. (' + path + ')');
logger.error('Cannot load plugin ' + name + '. (' + path + ')');
throw e;
}
try {
return new Plugin(args);
} catch (e) {
process.cliLogger.error('Cannot instantiate plugin ' + name + '. (' + path + ')');
logger.error('Cannot instantiate plugin ' + name + '. (' + path + ')');
throw e;
}
}
Expand Down Expand Up @@ -75,11 +76,11 @@ class AdvancedGroup extends GroupHelper {
if (args.global) {
const globalArrLen = args.global.length;
if (!globalArrLen) {
process.cliLogger.warn('Argument to global flag is none');
logger.warn('Argument to global flag is none');
return;
}
if (globalArrLen === 1) {
process.cliLogger.warn('Argument to global flag expected a key/value pair');
logger.warn('Argument to global flag expected a key/value pair');
return;
}

Expand All @@ -92,12 +93,12 @@ class AdvancedGroup extends GroupHelper {
const argVal = arg.substr(splitIdx + 1);
const argKey = arg.substr(0, splitIdx);
if (!argVal.length) {
process.cliLogger.warn(`Found unmatching value for global flag key '${argKey}'`);
logger.warn(`Found unmatching value for global flag key '${argKey}'`);
return;
}
// eslint-disable-next-line no-prototype-builtins
if (providePluginObject.hasOwnProperty(argKey)) {
process.cliLogger.warn(`Overriding key '${argKey}' for global flag`);
logger.warn(`Overriding key '${argKey}' for global flag`);
}
providePluginObject[argKey] = argVal;
return;
Expand All @@ -106,10 +107,10 @@ class AdvancedGroup extends GroupHelper {
const nextArg = args.global[idx + 1];
// eslint-disable-next-line no-prototype-builtins
if (providePluginObject.hasOwnProperty(arg)) {
process.cliLogger.warn(`Overriding key '${arg}' for global flag`);
logger.warn(`Overriding key '${arg}' for global flag`);
}
if (!nextArg) {
process.cliLogger.warn(`Found unmatching value for global flag key '${arg}'`);
logger.warn(`Found unmatching value for global flag key '${arg}'`);
return;
}
providePluginObject[arg] = nextArg;
Expand Down
25 changes: 13 additions & 12 deletions lib/utils/compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
const webpack = require('webpack');
const chalk = require('chalk');
const Table = require('cli-table3');
const logger = require('./logger');

function setUpHookForCompiler(compiler, outputOptions, options) {
const { ProgressPlugin } = webpack;
Expand All @@ -20,7 +21,7 @@ function setUpHookForCompiler(compiler, outputOptions, options) {
}

if (msg && tmpMsg != msg) {
process.cliLogger.info(percent + '% ' + msg);
logger.info(percent + '% ' + msg);
}
tmpMsg = msg;
};
Expand All @@ -44,17 +45,17 @@ function setUpHookForCompiler(compiler, outputOptions, options) {
if (outputOptions.watch) {
compiler.hooks.watchRun.tap('WebpackInfo', compilation => {
const compilationName = compilation.name ? compilation.name : '';
process.cliLogger.info('Compilation ' + compilationName + ' starting…');
logger.info('Compilation ' + compilationName + ' starting…');
});
} else {
compiler.hooks.beforeRun.tap('WebpackInfo', compilation => {
const compilationName = compilation.name ? compilation.name : '';
process.cliLogger.info('Compilation ' + compilationName + ' starting…');
logger.info('Compilation ' + compilationName + ' starting…');
});
}
compiler.hooks.done.tap('WebpackInfo', compilation => {
const compilationName = compilation.name ? compilation.name : '';
process.cliLogger.info('Compilation ' + compilationName + ' finished');
logger.info('Compilation ' + compilationName + ' finished');
});
}
}
Expand Down Expand Up @@ -117,22 +118,22 @@ function generateOutputForSingleCompilation(statsObj, statsErrors, processingMes
process.stdout.write('\n\n');

if (warning.message) {
process.cliLogger.warn(warning.message);
logger.warn(warning.message);
process.stdout.write('\n');
process.cliLogger.warn(warning.stack);
logger.warn(warning.stack);
return;
}
process.cliLogger.warn(warning);
logger.warn(warning);
});
process.stdout.write('\n');
}

if (statsErrors) {
statsErrors.forEach(err => {
if (err.loc) process.cliLogger.warn(err.loc);
if (err.loc) logger.warn(err.loc);
if (err.name) {
process.stdout.write('\n');
process.cliLogger.error(err.name);
logger.error(err.name);
}
});
}
Expand All @@ -150,7 +151,7 @@ function generateOutput(outputOptions, stats, statsErrors, processingMessageBuff
generateOutputForSingleCompilation(statsObj, statsErrors, processingMessageBuffer);
process.stdout.write('\n');
if (outputOptions.watch) {
process.cliLogger.info('watching files for updates...');
logger.info('watching files for updates...');
}
}

Expand All @@ -163,7 +164,7 @@ function compilerCallback(compiler, err, stats, lastHash, options, outputOptions
}
if (err) {
lastHash = null;
process.cliLogger.error(err.stack || err);
logger.error(err.stack || err);
process.exit(1); // eslint-disable-line
}
if (outputOptions.json && !outputOptions.silent) {
Expand Down Expand Up @@ -213,7 +214,7 @@ async function webpackInstance(opts) {
compiler = getCompiler(options);
} catch (err) {
process.stdout.write('\n');
process.cliLogger.error(`${err.name}: ${err.message}`);
logger.error(`${err.name}: ${err.message}`);
process.stdout.write('\n');
return;
}
Expand Down
5 changes: 5 additions & 0 deletions lib/utils/logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const logger = require('webpack-log')({
name: 'webpack',
});

module.exports = logger;
8 changes: 5 additions & 3 deletions lib/utils/process-log.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
const logger = require('./logger');

/* eslint-disable @typescript-eslint/explicit-function-return-type */
function logErrorAndExit(error) {
if (error && error.stack) process.cliLogger.error(error.stack);
if (error && error.stack) logger.error(error.stack);
process.exit(1);
}

process.on('uncaughtException', error => {
process.cliLogger.error(`Uncaught exception: ${error}`);
logger.error(`Uncaught exception: ${error}`);
logErrorAndExit(error);
});

process.on('unhandledRejection', error => {
process.cliLogger.error(`Promise rejection: ${error}`);
logger.error(`Promise rejection: ${error}`);
logErrorAndExit(error);
});

Expand Down