create-dxcli
Version:
dxcli: create your own CLI
344 lines (343 loc) • 16.3 kB
JavaScript
"use strict";
// tslint:disable no-floating-promises
// tslint:disable no-console
const _ = require("lodash");
const path = require("path");
const Generator = require("yeoman-generator");
const yosay = require("yosay");
const sortPjson = require('sort-pjson');
const fixpack = require('fixpack');
const debug = require('debug')('generator-dxcli');
const { version } = require('../../../package.json');
function stringToArray(s) {
const keywords = [];
s.split(',').forEach((keyword) => {
if (!keyword.length) {
return false;
}
return keywords.push(keyword.trim());
});
return keywords;
}
class App extends Generator {
get _ext() { return this.ts ? 'ts' : 'js'; }
constructor(args, opts) {
super(args, opts);
this.type = opts.type;
this.path = opts.path;
this.options = {
defaults: opts.defaults,
mocha: opts.options.includes('mocha'),
'semantic-release': opts.options.includes('semantic-release'),
typescript: opts.options.includes('typescript'),
};
}
async prompting() {
if (process.env.DXCLI_CREATE_DEFAULTS === '1')
this.options.defaults = true;
let msg;
switch (this.type) {
case 'single':
msg = 'Time to build a single command CLI with dxcli!';
break;
case 'multi':
msg = 'Time to build a multi command CLI with dxcli!';
break;
default:
msg = `Time to build a dxcli ${this.type}!`;
}
this.log(yosay(`${msg} Version: ${version}`));
if (this.path) {
this.destinationRoot(path.resolve(this.path));
process.chdir(this.destinationRoot());
}
this.githubUser = await this.user.github.username().catch(debug);
this.pjson = Object.assign({ scripts: {}, engines: {}, devDependencies: {}, dependencies: {} }, this.fs.readJSON('package.json', {}));
let repository = this.destinationRoot().split(path.sep).slice(-2).join('/');
if (this.githubUser)
repository = `${this.githubUser}/${repository.split('/')[1]}`;
const defaults = Object.assign({ name: this.determineAppname().replace(/ /g, '-'), version: '0.0.0', license: 'MIT', author: this.githubUser ? `${this.user.git.name()} @${this.githubUser}` : this.user.git.name(), dependencies: {}, repository }, this.pjson, { engines: Object.assign({ node: '>=8.0.0' }, this.pjson.engines), options: this.options });
this.fromScratch = Object.keys(this.pjson.dependencies).length === 0;
if (this.options.defaults) {
this.answers = defaults;
}
else {
this.answers = await this.prompt([
{
type: 'input',
name: 'name',
message: 'npm package name',
default: defaults.name,
when: !this.pjson.name,
},
{
type: 'input',
name: 'description',
message: 'description',
default: defaults.description,
when: !this.pjson.description,
},
{
type: 'input',
name: 'author',
message: 'author',
default: defaults.author,
when: !this.pjson.author,
},
{
type: 'input',
name: 'version',
message: 'version',
default: defaults.version,
when: !this.pjson.version,
},
{
type: 'input',
name: 'license',
message: 'license',
default: defaults.license,
when: !this.pjson.license,
},
{
type: 'input',
name: 'engines.node',
message: 'node version supported',
default: defaults.engines.node,
when: !this.pjson.engines.node,
},
{
type: 'input',
name: 'github.user',
message: 'github owner of repository (https://github.com/OWNER/repo)',
default: defaults.repository.split('/').slice(0, -1).pop(),
when: !this.pjson.repository,
},
{
type: 'input',
name: 'github.repo',
message: 'github name of repository (https://github.com/owner/REPO)',
default: (answers) => (this.pjson.repository ? this.pjson.repository : answers.name).split('/').pop(),
when: !this.pjson.repository,
},
{
type: 'checkbox',
name: 'options',
message: 'components to include',
choices: [
{ name: 'typescript', checked: this.fromScratch ? false : !!this.pjson.devDependencies.typescript },
{ name: 'semantic-release', checked: this.fromScratch ? false : !!this.pjson.devDependencies['@dxcli/semantic-release'] },
{ name: 'mocha', checked: this.fromScratch ? false : !!this.pjson.devDependencies.mocha },
],
filter: ((arr) => _.keyBy(arr)),
},
{
type: 'string',
name: 'files',
message: 'npm files to pack',
default: (answers) => answers.options.typescript ? '/lib' : '/src',
filter: stringToArray,
when: this.fromScratch,
},
]);
}
debug(this.answers);
this.options = this.answers.options;
this.ts = this.options.typescript;
this.mocha = this.options.mocha;
this.semantic_release = this.options['semantic-release'];
this.pjson.name = this.answers.name || defaults.name;
this.pjson.description = this.answers.description || defaults.description;
this.pjson.version = this.answers.version || defaults.version;
this.pjson.engines.node = this.answers.engines ? this.answers.engines.node : defaults.engines.node;
this.pjson.author = this.answers.author || defaults.author;
this.pjson.files = this.answers.files || defaults.files || [(this.ts ? '/lib' : '/src')];
this.pjson.license = this.answers.license || defaults.license;
this.pjson.repository = this.answers.github ? `${this.answers.github.user}/${this.answers.github.repo}` : defaults.repository;
this.pjson.scripts.test = defaults.scripts.test || 'nps test -l warn';
this.pjson.scripts.precommit = defaults.scripts.precommit || 'nps lint -l warn';
this.pjson.keywords = defaults.keywords || [this.type === 'plugin' ? 'dxcli-plugin' : 'dxcli'];
this.pjson.homepage = defaults.homepage || `https://github.com/${defaults.repository}`;
this.pjson.bugs = defaults.bugs || `https://github.com/${defaults.repository}/issues`;
if (this.type !== 'plugin') {
this.pjson.main = defaults.main || (this.ts ? 'lib/index.js' : 'src/index.js');
if (this.ts) {
this.pjson.types = defaults.types || 'lib/index.d.ts';
}
}
if (this.ts) {
this.pjson.scripts.prepublishOnly = defaults.scripts.prepublishOnly || 'rm -rf lib && nps build';
}
if (this.semantic_release) {
this.pjson.scripts.commitmsg = defaults.scripts.commitmsg || 'dxcli-commitlint';
}
}
writing() {
this.sourceRoot(path.join(__dirname, '../../../templates/app'));
switch (this.type) {
case 'multi':
case 'plugin':
this.pjson.dxcli = Object.assign({ commands: `./${this.ts ? 'lib' : 'src'}/commands` }, this.pjson.dxcli);
break;
default:
}
if (this.type === 'multi' && !this.pjson.dxcli.plugins) {
this.pjson.dxcli.plugins = [
'@dxcli/version',
];
}
if (this.ts) {
this.fs.copyTpl(this.templatePath('tslint.json'), this.destinationPath('tslint.json'), this);
this.fs.copyTpl(this.templatePath('tsconfig.json'), this.destinationPath('tsconfig.json'), this);
if (this.mocha) {
this.fs.copyTpl(this.templatePath('test/tsconfig.json'), this.destinationPath('test/tsconfig.json'), this);
}
}
if (this.mocha) {
this.fs.copyTpl(this.templatePath('test/helpers/init.js'), this.destinationPath('test/helpers/init.js'), this);
this.fs.copyTpl(this.templatePath('test/mocha.opts'), this.destinationPath('test/mocha.opts'), this);
}
if (this.fs.exists(this.destinationPath('./package.json'))) {
fixpack(this.destinationPath('./package.json'), require('fixpack/config.json'));
}
this.fs.writeJSON(this.destinationPath('./package.json'), sortPjson(this.pjson));
this.fs.copyTpl(this.templatePath('editorconfig'), this.destinationPath('.editorconfig'), this);
this.fs.copyTpl(this.templatePath('scripts/yarn'), this.destinationPath('.circleci/yarn'), this);
this.fs.copyTpl(this.templatePath('scripts/setup_git'), this.destinationPath('.circleci/setup_git'), this);
this.fs.copyTpl(this.templatePath('README.md.ejs'), this.destinationPath('README.md'), this);
this.fs.copyTpl(this.templatePath('circle.yml.ejs'), this.destinationPath('.circleci/config.yml'), this);
this.fs.copyTpl(this.templatePath('appveyor.yml'), this.destinationPath('appveyor.yml'), this);
// git
if (this.fromScratch)
this.spawnCommandSync('git', ['init']);
this.fs.copyTpl(this.templatePath('gitattributes'), this.destinationPath('.gitattributes'), this);
this.fs.write(this.destinationPath('.gitignore'), this._gitignore());
this.fs.copyTpl(this.templatePath('eslintrc'), this.destinationPath('.eslintrc'), this);
this.fs.write(this.destinationPath('.eslintignore'), this._eslintignore());
this.fs.copyTpl(this.templatePath('package-scripts.js.ejs'), this.destinationPath('package-scripts.js'), this);
switch (this.type) {
case 'single':
this._writeSingle();
break;
case 'plugin':
this._writePlugin();
break;
case 'multi':
this._writeMulti();
break;
default:
this._writeBase();
}
}
install() {
const dependencies = [];
const devDependencies = [
'@dxcli/dev',
'nps',
'nps-utils',
'husky',
'eslint',
];
switch (this.type) {
case 'base': break;
case 'single':
dependencies.push('@dxcli/parser', '@dxcli/config', '@dxcli/command', 'cli-ux');
devDependencies.push('@dxcli/engine');
break;
case 'plugin':
dependencies.push('@dxcli/config', '@dxcli/parser', '@dxcli/command', 'cli-ux');
devDependencies.push('@dxcli/engine');
break;
case 'multi':
dependencies.push('@dxcli/engine', '@dxcli/parser', '@dxcli/config', '@dxcli/command', '@dxcli/version', 'cli-ux');
}
if (this.mocha) {
devDependencies.push('mocha', 'mocha-junit-reporter', 'chai');
if (this.type !== 'base')
devDependencies.push('@dxcli/dev-test');
}
if (this.semantic_release)
devDependencies.push('@dxcli/semantic-release');
if (this.ts) {
devDependencies.push('typescript', 'ts-node', '@dxcli/tslint');
}
Promise.all([
this.yarnInstall(devDependencies, { dev: true, ignoreScripts: true }),
this.yarnInstall(dependencies),
]).then(() => {
console.log(`\nCreated ${this.pjson.name} in ${this.destinationRoot()}`);
});
}
_gitignore() {
const existing = this.fs.exists(this.destinationPath('.gitignore')) ? this.fs.read(this.destinationPath('.gitignore')).split('\n') : [];
return _([
'*-debug.log',
'*-error.log',
'/coverage.lcov',
'/coverage',
'/node_modules',
'/tmp',
this.ts && '/lib',
this.mocha && '/.nyc_output',
])
.concat(existing)
.compact()
.uniq()
.sort()
.join('\n') + '\n';
}
_eslintignore() {
const existing = this.fs.exists(this.destinationPath('.eslintignore')) ? this.fs.read(this.destinationPath('.eslintignore')).split('\n') : [];
return _([
this.ts && '/lib',
])
.concat(existing)
.compact()
.uniq()
.sort()
.join('\n') + '\n';
}
_writeSingle() {
if (!this.fromScratch)
return;
this.fs.copyTpl(this.templatePath(`single/bin/run.${this._ext}`), this.destinationPath('bin/run'), this);
this.fs.copyTpl(this.templatePath(`single/src/index.${this._ext}`), this.destinationPath(`src/index.${this._ext}`), this);
if (this.mocha) {
this.fs.copyTpl(this.templatePath(`single/test/index.test.${this._ext}`), this.destinationPath(`test/index.test.${this._ext}`), this);
}
}
_writeMulti() {
if (!this.fromScratch)
return;
this.fs.copyTpl(this.templatePath(`multi/bin/run.${this._ext}`), this.destinationPath('bin/run'), this);
this.fs.copyTpl(this.templatePath(`multi/src/index.${this._ext}`), this.destinationPath(`src/index.${this._ext}`), this);
this.fs.copyTpl(this.templatePath(`plugin/src/commands/hello.${this._ext}`), this.destinationPath(`src/commands/hello.${this._ext}`), this);
// this.fs.copyTpl(this.templatePath(`plugin/src/hooks/init.${this._ext}`), this.destinationPath(`src/hooks/init.${this._ext}`), this)
if (this.mocha) {
this.fs.copyTpl(this.templatePath(`plugin/test/commands/hello.test.${this._ext}`), this.destinationPath(`test/commands/hello.test.${this._ext}`), this);
// this.fs.copyTpl(this.templatePath(`plugin/test/hooks/init.test.${this._ext}`), this.destinationPath(`test/hooks/init.test.${this._ext}`), this)
}
}
_writePlugin() {
if (!this.fromScratch)
return;
this.fs.copyTpl(this.templatePath(`plugin/bin/run.${this._ext}`), this.destinationPath('bin/run'), this);
this.fs.copyTpl(this.templatePath(`plugin/src/commands/hello.${this._ext}`), this.destinationPath(`src/commands/hello.${this._ext}`), this);
// this.fs.copyTpl(this.templatePath(`plugin/src/hooks/init.${this._ext}`), this.destinationPath(`src/hooks/init.${this._ext}`), this)
if (this.ts) {
this.fs.copyTpl(this.templatePath('plugin/src/index.ts'), this.destinationPath('src/index.ts'), this);
}
if (this.mocha) {
this.fs.copyTpl(this.templatePath(`plugin/test/commands/hello.test.${this._ext}`), this.destinationPath(`test/commands/hello.test.${this._ext}`), this);
// this.fs.copyTpl(this.templatePath(`plugin/test/hooks/init.test.${this._ext}`), this.destinationPath(`test/hooks/init.test.${this._ext}`), this)
}
}
_writeBase() {
if (!this.fromScratch)
return;
this.fs.copyTpl(this.templatePath(`base/src/index.${this._ext}`), this.destinationPath(`src/index.${this._ext}`), this);
if (this.mocha) {
this.fs.copyTpl(this.templatePath(`base/test/index.test.${this._ext}`), this.destinationPath(`test/index.test.${this._ext}`), this);
}
}
}
module.exports = App;