mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-21 09:38:01 +02:00
105 lines
2.8 KiB
JavaScript
105 lines
2.8 KiB
JavaScript
const { wrap } = require('@joplin/lib/string-utils.js');
|
|
const Setting = require('@joplin/lib/models/Setting').default;
|
|
const { _ } = require('@joplin/lib/locale');
|
|
|
|
const MAX_WIDTH = 78;
|
|
const INDENT = ' ';
|
|
|
|
function renderTwoColumnData(options, baseIndent, width) {
|
|
const output = [];
|
|
const optionColWidth = getOptionColWidth(options);
|
|
|
|
for (let i = 0; i < options.length; i++) {
|
|
const option = options[i];
|
|
const flag = option[0];
|
|
const indent = baseIndent + INDENT + ' '.repeat(optionColWidth + 2);
|
|
|
|
let r = wrap(option[1], indent, width);
|
|
r = r.substr(flag.length + (baseIndent + INDENT).length);
|
|
r = baseIndent + INDENT + flag + r;
|
|
output.push(r);
|
|
}
|
|
|
|
return output.join('\n');
|
|
}
|
|
|
|
function renderCommandHelp(cmd, width = null) {
|
|
if (width === null) width = MAX_WIDTH;
|
|
|
|
const baseIndent = '';
|
|
|
|
const output = [];
|
|
output.push(baseIndent + cmd.usage());
|
|
output.push('');
|
|
output.push(wrap(cmd.description(), baseIndent + INDENT, width));
|
|
|
|
const optionString = renderTwoColumnData(cmd.options(), baseIndent, width);
|
|
|
|
if (optionString) {
|
|
output.push('');
|
|
output.push(optionString);
|
|
}
|
|
|
|
if (cmd.name() === 'config') {
|
|
const renderMetadata = md => {
|
|
const desc = [];
|
|
|
|
if (md.label) {
|
|
let label = md.label();
|
|
if (label.length && label[label.length - 1] !== '.') label += '.';
|
|
desc.push(label);
|
|
}
|
|
|
|
const description = Setting.keyDescription(md.key, 'cli');
|
|
if (description) desc.push(description);
|
|
|
|
desc.push(_('Type: %s.', md.isEnum ? _('Enum') : Setting.typeToString(md.type)));
|
|
if (md.isEnum) desc.push(_('Possible values: %s.', Setting.enumOptionsDoc(md.key, '%s (%s)')));
|
|
|
|
let defaultString = null;
|
|
|
|
if ('value' in md) {
|
|
if (md.type === Setting.TYPE_STRING) {
|
|
defaultString = md.value ? `"${md.value}"` : null;
|
|
} else if (md.type === Setting.TYPE_INT) {
|
|
defaultString = (md.value ? md.value : 0).toString();
|
|
} else if (md.type === Setting.TYPE_BOOL) {
|
|
defaultString = md.value === true ? 'true' : 'false';
|
|
}
|
|
}
|
|
|
|
if (defaultString !== null) desc.push(_('Default: %s', defaultString));
|
|
|
|
return [md.key, desc.join('\n')];
|
|
};
|
|
|
|
output.push('');
|
|
output.push(_('Possible keys/values:'));
|
|
output.push('');
|
|
|
|
const keysValues = [];
|
|
const keys = Setting.keys(true, 'cli');
|
|
for (let i = 0; i < keys.length; i++) {
|
|
if (keysValues.length) keysValues.push(['', '']);
|
|
const md = Setting.settingMetadata(keys[i]);
|
|
if (!md.label) continue;
|
|
keysValues.push(renderMetadata(md));
|
|
}
|
|
|
|
output.push(renderTwoColumnData(keysValues, baseIndent, width));
|
|
}
|
|
|
|
return output.join('\n');
|
|
}
|
|
|
|
function getOptionColWidth(options) {
|
|
let output = 0;
|
|
for (let j = 0; j < options.length; j++) {
|
|
const option = options[j];
|
|
if (option[0].length > output) output = option[0].length;
|
|
}
|
|
return output;
|
|
}
|
|
|
|
module.exports = { renderCommandHelp };
|