Skip to content

Commit

Permalink
combine tag and data into one object
Browse files Browse the repository at this point in the history
  • Loading branch information
@phated
phated committed Mar 21, 2024
1 parent 655727a commit a2bd8d0
Show file tree
Hide file tree
Showing 44 changed files with 246 additions and 203 deletions.
38 changes: 19 additions & 19 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@ var opts = parser.parse();
var cleanupListeners = toConsole(log, opts, buildTranslations());

cli.on('preload:before', function(name) {
log.info(messages.PRELOAD_BEFORE, name);
log.info({ tag: messages.PRELOAD_BEFORE, name: name });
});

cli.on('preload:success', function(name) {
log.info(messages.PRELOAD_SUCCESS, name);
log.info({ tag: messages.PRELOAD_SUCCESS, name: name });
});

cli.on('preload:failure', function(name, error) {
log.warn(messages.PRELOAD_FAILURE, name);
log.warn({ tag: messages.PRELOAD_FAILURE, name: name });
if (error) {
log.warn(messages.PRELOAD_ERROR, error);
log.warn({ tag: messages.PRELOAD_ERROR, error: error });
}
});

Expand All @@ -89,20 +89,20 @@ cli.on('loader:success', function(name) {
// However, we don't want to show the mjs-stub loader in the logs
/* istanbul ignore else */
if (path.basename(name, '.js') !== 'mjs-stub') {
log.info(messages.LOADER_SUCCESS, name);
log.info({ tag: messages.LOADER_SUCCESS, name: name });
}
});

cli.on('loader:failure', function(name, error) {
log.warn(messages.LOADER_FAILURE, name);
log.warn({ tag: messages.LOADER_FAILURE, name: name });
if (error) {
log.warn(messages.LOADER_ERROR, error);
log.warn({ tag: messages.LOADER_ERROR, error: error });
}
});

cli.on('respawn', function(flags, child) {
log.info(messages.NODE_FLAGS, flags);
log.info(messages.RESPAWNED, child.pid);
log.info({ tag: messages.NODE_FLAGS, flags: flags });
log.info({ tag: messages.RESPAWNED, pid: child.pid });
});

function run() {
Expand All @@ -127,7 +127,7 @@ function onFail(message, error) {
var cfg = arrayFind(env.config, isDefined);
var translate = buildTranslations(cfg);

var errorMsg = translate.message(messages.ARGV_ERROR, { message: message, error: error });
var errorMsg = translate.message({ tag: messages.ARGV_ERROR, message: message, error: error });
if (errorMsg) {
console.error(errorMsg);
}
Expand Down Expand Up @@ -190,40 +190,40 @@ function onExecute(env, flags, translate) {

var hasYarn = fs.existsSync(path.join(env.cwd, 'yarn.lock'));
if (missingNodeModules) {
log.error(messages.MISSING_NODE_MODULES, { cwd: env.cwd });
log.error({ tag: messages.MISSING_NODE_MODULES, cwd: env.cwd });
if (hasYarn) {
log.error(messages.YARN_INSTALL)
log.error({ tag: messages.YARN_INSTALL })
} else {
log.error(messages.NPM_INSTALL)
log.error({ tag: messages.NPM_INSTALL })
}
} else {
log.error(messages.MISSING_GULP, { cwd: env.cwd });
log.error({ tag: messages.MISSING_GULP, cwd: env.cwd });
if (hasYarn) {
log.error(messages.YARN_INSTALL_GULP);
log.error({ tag: messages.YARN_INSTALL_GULP });
} else {
log.error(messages.NPM_INSTALL_GULP);
log.error({ tag: messages.NPM_INSTALL_GULP });
}
}
exit(1);
}

if (!env.configPath) {
log.error(messages.MISSING_GULPFILE);
log.error({ tag: messages.MISSING_GULPFILE });
exit(1);
}

// Chdir before requiring gulpfile to make sure
// we let them chdir as needed
if (process.cwd() !== env.cwd) {
process.chdir(env.cwd);
log.info(messages.CWD_CHANGED, { cwd: env.cwd });
log.info({ tag: messages.CWD_CHANGED, cwd: env.cwd });
}

// Find the correct CLI version to run
var range = findRange(env.modulePackage.version, ranges);

if (!range) {
log.error(messages.UNSUPPORTED_GULP_VERSION, env.modulePackage.version);
log.error({ tag: messages.UNSUPPORTED_GULP_VERSION, version: env.modulePackage.version });
exit(1);
}

Expand Down
4 changes: 2 additions & 2 deletions lib/shared/completion.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ var messages = require('../../messages');

module.exports = function(name, translate) {
if (typeof name !== 'string') {
throw new Error(translate.message(messages.COMPLETION_TYPE_MISSING));
throw new Error(translate.message({ tag: messages.COMPLETION_TYPE_MISSING }));
}
var file = path.join(__dirname, '../../completion', name);
try {
console.log(fs.readFileSync(file, 'utf8'));
process.exit(0);
} catch (err) {
console.log(translate.message(messages.COMPLETION_TYPE_UNKNOWN, { name: name }));
console.log(translate.message({ tag: messages.COMPLETION_TYPE_UNKNOWN, name: name }));
process.exit(5);
}
};
16 changes: 8 additions & 8 deletions lib/shared/log/tasks.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ function logTasks(tree, opts, getTask, translate) {
var maxLabelWidth = addTaskToLines(task, lines, isLast, isLeaf);

if (!isLeaf) {
bars += (isLast ? ' ' : translate.message(messages.BOX_DRAWINGS_LIGHT_VERTICAL));
bars += (isLast ? ' ' : translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_VERTICAL }));
bars += ' '
node.nodes.forEach(function(node, idx, arr) {
var isLast = idx === arr.length - 1;
Expand All @@ -78,13 +78,13 @@ function logTasks(tree, opts, getTask, translate) {

function addTaskToLines(task, lines, isLast, isLeaf) {
var taskBars = task.bars + (isLast
? translate.message(messages.BOX_DRAWINGS_LIGHT_UP_AND_RIGHT)
: translate.message(messages.BOX_DRAWINGS_LIGHT_VERTICAL_AND_RIGHT)) +
translate.message(messages.BOX_DRAWINGS_LIGHT_HORIZONTAL);
? translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_UP_AND_RIGHT })
: translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_VERTICAL_AND_RIGHT })) +
translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_HORIZONTAL });
if (isLeaf) {
taskBars += translate.message(messages.BOX_DRAWINGS_LIGHT_HORIZONTAL);
taskBars += translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_HORIZONTAL });
} else {
taskBars += translate.message(messages.BOX_DRAWINGS_LIGHT_DOWN_AND_HORIZONTAL);
taskBars += translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_DOWN_AND_HORIZONTAL });
}
taskBars += ' ';

Expand All @@ -111,14 +111,14 @@ function logTasks(tree, opts, getTask, translate) {
if (isLast) {
flagBars += ' ';
} else {
flagBars += translate.message(messages.BOX_DRAWINGS_LIGHT_VERTICAL);
flagBars += translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_VERTICAL });
}
flagBars += ' ';

if (isLeaf) {
flagBars += ' ';
} else {
flagBars += translate.message(messages.BOX_DRAWINGS_LIGHT_VERTICAL);
flagBars += translate.message({ tag: messages.BOX_DRAWINGS_LIGHT_VERTICAL });
}
flagBars += ' ';

Expand Down
24 changes: 12 additions & 12 deletions lib/shared/log/to-console.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ function toConsole(log, opts, translate) {
log.removeListener('debug', onDebug);
};

