mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-11-13 09:25:45 +01:00
CLI refactor with commander (#6058)
* CLI refactor with commander - Modularized the functionality - All functionality done directly from `./nodebb` now (still available from `app` for backwards compatibility) - Moved all CLI code from `./nodebb` to `src/cli` - Fixed `nodebb.bat` to work from any location, like `./nodebb`, and also hides command output - Overwrite some commander methods to add CLI color support - Added `./nodebb info` for quick info including git hash, NodeBB version, node version, and some database info - Refactored `./nodebb reset` to allow multiple resets at once - Changed `./nodebb restart` to essentially stop and start, as Windows doesn't support signals - Added `-l, --log` option which works on `./nodebb start` and `./nodebb restart` to show logging, like `./nodebb slog` - Expanded `-d, --dev` option which works on them as well, like `./nodebb dev` - Improvements to self-help. `./nodebb build -h` will output all possible targets - `./nodebb reset` explains usage better * Fix some style inconsistencies * Fix prestart being required before modules installed * Fix travis failures * Fix `help` command to output help for subcommands * Pick steps of the upgrade process to run * Fix formatting for upgrade help * Fix web installer
This commit is contained in:
Peter Jaszkowiak
committed by
Barış Soner Uşaklı
Barış Soner Uşaklı
parent
c731661a39
commit
ae24bca16e
265
src/cli/index.js
Normal file
265
src/cli/index.js
Normal file
@@ -0,0 +1,265 @@
|
||||
'use strict';
|
||||
|
||||
var fs = require('fs');
|
||||
var path = require('path');
|
||||
|
||||
var packageInstall = require('../meta/package-install');
|
||||
var dirname = require('./paths').baseDir;
|
||||
|
||||
// check to make sure dependencies are installed
|
||||
try {
|
||||
fs.readFileSync(path.join(dirname, 'package.json'));
|
||||
fs.readFileSync(path.join(dirname, 'node_modules/async/package.json'));
|
||||
} catch (e) {
|
||||
if (e.code === 'ENOENT') {
|
||||
process.stdout.write('Dependencies not yet installed.\n');
|
||||
process.stdout.write('Installing them now...\n\n');
|
||||
|
||||
packageInstall.updatePackageFile();
|
||||
packageInstall.preserveExtraneousPlugins();
|
||||
packageInstall.npmInstallProduction();
|
||||
|
||||
require('colors');
|
||||
process.stdout.write('OK'.green + '\n'.reset);
|
||||
} else {
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
require('colors');
|
||||
var nconf = require('nconf');
|
||||
var program = require('commander');
|
||||
|
||||
var pkg = require('../../package.json');
|
||||
var file = require('../file');
|
||||
var prestart = require('../prestart');
|
||||
|
||||
program
|
||||
.name('./nodebb')
|
||||
.description('Welcome to NodeBB')
|
||||
.version(pkg.version)
|
||||
.option('--json-logging', 'Output to logs in JSON format', false)
|
||||
.option('--log-level <level>', 'Default logging level to use', 'info')
|
||||
.option('-d, --dev', 'Development mode, including verbose logging', false)
|
||||
.option('-l, --log', 'Log subprocess output to console', false)
|
||||
.option('-c, --config <value>', 'Specify a config file', 'config.json')
|
||||
.parse(process.argv);
|
||||
|
||||
nconf.argv().env({
|
||||
separator: '__',
|
||||
});
|
||||
|
||||
var 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(dirname, program.config);
|
||||
var configExists = file.existsSync(configFile) || (nconf.get('url') && nconf.get('secret') && nconf.get('database'));
|
||||
|
||||
prestart.loadConfig(configFile);
|
||||
prestart.versionCheck();
|
||||
|
||||
if (!configExists && process.argv[2] !== 'setup') {
|
||||
require('./setup').webInstall();
|
||||
return;
|
||||
}
|
||||
|
||||
// running commands
|
||||
program
|
||||
.command('start')
|
||||
.description('Start the NodeBB server')
|
||||
.action(function () {
|
||||
require('./running').start(program);
|
||||
});
|
||||
program
|
||||
.command('slog', null, {
|
||||
noHelp: true,
|
||||
})
|
||||
.description('Start the NodeBB server and view the live output log')
|
||||
.action(function () {
|
||||
program.log = true;
|
||||
require('./running').start(program);
|
||||
});
|
||||
program
|
||||
.command('dev', null, {
|
||||
noHelp: true,
|
||||
})
|
||||
.description('Start NodeBB in verbose development mode')
|
||||
.action(function () {
|
||||
program.dev = true;
|
||||
process.env.NODE_ENV = 'development';
|
||||
global.env = 'development';
|
||||
require('./running').start(program);
|
||||
});
|
||||
program
|
||||
.command('stop')
|
||||
.description('Stop the NodeBB server')
|
||||
.action(function () {
|
||||
require('./running').stop(program);
|
||||
});
|
||||
program
|
||||
.command('restart')
|
||||
.description('Restart the NodeBB server')
|
||||
.action(function () {
|
||||
require('./running').restart(program);
|
||||
});
|
||||
program
|
||||
.command('status')
|
||||
.description('Check the running status of the NodeBB server')
|
||||
.action(function () {
|
||||
require('./running').status(program);
|
||||
});
|
||||
program
|
||||
.command('log')
|
||||
.description('Open the output log (useful for debugging)')
|
||||
.action(function () {
|
||||
require('./running').log(program);
|
||||
});
|
||||
|
||||
// management commands
|
||||
program
|
||||
.command('setup')
|
||||
.description('Run the NodeBB setup script')
|
||||
.action(function () {
|
||||
require('./setup').setup();
|
||||
});
|
||||
|
||||
program
|
||||
.command('install')
|
||||
.description('Launch the NodeBB web installer for configuration setup')
|
||||
.action(function () {
|
||||
require('./setup').webInstall();
|
||||
});
|
||||
program
|
||||
.command('build [targets...]')
|
||||
.description('Compile static assets ' + '(JS, CSS, templates, languages, sounds)'.red)
|
||||
.action(function (targets) {
|
||||
require('./manage').build(targets.length ? targets : true);
|
||||
})
|
||||
.on('--help', function () {
|
||||
require('./manage').buildTargets();
|
||||
});
|
||||
program
|
||||
.command('activate [plugin]')
|
||||
.description('Activate a plugin for the next startup of NodeBB (nodebb-plugin- prefix is optional)')
|
||||
.action(function (plugin) {
|
||||
require('./manage').activate(plugin);
|
||||
});
|
||||
program
|
||||
.command('plugins')
|
||||
.action(function () {
|
||||
require('./manage').listPlugins();
|
||||
})
|
||||
.description('List all installed plugins');
|
||||
program
|
||||
.command('events')
|
||||
.description('Outputs the last ten (10) administrative events recorded by NodeBB')
|
||||
.action(function () {
|
||||
require('./manage').listEvents();
|
||||
});
|
||||
program
|
||||
.command('info')
|
||||
.description('Outputs various system info')
|
||||
.action(function () {
|
||||
require('./manage').info();
|
||||
});
|
||||
|
||||
// reset
|
||||
var resetCommand = program.command('reset');
|
||||
|
||||
resetCommand
|
||||
.description('Reset plugins, themes, settings, etc')
|
||||
.option('-t, --theme [theme]', 'Reset to [theme] or to the default theme')
|
||||
.option('-p, --plugin [plugin]', 'Disable [plugin] or all plugins')
|
||||
.option('-w, --widgets', 'Disable all widgets')
|
||||
.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) {
|
||||
return options[x];
|
||||
});
|
||||
if (!valid) {
|
||||
process.stdout.write('\n No valid options passed in, so nothing was reset.\n'.red);
|
||||
resetCommand.help();
|
||||
}
|
||||
|
||||
require('./reset').reset(options, function (err) {
|
||||
if (err) { throw err; }
|
||||
require('../meta/build').buildAll(function (err) {
|
||||
if (err) { throw err; }
|
||||
|
||||
process.exit();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// upgrades
|
||||
program
|
||||
.command('upgrade [scripts...]')
|
||||
.description('Run NodeBB upgrade scripts and ensure packages are up-to-date, or run a particular upgrade script')
|
||||
.option('-m, --package', 'Update package.json from defaults', false)
|
||||
.option('-i, --install', 'Bringing base dependencies up to date', false)
|
||||
.option('-p, --plugins', 'Check installed plugins for updates', false)
|
||||
.option('-s, --schema', 'Update NodeBB data store schema', false)
|
||||
.option('-b, --build', 'Rebuild assets', false)
|
||||
.on('--help', function () {
|
||||
process.stdout.write(
|
||||
'\n' +
|
||||
'When running particular upgrade scripts, options are ignored.\n' +
|
||||
'By default all options are enabled. Passing any options disables that default.\n' +
|
||||
'Only package and dependency updates: ' + './nodebb upgrade -mi\n'.yellow +
|
||||
'Only database update: ' + './nodebb upgrade -d\n\n'.yellow
|
||||
);
|
||||
})
|
||||
.action(function (scripts, options) {
|
||||
require('./upgrade').upgrade(scripts.length ? scripts : true, options);
|
||||
});
|
||||
|
||||
program
|
||||
.command('upgrade-plugins', null, {
|
||||
noHelp: true,
|
||||
})
|
||||
.alias('upgradePlugins')
|
||||
.description('Upgrade plugins')
|
||||
.action(function () {
|
||||
require('./upgrade-plugins').upgradePlugins(function (err) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
process.stdout.write('OK\n'.green);
|
||||
process.exit();
|
||||
});
|
||||
});
|
||||
|
||||
program
|
||||
.command('help [command]')
|
||||
.description('Display help for [command]')
|
||||
.action(function (name) {
|
||||
if (!name) {
|
||||
return program.help();
|
||||
}
|
||||
|
||||
var command = program.commands.find(function (command) { return command._name === name; });
|
||||
if (command) {
|
||||
command.help();
|
||||
} else {
|
||||
program.help();
|
||||
}
|
||||
});
|
||||
|
||||
program
|
||||
.command('*', {}, {
|
||||
noHelp: true,
|
||||
})
|
||||
.action(function () {
|
||||
program.help();
|
||||
});
|
||||
|
||||
require('./colors');
|
||||
|
||||
program.executables = false;
|
||||
|
||||
program.parse(process.argv);
|
||||
Reference in New Issue
Block a user