Add CLI tool to install/search plugins or launch app (#2375)
This commit is contained in:
CHaBou
GitHub
parent
bbb1caefb4
commit
5700690e0b
15 changed files with 790 additions and 68 deletions
112
cli/api.js
Normal file
112
cli/api.js
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
const fs = require('fs');
|
||||
const os = require('os');
|
||||
const npmName = require('npm-name');
|
||||
const pify = require('pify');
|
||||
const recast = require('recast');
|
||||
|
||||
const fileName = `${os.homedir()}/.hyper.js`;
|
||||
|
||||
let fileContents;
|
||||
let parsedFile;
|
||||
let plugins;
|
||||
let localPlugins;
|
||||
|
||||
try {
|
||||
fileContents = fs.readFileSync(fileName, 'utf8');
|
||||
|
||||
parsedFile = recast.parse(fileContents);
|
||||
|
||||
const properties = parsedFile.program.body[0].expression.right.properties;
|
||||
plugins = properties.find(property => {
|
||||
return property.key.name === 'plugins';
|
||||
}).value.elements;
|
||||
|
||||
localPlugins = properties.find(property => {
|
||||
return property.key.name === 'localPlugins';
|
||||
}).value.elements;
|
||||
} catch (err) {
|
||||
if (err.code !== 'ENOENT') {
|
||||
// ENOENT === !exists()
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
function exists() {
|
||||
return fileContents !== undefined;
|
||||
}
|
||||
|
||||
function isInstalled(plugin, locally) {
|
||||
const array = locally ? localPlugins : plugins;
|
||||
if (array && Array.isArray(array)) {
|
||||
return array.find(entry => entry.value === plugin) !== undefined;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function save() {
|
||||
return pify(fs.writeFile)(fileName, recast.print(parsedFile).code, 'utf8');
|
||||
}
|
||||
|
||||
function existsOnNpm(plugin) {
|
||||
plugin = plugin.split('#')[0].split('@')[0];
|
||||
return npmName(plugin).then(unavailable => {
|
||||
if (unavailable) {
|
||||
const err = new Error(`${plugin} not found on npm`);
|
||||
err.code = 'NOT_FOUND_ON_NPM';
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function install(plugin, locally) {
|
||||
const array = locally ? localPlugins : plugins;
|
||||
return new Promise((resolve, reject) => {
|
||||
existsOnNpm(plugin)
|
||||
.then(() => {
|
||||
if (isInstalled(plugin, locally)) {
|
||||
return reject(`${plugin} is already installed`);
|
||||
}
|
||||
|
||||
array.push(recast.types.builders.literal(plugin));
|
||||
save()
|
||||
.then(resolve)
|
||||
.catch(err => reject(err));
|
||||
})
|
||||
.catch(err => {
|
||||
if (err.code === 'NOT_FOUND_ON_NPM') {
|
||||
reject(err.message);
|
||||
} else {
|
||||
reject(err);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function uninstall(plugin) {
|
||||
return new Promise((resolve, reject) => {
|
||||
if (!isInstalled(plugin)) {
|
||||
return reject(`${plugin} is not installed`);
|
||||
}
|
||||
|
||||
const index = plugins.findIndex(entry => entry.value === plugin);
|
||||
plugins.splice(index, 1);
|
||||
save()
|
||||
.then(resolve)
|
||||
.catch(err => reject(err));
|
||||
});
|
||||
}
|
||||
|
||||
function list() {
|
||||
if (Array.isArray(plugins)) {
|
||||
return plugins.map(plugin => plugin.value).join('\n');
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
module.exports.configPath = fileName;
|
||||
module.exports.exists = exists;
|
||||
module.exports.existsOnNpm = existsOnNpm;
|
||||
module.exports.isInstalled = isInstalled;
|
||||
module.exports.install = install;
|
||||
module.exports.uninstall = uninstall;
|
||||
module.exports.list = list;
|
||||
210
cli/index.js
Normal file
210
cli/index.js
Normal file
|
|
@ -0,0 +1,210 @@
|
|||
// This is a CLI tool, using console is OK
|
||||
/* eslint no-console: 0 */
|
||||
const {spawn, exec} = require('child_process');
|
||||
const {isAbsolute, resolve} = require('path');
|
||||
const {existsSync} = require('fs');
|
||||
const pify = require('pify');
|
||||
const args = require('args');
|
||||
const chalk = require('chalk');
|
||||
const opn = require('opn');
|
||||
const columnify = require('columnify');
|
||||
const got = require('got');
|
||||
const ora = require('ora');
|
||||
const api = require('./api');
|
||||
|
||||
const PLUGIN_PREFIX = 'hyper-';
|
||||
|
||||
let commandPromise;
|
||||
|
||||
const getPluginName = arg => {
|
||||
if (arg.indexOf(PLUGIN_PREFIX) !== 0) {
|
||||
return `${PLUGIN_PREFIX}${arg}`;
|
||||
}
|
||||
return arg;
|
||||
};
|
||||
|
||||
const checkConfig = () => {
|
||||
if (api.exists()) {
|
||||
return true;
|
||||
}
|
||||
let msg = chalk.red(`Error! Config file not found: ${api.configPath}\n`);
|
||||
msg += 'Please launch Hyper and retry.';
|
||||
console.error(msg);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
args.command(['i', 'install'], 'Install a plugin', (name, args_) => {
|
||||
checkConfig();
|
||||
const plugin = getPluginName(args_[0]);
|
||||
commandPromise = api
|
||||
.install(plugin)
|
||||
.then(() => console.log(chalk.green(`${plugin} installed successfully!`)))
|
||||
.catch(err => console.error(chalk.red(err)));
|
||||
});
|
||||
|
||||
args.command(['u', 'uninstall', 'rm', 'remove'], 'Uninstall a plugin', (name, args_) => {
|
||||
checkConfig();
|
||||
const plugin = getPluginName(args_[0]);
|
||||
commandPromise = api
|
||||
.uninstall(plugin)
|
||||
.then(() => console.log(chalk.green(`${plugin} uninstalled successfully!`)))
|
||||
.catch(err => console.log(chalk.red(err)));
|
||||
});
|
||||
|
||||
args.command(['ls', 'list'], 'List installed plugins', () => {
|
||||
checkConfig();
|
||||
let plugins = api.list();
|
||||
|
||||
if (plugins) {
|
||||
console.log(plugins);
|
||||
} else {
|
||||
console.log(chalk.red(`No plugins installed yet.`));
|
||||
}
|
||||
process.exit(0);
|
||||
});
|
||||
|
||||
const lsRemote = pattern => {
|
||||
// note that no errors are catched by this function
|
||||
const URL = `https://api.npms.io/v2/search?q=${(pattern && `${pattern}+`) || ''}keywords:hyper-plugin,hyper-theme`;
|
||||
return got(URL)
|
||||
.then(response => JSON.parse(response.body).results)
|
||||
.then(entries => entries.map(entry => entry.package))
|
||||
.then(entries => entries.filter(entry => entry.name.indexOf(PLUGIN_PREFIX) === 0))
|
||||
.then(entries =>
|
||||
entries.map(({name, description}) => {
|
||||
return {name, description};
|
||||
})
|
||||
)
|
||||
.then(entries =>
|
||||
entries.map(entry => {
|
||||
entry.name = chalk.green(entry.name);
|
||||
return entry;
|
||||
})
|
||||
);
|
||||
};
|
||||
|
||||
args.command(['s', 'search'], 'Search for plugins on npm', (name, args_) => {
|
||||
const spinner = ora('Searching').start();
|
||||
const query = args_[0] ? args_[0].toLowerCase() : '';
|
||||
|
||||
commandPromise = lsRemote(query)
|
||||
.then(entries => {
|
||||
if (entries.length === 0) {
|
||||
spinner.fail();
|
||||
console.error(chalk.red(`Your search '${query}' did not match any plugins`));
|
||||
console.error(`${chalk.red('Try')} ${chalk.green('hyper ls-remote')}`);
|
||||
process.exit(1);
|
||||
} else {
|
||||
let msg = columnify(entries);
|
||||
spinner.succeed();
|
||||
msg = msg.substring(msg.indexOf('\n') + 1); // remove header
|
||||
console.log(msg);
|
||||
}
|
||||
})
|
||||
.catch(err => {
|
||||
spinner.fail();
|
||||
console.error(chalk.red(err)); // TODO
|
||||
});
|
||||
});
|
||||
|
||||
args.command(['lsr', 'list-remote', 'ls-remote'], 'List plugins available on npm', () => {
|
||||
const spinner = ora('Searching').start();
|
||||
|
||||
commandPromise = lsRemote()
|
||||
.then(entries => {
|
||||
let msg = columnify(entries);
|
||||
|
||||
spinner.succeed();
|
||||
msg = msg.substring(msg.indexOf('\n') + 1); // remove header
|
||||
console.log(msg);
|
||||
})
|
||||
.catch(err => {
|
||||
spinner.fail();
|
||||
console.error(chalk.red(err)); // TODO
|
||||
});
|
||||
});
|
||||
|
||||
args.command(['d', 'docs', 'h', 'home'], 'Open the npm page of a plugin', (name, args_) => {
|
||||
const plugin = getPluginName(args_[0]);
|
||||
opn(`http://ghub.io/${plugin}`, {wait: false});
|
||||
process.exit(0);
|
||||
});
|
||||
|
||||
args.command(['<default>'], 'Launch Hyper');
|
||||
|
||||
args.option(['v', 'verbose'], 'Verbose mode', false);
|
||||
|
||||
const main = argv => {
|
||||
const flags = args.parse(argv, {
|
||||
name: 'hyper',
|
||||
version: false,
|
||||
mri: {
|
||||
boolean: ['v', 'verbose']
|
||||
}
|
||||
});
|
||||
|
||||
if (commandPromise) {
|
||||
return commandPromise;
|
||||
}
|
||||
|
||||
const env = Object.assign({}, process.env, {
|
||||
// this will signal Hyper that it was spawned from this module
|
||||
HYPER_CLI: '1',
|
||||
ELECTRON_NO_ATTACH_CONSOLE: '1'
|
||||
});
|
||||
|
||||
delete env['ELECTRON_RUN_AS_NODE'];
|
||||
|
||||
if (flags.verbose) {
|
||||
env['ELECTRON_ENABLE_LOGGING'] = '1';
|
||||
}
|
||||
|
||||
const options = {
|
||||
detached: true,
|
||||
env
|
||||
};
|
||||
|
||||
const args_ = args.sub.map(arg => {
|
||||
const cwd = isAbsolute(arg) ? arg : resolve(process.cwd(), arg);
|
||||
if (!existsSync(cwd)) {
|
||||
console.error(chalk.red(`Error! Directory or file does not exist: ${cwd}`));
|
||||
process.exit(1);
|
||||
}
|
||||
return cwd;
|
||||
});
|
||||
|
||||
if (!flags.verbose) {
|
||||
options['stdio'] = 'ignore';
|
||||
if (process.platform === 'darwin') {
|
||||
//Use `open` to prevent multiple Hyper process
|
||||
const cmd = `open -b co.zeit.hyper ${args_}`;
|
||||
const opts = {
|
||||
env
|
||||
};
|
||||
return pify(exec)(cmd, opts);
|
||||
}
|
||||
}
|
||||
|
||||
const child = spawn(process.execPath, args_, options);
|
||||
|
||||
if (flags.verbose) {
|
||||
child.stdout.on('data', data => console.log(data.toString('utf8')));
|
||||
child.stderr.on('data', data => console.error(data.toString('utf8')));
|
||||
}
|
||||
if (flags.verbose) {
|
||||
return new Promise(c => child.once('exit', () => c(null)));
|
||||
}
|
||||
child.unref();
|
||||
return Promise.resolve();
|
||||
};
|
||||
|
||||
function eventuallyExit(code) {
|
||||
setTimeout(() => process.exit(code), 100);
|
||||
}
|
||||
|
||||
main(process.argv)
|
||||
.then(() => eventuallyExit(0))
|
||||
.catch(err => {
|
||||
console.error(err.stack ? err.stack : err);
|
||||
eventuallyExit(1);
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue