mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-10-26 08:36:12 +01:00
fix: --help usage info
yargs (via nconf) would exit when detecting a help flag also improves the speed of `./nodebb help build`
This commit is contained in:
Peter Jaszkowiak
committed by
Andrew Rodrigues
Andrew Rodrigues
parent
072a0e32d8
commit
a51c5698c7
@@ -146,6 +146,7 @@
|
||||
"winston": "3.3.3",
|
||||
"xml": "^1.0.1",
|
||||
"xregexp": "^4.3.0",
|
||||
"yargs": "16.2.0",
|
||||
"zxcvbn": "^4.4.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* eslint-disable import/order */
|
||||
|
||||
'use strict';
|
||||
|
||||
const fs = require('fs');
|
||||
@@ -35,13 +37,13 @@ try {
|
||||
try {
|
||||
fs.accessSync(path.join(paths.nodeModules, 'semver/package.json'), fs.constants.R_OK);
|
||||
|
||||
var semver = require('semver');
|
||||
var defaultPackage = require('../../install/package.json');
|
||||
const semver = require('semver');
|
||||
const defaultPackage = require('../../install/package.json');
|
||||
|
||||
var checkVersion = function (packageName) {
|
||||
var version = JSON.parse(fs.readFileSync(path.join(paths.nodeModules, packageName, 'package.json'), 'utf8')).version;
|
||||
const checkVersion = function (packageName) {
|
||||
const version = JSON.parse(fs.readFileSync(path.join(paths.nodeModules, packageName, 'package.json'), 'utf8')).version;
|
||||
if (!semver.satisfies(version, defaultPackage.dependencies[packageName])) {
|
||||
var e = new TypeError('Incorrect dependency version: ' + packageName);
|
||||
const e = new TypeError('Incorrect dependency version: ' + packageName);
|
||||
e.code = 'DEP_WRONG_VERSION';
|
||||
throw e;
|
||||
}
|
||||
@@ -67,14 +69,13 @@ try {
|
||||
}
|
||||
|
||||
require('colors');
|
||||
// eslint-disable-next-line
|
||||
var nconf = require('nconf');
|
||||
// eslint-disable-next-line
|
||||
var program = require('commander');
|
||||
const nconf = require('nconf');
|
||||
const { program } = require('commander');
|
||||
const yargs = require('yargs');
|
||||
|
||||
var pkg = require('../../package.json');
|
||||
var file = require('../file');
|
||||
var prestart = require('../prestart');
|
||||
const pkg = require('../../package.json');
|
||||
const file = require('../file');
|
||||
const prestart = require('../prestart');
|
||||
|
||||
program
|
||||
.name('./nodebb')
|
||||
@@ -86,19 +87,23 @@ program
|
||||
.option('-d, --dev', 'Development mode, including verbose logging', false)
|
||||
.option('-l, --log', 'Log subprocess output to console', false);
|
||||
|
||||
nconf.argv().env({
|
||||
// provide a yargs object ourselves
|
||||
// otherwise yargs will consume `--help` or `help`
|
||||
// and `nconf` will exit with useless usage info
|
||||
const opts = yargs(process.argv.slice(2)).help(false).exitProcess(false);
|
||||
nconf.argv(opts).env({
|
||||
separator: '__',
|
||||
});
|
||||
|
||||
var env = program.dev ? 'development' : (process.env.NODE_ENV || 'production');
|
||||
const env = program.dev ? 'development' : (process.env.NODE_ENV || 'production');
|
||||
process.env.NODE_ENV = env;
|
||||
global.env = env;
|
||||
|
||||
prestart.setupWinston();
|
||||
|
||||
// Alternate configuration file support
|
||||
var configFile = path.resolve(paths.baseDir, nconf.get('config') || 'config.json');
|
||||
var configExists = file.existsSync(configFile) || (nconf.get('url') && nconf.get('secret') && nconf.get('database'));
|
||||
const configFile = path.resolve(paths.baseDir, nconf.get('config') || 'config.json');
|
||||
const configExists = file.existsSync(configFile) || (nconf.get('url') && nconf.get('secret') && nconf.get('database'));
|
||||
|
||||
prestart.loadConfig(configFile);
|
||||
prestart.versionCheck();
|
||||
@@ -195,7 +200,7 @@ program
|
||||
require('./manage').build(targets.length ? targets : true, options);
|
||||
})
|
||||
.on('--help', function () {
|
||||
require('./manage').buildTargets();
|
||||
require('../meta/aliases').buildTargets();
|
||||
});
|
||||
program
|
||||
.command('activate [plugin]')
|
||||
@@ -223,7 +228,7 @@ program
|
||||
});
|
||||
|
||||
// reset
|
||||
var resetCommand = program.command('reset');
|
||||
const resetCommand = program.command('reset');
|
||||
|
||||
resetCommand
|
||||
.description('Reset plugins, themes, settings, etc')
|
||||
@@ -233,7 +238,7 @@ resetCommand
|
||||
.option('-s, --settings', 'Reset settings to their default values')
|
||||
.option('-a, --all', 'All of the above')
|
||||
.action(function (options) {
|
||||
var valid = ['theme', 'plugin', 'widgets', 'settings', 'all'].some(function (x) {
|
||||
const valid = ['theme', 'plugin', 'widgets', 'settings', 'all'].some(function (x) {
|
||||
return options[x];
|
||||
});
|
||||
if (!valid) {
|
||||
@@ -295,10 +300,11 @@ program
|
||||
return program.help();
|
||||
}
|
||||
|
||||
var command = program.commands.find(function (command) { return command._name === name; });
|
||||
const command = program.commands.find(function (command) { return command._name === name; });
|
||||
if (command) {
|
||||
command.help();
|
||||
} else {
|
||||
console.log(`error: unknown command '${command}'.`);
|
||||
program.help();
|
||||
}
|
||||
});
|
||||
@@ -311,4 +317,4 @@ if (process.argv.length === 2) {
|
||||
|
||||
program.executables = false;
|
||||
|
||||
program.parse(process.argv);
|
||||
program.parse();
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
const winston = require('winston');
|
||||
const childProcess = require('child_process');
|
||||
const _ = require('lodash');
|
||||
const CliGraph = require('cli-graph');
|
||||
|
||||
const build = require('../meta/build');
|
||||
@@ -13,27 +12,6 @@ const analytics = require('../analytics');
|
||||
const reset = require('./reset');
|
||||
const { pluginNamePattern, themeNamePattern } = require('../constants');
|
||||
|
||||
function buildTargets() {
|
||||
var aliases = build.aliases;
|
||||
var length = 0;
|
||||
var output = Object.keys(aliases).map(function (name) {
|
||||
var arr = aliases[name];
|
||||
if (name.length > length) {
|
||||
length = name.length;
|
||||
}
|
||||
|
||||
return [name, arr.join(', ')];
|
||||
}).map(function (tuple) {
|
||||
return ' ' + _.padEnd('"' + tuple[0] + '"', length + 2).magenta + ' | ' + tuple[1];
|
||||
}).join('\n');
|
||||
console.log(
|
||||
'\n\n Build targets:\n' +
|
||||
('\n ' + _.padEnd('Target', length + 2) + ' | Aliases').green +
|
||||
'\n ------------------------------------------------------\n'.blue +
|
||||
output + '\n'
|
||||
);
|
||||
}
|
||||
|
||||
async function activate(plugin) {
|
||||
if (themeNamePattern.test(plugin)) {
|
||||
await reset.reset({
|
||||
@@ -176,7 +154,6 @@ async function buildWrapper(targets, options) {
|
||||
}
|
||||
|
||||
exports.build = buildWrapper;
|
||||
exports.buildTargets = buildTargets;
|
||||
exports.activate = activate;
|
||||
exports.listPlugins = listPlugins;
|
||||
exports.listEvents = listEvents;
|
||||
|
||||
44
src/meta/aliases.js
Normal file
44
src/meta/aliases.js
Normal file
@@ -0,0 +1,44 @@
|
||||
'use strict';
|
||||
|
||||
const _ = require('lodash');
|
||||
|
||||
const aliases = {
|
||||
'plugin static dirs': ['staticdirs'],
|
||||
'requirejs modules': ['rjs', 'modules'],
|
||||
'client js bundle': ['clientjs', 'clientscript', 'clientscripts'],
|
||||
'admin js bundle': ['adminjs', 'adminscript', 'adminscripts'],
|
||||
javascript: ['js'],
|
||||
'client side styles': [
|
||||
'clientcss', 'clientless', 'clientstyles', 'clientstyle',
|
||||
],
|
||||
'admin control panel styles': [
|
||||
'admincss', 'adminless', 'adminstyles', 'adminstyle', 'acpcss', 'acpless', 'acpstyles', 'acpstyle',
|
||||
],
|
||||
styles: ['css', 'less', 'style'],
|
||||
templates: ['tpl'],
|
||||
languages: ['lang', 'i18n'],
|
||||
};
|
||||
|
||||
exports.aliases = aliases;
|
||||
|
||||
function buildTargets() {
|
||||
var length = 0;
|
||||
var output = Object.keys(aliases).map(function (name) {
|
||||
var arr = aliases[name];
|
||||
if (name.length > length) {
|
||||
length = name.length;
|
||||
}
|
||||
|
||||
return [name, arr.join(', ')];
|
||||
}).map(function (tuple) {
|
||||
return ' ' + _.padEnd('"' + tuple[0] + '"', length + 2).magenta + ' | ' + tuple[1];
|
||||
}).join('\n');
|
||||
console.log(
|
||||
'\n\n Build targets:\n' +
|
||||
('\n ' + _.padEnd('Target', length + 2) + ' | Aliases').green +
|
||||
'\n ------------------------------------------------------\n'.blue +
|
||||
output + '\n'
|
||||
);
|
||||
}
|
||||
|
||||
exports.buildTargets = buildTargets;
|
||||
@@ -8,6 +8,7 @@ const path = require('path');
|
||||
const mkdirp = require('mkdirp');
|
||||
|
||||
const cacheBuster = require('./cacheBuster');
|
||||
const { aliases } = require('./aliases');
|
||||
let meta;
|
||||
|
||||
const targetHandlers = {
|
||||
@@ -47,26 +48,7 @@ const targetHandlers = {
|
||||
},
|
||||
};
|
||||
|
||||
let aliases = {
|
||||
'plugin static dirs': ['staticdirs'],
|
||||
'requirejs modules': ['rjs', 'modules'],
|
||||
'client js bundle': ['clientjs', 'clientscript', 'clientscripts'],
|
||||
'admin js bundle': ['adminjs', 'adminscript', 'adminscripts'],
|
||||
javascript: ['js'],
|
||||
'client side styles': [
|
||||
'clientcss', 'clientless', 'clientstyles', 'clientstyle',
|
||||
],
|
||||
'admin control panel styles': [
|
||||
'admincss', 'adminless', 'adminstyles', 'adminstyle', 'acpcss', 'acpless', 'acpstyles', 'acpstyle',
|
||||
],
|
||||
styles: ['css', 'less', 'style'],
|
||||
templates: ['tpl'],
|
||||
languages: ['lang', 'i18n'],
|
||||
};
|
||||
|
||||
exports.aliases = aliases;
|
||||
|
||||
aliases = Object.keys(aliases).reduce(function (prev, key) {
|
||||
const aliasMap = Object.keys(aliases).reduce(function (prev, key) {
|
||||
var arr = aliases[key];
|
||||
arr.forEach(function (alias) {
|
||||
prev[alias] = key;
|
||||
@@ -151,7 +133,7 @@ exports.build = async function (targets, options) {
|
||||
// get full target name
|
||||
.map(function (target) {
|
||||
target = target.toLowerCase().replace(/-/g, '');
|
||||
if (!aliases[target]) {
|
||||
if (!aliasMap[target]) {
|
||||
winston.warn('[build] Unknown target: ' + target);
|
||||
if (target.includes(',')) {
|
||||
winston.warn('[build] Are you specifying multiple targets? Separate them with spaces:');
|
||||
@@ -161,7 +143,7 @@ exports.build = async function (targets, options) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return aliases[target];
|
||||
return aliasMap[target];
|
||||
})
|
||||
// filter nonexistent targets
|
||||
.filter(Boolean);
|
||||
|
||||
Reference in New Issue
Block a user