function onError(msg, data) {
function onError(msg) {
// Get message and timestamp before printing anything to avoid
// logging a half message if there's an error in one of them
var message = translate.message(msg, data);
var timestamp = translate.timestamp(msg, data);
var message = translate.message(msg);
var timestamp = translate.timestamp(msg);

if (message) {
// Ensure timestamp is not written without a message
Expand All @@ -60,11 +60,11 @@ function toConsole(log, opts, translate) {

// onWarn, onInfo, and onDebug are currently all the same
// implementation but separated to change independently
function onWarn(msg, data) {
function onWarn(msg) {
// Get message and timestamp before printing anything to avoid
// logging a half message if there's an error in one of them
var message = translate.message(msg, data);
var timestamp = translate.timestamp(msg, data);
var message = translate.message(msg);
var timestamp = translate.timestamp(msg);

if (message) {
// Ensure timestamp is not written without a message
Expand All @@ -75,11 +75,11 @@ function toConsole(log, opts, translate) {
}
}

function onInfo(msg, data) {
function onInfo(msg) {
// Get message and timestamp before printing anything to avoid
// logging a half message if there's an error in one of them
var message = translate.message(msg, data);
var timestamp = translate.timestamp(msg, data);
var message = translate.message(msg);
var timestamp = translate.timestamp(msg);

if (message) {
// Ensure timestamp is not written without a message
Expand All @@ -90,11 +90,11 @@ function toConsole(log, opts, translate) {
}
}

function onDebug(msg, data) {
function onDebug(msg) {
// Get message and timestamp before printing anything to avoid
// logging a half message if there's an error in one of them
var message = translate.message(msg, data);
var timestamp = translate.timestamp(msg, data);
var message = translate.message(msg);
var timestamp = translate.timestamp(msg);

if (message) {
// Ensure timestamp is not written without a message
Expand Down
34 changes: 17 additions & 17 deletions lib/shared/options/cli-options.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,88 +7,88 @@ var options = {
help: {
alias: 'h',
type: 'boolean',
message: messages.FLAG_HELP,
tag: messages.FLAG_HELP,
},
version: {
alias: 'v',
type: 'boolean',
message: messages.FLAG_VERSION,
tag: messages.FLAG_VERSION,
},
preload: {
type: 'string',
requiresArg: true,
message: messages.FLAG_PRELOAD,
tag: messages.FLAG_PRELOAD,
},
gulpfile: {
alias: 'f',
type: 'string',
requiresArg: true,
message: messages.FLAG_GULPFILE,
tag: messages.FLAG_GULPFILE,
},
cwd: {
type: 'string',
requiresArg: true,
message: messages.FLAG_CWD,
tag: messages.FLAG_CWD,
},
tasks: {
alias: 'T',
type: 'boolean',
message: messages.FLAG_TASKS,
tag: messages.FLAG_TASKS,
},
'tasks-simple': {
type: 'boolean',
message: messages.FLAG_TASKS_SIMPLE,
tag: messages.FLAG_TASKS_SIMPLE,
},
'tasks-json': {
message: messages.FLAG_TASKS_JSON,
tag: messages.FLAG_TASKS_JSON,
},
'tasks-depth': {
alias: 'depth',
type: 'number',
requiresArg: true,
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_TASKS_DEPTH,
tag: messages.FLAG_TASKS_DEPTH,
},
'compact-tasks': {
type: 'boolean',
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_COMPACT_TASKS,
tag: messages.FLAG_COMPACT_TASKS,
},
'sort-tasks': {
type: 'boolean',
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_SORT_TASKS,
tag: messages.FLAG_SORT_TASKS,
},
color: {
type: 'boolean',
message: messages.FLAG_COLOR,
tag: messages.FLAG_COLOR,
},
'no-color': {
type: 'boolean',
message: messages.FLAG_NO_COLOR,
tag: messages.FLAG_NO_COLOR,
},
silent: {
alias: 'S',
type: 'boolean',
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_SILENT,
tag: messages.FLAG_SILENT,
},
continue: {
type: 'boolean',
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_CONTINUE,
tag: messages.FLAG_CONTINUE,
},
series: {
type: 'boolean',
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_SERIES,
tag: messages.FLAG_SERIES,
},
'log-level': {
alias: 'L',
// Type isn't needed because count acts as a boolean
count: true,
default: undefined, // To detect if this cli option is specified.
message: messages.FLAG_LOG_LEVEL,
tag: messages.FLAG_LOG_LEVEL,
}
};

Expand Down
4 changes: 2 additions & 2 deletions lib/shared/options/make-help.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ var cliOptions = require('./cli-options');
var messages = require("../../../messages");

function makeHelp(parser, translate) {
var usage = translate.message(messages.USAGE);
var usage = translate.message({ tag: messages.USAGE });
if (usage) {
parser.usage(usage);
}

Object.keys(cliOptions).forEach(function (flag) {
var opt = cliOptions[flag];
var description = translate.message(opt.message);
var description = translate.message({ tag: opt.tag });
if (description) {
parser.describe(flag, description);
}
Expand Down
Loading

0 comments on commit a2bd8d0

Please sign in to comment.