feat: added command generator

package.json

@@ -20,10 +20,10 @@
     "yosay": "^2.0.1"
   },
   "devDependencies": {
-    "@dxcli/dev": "^2.0.13",
+    "@dxcli/dev": "^2.0.14",
     "@dxcli/semantic-release": "^0.3.3",
     "@dxcli/test": "^0.9.17",
-    "@dxcli/tslint": "^0.0.24",
+    "@dxcli/tslint": "^0.1.0",
     "@semantic-release/exec": "^2.0.0",
     "@types/shelljs": "^0.7.7",
     "@types/yeoman-generator": "^2.0.1",

src/app_command.ts

@@ -14,7 +14,7 @@ export default abstract class AppCommand extends Base {
 
   abstract type: string
 
-  async run() {
+  async run () {
     const options = this.flags.options ? this.flags.options.split(',') : []
 
     await super.generate('app', {

src/command_base.ts

@@ -2,7 +2,7 @@ import Command from '@dxcli/command'
 import {createEnv} from 'yeoman-environment'
 
 export default abstract class CommandBase extends Command {
-  protected async generate(type: string, generatorOptions: object = {}) {
+  protected async generate (type: string, generatorOptions: object = {}) {
     const env = createEnv()
 
     env.register(

src/commands/command.ts

@@ -0,0 +1,27 @@
+import {flags} from '@dxcli/command'
+
+import Base from '../command_base'
+
+export interface Options {
+  name: string
+  defaults?: boolean
+  force?: boolean
+}
+
+export default abstract class AppCommand extends Base {
+  static flags: flags.Input = {
+    defaults: flags.boolean({description: 'use defaults for every setting'}),
+    force: flags.boolean({description: 'overwrite existing files'}),
+  }
+  static args = [
+    {name: 'name', description: 'name of command', required: true}
+  ]
+
+  async run () {
+    await super.generate('command', {
+      name: this.args.name,
+      defaults: this.flags.defaults,
+      force: this.flags.force
+    })
+  }
+}

src/generators/app/index.ts

@@ -11,7 +11,7 @@ const fixpack = require('fixpack')
 const debug = require('debug')('generator-dxcli')
 const {version} = require('../../../package.json')
 
-function stringToArray(s: string) {
+function stringToArray (s: string) {
   const keywords: string[] = []
 
   s.split(',').forEach((keyword: string) => {
@@ -56,9 +56,9 @@ class App extends Generator {
   mocha: boolean
   semantic_release: boolean
   ts: boolean
-  get _ext() { return this.ts ? 'ts' : 'js' }
+  get _ext () { return this.ts ? 'ts' : 'js' }
 
-  constructor(args: any, opts: any) {
+  constructor (args: any, opts: any) {
     super(args, opts)
 
     this.type = opts.type
@@ -71,7 +71,7 @@ class App extends Generator {
     }
   }
 
-  async prompting() {
+  async prompting () {
     if (process.env.DXCLI_CREATE_DEFAULTS === '1') this.options.defaults = true
     let msg
     switch (this.type) {
@@ -230,8 +230,8 @@ class App extends Generator {
     }
   }
 
-  writing() {
-    this.sourceRoot(path.join(__dirname, '../../../templates/app'))
+  writing () {
+    this.sourceRoot(path.join(__dirname, '../../../templates'))
 
     switch (this.type) {
       case 'multi':
@@ -296,7 +296,7 @@ class App extends Generator {
     }
   }
 
-  install() {
+  install () {
     const dependencies: string[] = []
     const devDependencies = [
       '@dxcli/dev',
@@ -362,7 +362,7 @@ class App extends Generator {
     })
   }
 
-  private _gitignore(): string {
+  private _gitignore (): string {
     const existing = this.fs.exists(this.destinationPath('.gitignore')) ? this.fs.read(this.destinationPath('.gitignore')).split('\n') : []
     return _([
       '*-debug.log',
@@ -381,7 +381,7 @@ class App extends Generator {
       .join('\n') + '\n'
   }
 
-  private _eslintignore(): string {
+  private _eslintignore (): string {
     const existing = this.fs.exists(this.destinationPath('.eslintignore')) ? this.fs.read(this.destinationPath('.eslintignore')).split('\n') : []
     return _([
       this.ts && '/lib',
@@ -393,7 +393,7 @@ class App extends Generator {
       .join('\n') + '\n'
   }
 
-  private _writeSingle() {
+  private _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)
@@ -402,33 +402,26 @@ class App extends Generator {
     }
   }
 
-  private _writeMulti() {
+  private _writeMulti () {
     if (!this.fromScratch) return
+    this._writePlugin()
     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)
-    }
   }
 
-  private _writePlugin() {
+  private _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)
+    this.fs.copyTpl(this.templatePath(`command.${this._ext}.ejs`), this.destinationPath(`src/commands/hello.${this._ext}`), {name: 'hello', _})
     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)
+      this.fs.copyTpl(this.templatePath(`command.test.${this._ext}.ejs`), this.destinationPath(`test/commands/hello.test.${this._ext}`), {name: 'hello', _})
     }
   }
 
-  private _writeBase() {
+  private _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) {

src/generators/command/index.ts

@@ -0,0 +1,46 @@
+// tslint:disable no-floating-promises
+// tslint:disable no-console
+
+import * as _ from 'lodash'
+import * as path from 'path'
+import * as Generator from 'yeoman-generator'
+import yosay = require('yosay')
+
+import {Options} from '../../commands/command'
+
+const {version} = require('../../../package.json')
+
+class CommandGenerator extends Generator {
+  pjson: {
+    name: string
+    devDependencies: {[name: string]: string}
+  }
+
+  get _path () { return this.options.name.split(':').join('/') }
+  get _ts () { return this.pjson.devDependencies.typescript }
+  get _ext () { return this._ts ? 'ts' : 'js' }
+  get _mocha () { return this.pjson.devDependencies.mocha }
+
+  constructor (args: any, public options: Options) {
+    super(args, options)
+  }
+
+  async prompting () {
+    this.pjson = this.fs.readJSON('package.json')
+    if (!this.pjson) throw new Error('not in a project directory')
+    this.log(yosay(`Adding a command to ${this.pjson.name} Version: ${version}`))
+  }
+
+  writing () {
+    this.sourceRoot(path.join(__dirname, '../../../templates'))
+    this.fs.copyTpl(this.templatePath(`command.${this._ext}.ejs`), this.destinationPath(`src/commands/${this._path}.${this._ext}`), {...this.options, _})
+    // 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/hooks/init.test.${this._ext}`), this.destinationPath(`test/hooks/init.test.${this._ext}`), this)
+      this.fs.copyTpl(this.templatePath(`command.test.${this._ext}.ejs`), this.destinationPath(`test/commands/${this._path}.test.${this._ext}`), {...this.options, _})
+    }
+    // this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson)
+  }
+}
+
+export = CommandGenerator

templates/command.js.ejs

@@ -0,0 +1,16 @@
+const {Command, flags} = require('@dxcli/command')
+const {cli} = require('cli-ux')
+<%_ const klass = _.upperFirst(_.camelCase(name.split(':').slice(-1).join(':') + ':command')) _%>
+
+class <%- klass %> extends Command {
+  async run () {
+    const name = this.flags.name || 'world'
+    cli.log(`hello ${name} from <%- name %>!`)
+  }
+}
+
+<%- klass %>.flags = {
+  name: flags.string({char: 'n', description: 'name to print'}),
+}
+
+module.exports = <%- klass %>

templates/command.test.js.ejs

@@ -0,0 +1,17 @@
+const {expect, test} = require('@dxcli/test')
+
+const command = '<%- name %>'
+
+describe(command, () => {
+  test
+    .stdout()
+    .command([command])
+    .do(ctx => expect(ctx.stdout).to.equal('hello world from <%- name %>!\n'))
+    .it()
+
+  test
+    .stdout()
+    .command([command, '--name', 'jeff'])
+    .do(ctx => expect(ctx.stdout).to.equal('hello jeff from <%- name %>!\n'))
+    .it()
+})

templates/command.test.ts.ejs

@@ -0,0 +1,17 @@
+import {expect, test} from '@dxcli/test'
+
+const command = '<%- name %>'
+
+describe(command, () => {
+  test
+  .stdout()
+  .command([command])
+  .do(ctx => expect(ctx.stdout).to.contain('hello world from <%- name %>!'))
+  .it()
+
+  test
+  .stdout()
+  .command([command, '--name', 'jeff'])
+  .do(ctx => expect(ctx.stdout).to.contain('hello jeff from <%- name %>!'))
+  .it()
+})

templates/command.ts.ejs

@@ -0,0 +1,13 @@
+import {Command, flags} from '@dxcli/command'
+import cli from 'cli-ux'
+
+export default class <%- _.upperFirst(_.camelCase(name)) %> extends Command {
+  static flags = {
+    name: flags.string({char: 'n', description: 'name to print'})
+  }
+
+  async run () {
+    const name = this.flags.name || 'world'
+    cli.log(`hello ${name} from <%- name %>!`)
+  }
+}

test/commands/base/everything.test.js

@@ -1,6 +1 @@
-const run = require('../../run')
-
-describe('base', () => {
-  run('base', 'everything')
-    .it()
-})
+require('../../run')(module.filename)

test/commands/base/mocha.test.js

@@ -1,6 +1 @@
-const run = require('../../run')
-
-describe('base', () => {
-  run('base', 'mocha')
-    .it()
-})
+require('../../run')(module.filename)

test/commands/base/plain.test.js

@@ -1,6 +1 @@
-const run = require('../../run')
-
-describe('base', () => {
-  run('base', 'plain')
-    .it()
-})
+require('../../run')(module.filename)

test/commands/base/typescript.test.js

@@ -1,6 +1 @@
-const run = require('../../run')
-
-describe('base', () => {
-  run('base', 'typescript')
-    .it()
-})
+require('../../run')(module.filename)

test/commands/command/everything.test.js

@@ -0,0 +1 @@
+require('../../run')(module.filename)

test/commands/command/mocha.test.js

@@ -0,0 +1 @@
+require('../../run')(module.filename)