termkit 1.7.1 → 2.0.1

package/src/models/Command.js

@@ -1,154 +0,0 @@
-const Option = require('./Option'),
-  cosmetic = require('cosmetic'),
-  { findCommand, findCommandVariables, findOptions, getVariables } = require('../helpers')
-
-module.exports = class Command {
-  constructor(data) {
-    this.actionFunction = null
-    this.commandsArray = []
-    this.commandStrings = ['help']
-    this.info = null
-    this.name = null
-    this.middlewaresArray = []
-    this.optionsArray = []
-    this.variables = null
-    this.versionString = null
-
-    if (!data) return
-
-    if (data.info) this.info = data.info
-    if (data.name) this.name = data.name
-    if (data.variables) this.variables = getVariables(data.variables)
-    if (data.middlewares) this.middlewaresArray = [...data.middlewares]
-    if (data.options) this.optionsArray = [...data.options]
-  }
-  description(info, description) {
-    this.info = info
-    this.description = description
-    return this
-  }
-  variable(string) {
-    let variable = getVariables(string)
-    if (variable && !this.variables) {
-      this.variables = variable
-    } else if (variable) {
-      this.variables.push(variable)
-    }
-    return this
-  }
-  action(actionFunction) {
-    this.actionFunction = actionFunction
-    return this
-  }
-  command(command) {
-    this.commandsArray.push(command)
-    return this
-  }
-  commands(commands) {
-    this.commandsArray = commands
-    commands.map(c => this.commandStrings.unshift(c.name))
-    for (let command of commands) {
-      this.commandStrings.unshift(command.name)
-    }
-    return this
-  }
-  middleware(middleware) {
-    this.middlewaresArray.push(middleware)
-    return this
-  }
-  middlewares(middlewares) {
-    this.middlewaresArray.push(...middlewares)
-    return this
-  }
-  option(short, long, variables, info) {
-    this.optionsArray.push(new Option({short, long, variables, info}))
-    return this
-  }
-  options(options) {
-    this.optionsArray.push(...options)
-    return this
-  }
-  version(version) {
-    this.versionString = version
-    return this
-  }
-  help(source) {
-    const table = []
-    let program = this.name || 'Program'
-    if (this.variables) for (const variable of this.variables) program += ` ${variable.raw}`
-    if (this.optionsArray.length > 0) program += ' [...options]'
-    table.push({ title: '\nCommand', info: program, data: [] })
-    if (this.info) table.push({ title: 'Info', info: this.info, data: [] })
-    if (this.optionsArray.length > 0) {
-      const section = { title: 'Options', data: []}
-      for (const option of this.optionsArray) {
-        let name = ''
-        if (option.short) name = `-${option.short}`
-        if (option.short && option.long) name += ', '
-        if (option.long) name += `--${option.long}`
-        if (option.variables) for (const variable of option.variables) name += ` ${variable.raw}`
-        section.data.push([name, option.info || ''])
-      }
-      table.push(section)
-    }
-    if (this.commandsArray.length > 0) {
-      const section = { title: 'Subcommands', data: []}
-      for (let command of this.commandsArray) {
-        let name = command.name
-        if (command.variables) for (const variable of command.variables) name += ` ${variable.raw}`
-        section.data.push([name, command.info || ''])
-      }
-      table.push(section)
-    }
-    const padding = {}
-    for (const section of table) for (const array of section.data) for (const [index, string] of array.entries()) if (!padding[index] || string.length > padding[index]) padding[index] = string.length
-    const lines = []
-    for (const section of table) {
-      lines.push(section.title ? cosmetic.cyan.underline(section.title) : '')
-      if (section.versionString) lines.push(`v${section.versionString}`)
-      if (section.info) lines.push(section.info)
-      for (const array of section.data) {
-        let line = ''
-        for (let [index, string] of array.entries()) {
-          if (padding[index] && padding[index] !== string.length) while (string.length < padding[index]) string += ' '
-          line += line ? `  ${string}` : string
-        }
-        lines.push(line)
-      }
-      lines.push('')
-    }
-    for (const line of lines) console.log(line)
-  }
-  async parse (array) {
-    array.splice(0, 2)
-    let command = this
-    const options = { _source: Array.from(array) }
-    while (array.length) {
-      if (!array.includes('help')) {
-        Object.assign(options, findOptions(array, command))
-        Object.assign(options, findCommandVariables(array, command))
-        Object.assign(options, findOptions(array, command))
-      }
-      if (array.length) {
-        if (!array.includes('help')) for (const middleware of command.middlewaresArray) await middleware(options)
-        const newCommand = findCommand(array, command.commandsArray)
-        if (!newCommand && array[0] === 'help') return command.help(options._source)
-        if (!newCommand) throw new SyntaxError(`Unknown command: ${array[0]}`)
-        const name = command.name || '_base'
-        if (!options._parents) options._parents = {}
-        options._parents[name] = {}
-        for (const key of Object.keys(options)) {
-          if (!key.startsWith('_')) {
-            options._parents[name][key] = options[key]
-            delete options[key]
-          }
-        }
-        command = newCommand
-      }
-    }
-    for (const middleware of command.middlewaresArray) await middleware(options)
-    if (command.actionFunction) return command.actionFunction(options)
-    if (options._source.length == 2) return command.help(options._source)
-    throw new Error(`No action for command: ${command.name || '_base'}`)
-  }
-}

package/src/models/Middleware.js

@@ -1,5 +0,0 @@
-module.exports = class Middleware {
-  constructor(action) {
-    this.action = action
-  }
-}

package/src/models/Option.js

@@ -1,22 +0,0 @@
-let helpers = require('../helpers'),
-  getVariables = helpers.getVariables
-
-module.exports = class Option {
-  constructor(data) {
-    this.short = null
-    this.long = null
-    this.info = null
-    this.variables = null
-
-    if (!data) return
-
-    if (data.short) this.short = data.short
-    if (data.long) this.long = data.long
-    if (data.info) this.info = data.info
-    if (data.variables) this.variables = getVariables(data.variables)
-  }
-  description(string) {
-    this.info = string
-    return this
-  }
-}

package/src/models/Termkit.js

@@ -1,30 +0,0 @@
-const Command = require('./Command'),
-  Middleware = require('./Middleware'),
-  Option = require('./Option')
-
-class Termkit {
-  base = null
-  command_defaults = {}
-  static set defaults(obj) {
-    Termkit.command_defaults = obj
-  }
-  static setDefaults(obj) {
-    Termkit.command_defaults = obj
-  }
-  static command(name, variables, info) {
-    const command = new Command(Object.assign({ name, variables, info }, Termkit.command_defaults))
-    if (!Termkit.base) Termkit.base = command
-    return command
-  }
-  static middleware(action) {
-    return new Middleware(action)
-  }
-  static option(short, long, variables, info) {
-    return new Option({ short, long, variables, info })
-  }
-  static parse(arr) {
-    return Termkit.base.parse(arr)
-  }
-}
-
-module.exports = Termkit

package/src/models/Variable.js

@@ -1,18 +0,0 @@
-module.exports = class Variable {
-  constructor(data) {
-    this.array = false
-    this.name = null
-    this.raw = null
-    this.required = false
-    this.value = null
-
-    if (!data) return
-
-    if (data.array) this.array = data.array
-    if (data.name) this.name = data.name
-    if (data.raw) this.raw = data.raw
-    if (data.required) this.required = data.required
-
-    if (this.array) this.value = []
-  }
-}

package/src/models/index.js

@@ -1,6 +0,0 @@
-let Command = require('./Command'),
-  Middleware = require('./Middleware'),
-  Option = require('./Option'),
-  Variable = require('./Variable')
-
-module.exports = { Command, Middleware, Option, Variable }

package/test/index.js

@@ -1,3 +0,0 @@
-// require('./_setup')
-require('./models')
-require('./program')

package/test/models/Command.js

@@ -1,19 +0,0 @@
-describe('Command', () => {
-  // describe('getToken()', () => {
-  //   it('should get and set token', async() => {
-    //   let result, error
-    //   try {
-    //     result = await getToken({
-    //       email: 'example@example.com',
-    //       password: 'password',
-    //       subdomain: 'example'
-    //     })
-    //   } catch(err) {
-    //     error = err
-    //   }
-    //   should.not.exist(error)
-    //   should.exist(result)
-    //   config.token.should.equal(result)
-  //   })
-  // })
-})

package/test/models/index.js

@@ -1,6 +0,0 @@
-describe('models', () => {
-  require('./Command')
-  require('./Middleware')
-  require('./Option')
-  require('./Variable')
-})

package/test/program/complex.js

@@ -1,160 +0,0 @@
-const { is, isnt } = require('amprisand'),
-  { command, middleware, option, setDefaults } = require('../../')
-
-// setDefaults({
-//   middlewares: [() => console.log('yooo')]
-// })
-
-let program
-
-describe('complex', () => {
-  describe('program = command()', () => {
-    it('should set up program', () => {
-      program = command('app', '<req>')
-        .version(process.env.npm_package_version)
-        .description('Program description', 'This is some super extensive detail about this command')
-        .variable('[dir]')
-        .middlewares([
-          // middleware((options) => console.log('here', options))
-        ])
-        .options([
-          option('a', 'array', '[arr...]', 'Option with array variable'),
-          option('r', 'required', '<reqA> <reqB>', 'Option with required variable'),
-          option('o', 'optional', '[opt]', 'Option with optional variable'),
-          option('b', 'boolean', null, 'Option with no variable')
-        ])
-        .action((options) => ({ command: 'app', options }))
-        .commands([
-          command('help', null, 'Help Func')
-          .action((options) => ({ command: 'help', options })),
-          command('one', '[reqA] [reqB]', 'Description of one')
-          .option('a', 'array', '[arr...]', 'Option with array variable')
-          .option('r', 'required', '<req>', 'Option with required variable')
-          .option('o', 'optional', '[opt]', 'Option wit h optional variable')
-          .option('b', 'boolean', null, 'Option with no variable')
-          .action((options) => ({ command: 'one', options })),
-          command('two', '<req>', 'Description of two')
-          .option('a', 'array', '[arr...]', 'Option with array variable')
-          .option('r', 'required', '<req>', 'Option with required variable')
-          .option('o', 'optional', '[opt]', 'Option with optional variable')
-          .option('b', 'boolean', null, 'Option with no variable')
-          .middleware(() => console.log('two middleware'))
-          .action((options) => ({ command: 'two', options }))
-          .commands([
-            command('three', null, 'Description of three')
-            .option('a', 'array', '[arr...]', 'Option with array variable')
-            .option('r', 'required', '<req>', 'Option with required variable')
-            .option('o', 'optional', '[opt]', 'Option with optional variable')
-            .option('b', 'boolean', null, 'Option with no variable')
-            .action((options) => ({ command: 'three', options }))
-            .commands([
-              command('help')
-              .action((options) => {
-                console.log('custom usage printout')
-              })
-            ]),
-            command('four', '[optA] [optB]', 'Description of four')
-            .option('a', 'array', '[arr...]', 'Option with array variable')
-            .option(null, 'required', '<req>', 'Option with required variable')
-            .option('o', null, '[opt]', 'Option with optional variable')
-            .option('b', 'boolean', null, 'Option with no variable')
-            .middleware((options) => console.log('four middleware'))
-            .action((options) => console.log('four action'))
-          ])
-        ])
-
-    })
-  })
-  describe('program.parse()', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        result = await program.parse('_ _ req --array arr0 arr1 arr2 --required req1 req2 --optional test --boolean'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      is(result)
-      result.command.is('app')
-      // program.parse('_ _ -a arr0 arr1 arr2 -r req1 req2 -o -b'.split(' '))
-      // program.parse('_ _ one testA testB'.split(' '))
-      // program.parse('_ _ test -r requiredA requiredB one -r requiredC'.split(' '))
-      // program.parse('_ _ test -a arr0 arr1 one -br required'.split(' '))
-      // program.parse('_ _ -r reqA reqB'.split(' '))
-      // program.parse('_ _ dir -r reqA reqB -a arr1 arr2 arr3 -o optional one fail'.split(' '))
-      // program.parse('_ _ two four -a arr0 arr1 arr2 -r required -ob'.split(' '))
-      // program.parse('_ _ shortcut'.split(' '))
-      // program.parse('_ _ help'.split(' '))
-      // program.parse('_ _ two three help'.split(' '))
-      // program.parse('_ _ two help'.split(' '))
-      // program.parse('_ _ two four help'.split(' '))
-      // program.parse('_ _ two required four optionalA optionalB'.split(' '))
-      // program.parse('_ _ two required four optionalA'.split(' '))
-    })
-  })
-  describe('program.parse()', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        result = await program.parse('_ _ req two req three -a arr0 arr1 arr2 -r required -ob'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      is(result)
-      result.command.is('three')
-    })
-  })
-  describe('program.parse()', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        result = await program.parse('_ _ req two req three -a arr0 arr1 arr2 --required required -ob'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      is(result)
-      result.command.is('three')
-    })
-  })
-  describe('program.parse(help)', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        result = await program.parse('_ _ help'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      is(result)
-      result.command.is('help')
-    })
-  })
-  describe('program.parse(help)', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        await program.parse('_ _ help'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      // is(result)
-      // result.command.is('help')
-    })
-  })
-  describe('program.parse(-b req)', () => {
-    it('should run program', async () => {
-      let error, result
-      try {
-        result = await program.parse('_ _ -b req'.split(' '))
-      } catch(err) {
-        error = err
-      }
-      isnt(error)
-      is(result)
-      // result.command.is('help')
-    })
-  })
-})

package/test/program/index.js

@@ -1,4 +0,0 @@
-describe('program', () => {
-  require('./complex')
-  require('./middleware')
-})

package/test/program/middleware.js

@@ -1,73 +0,0 @@
-const { is, isnt } = require('amprisand'),
-  { command, option, setDefaults } = require('../../')
-
-let program, output
-
-setDefaults({
-  middlewares: [
-    (options) => output ? output.push({ name: 'default', options }) : null
-  ]
-})
-
-describe('middleware', () => {
-  describe('program = command()', () => {
-    it('should create a program with middleware', () => {
-      program = command('app', '[opt]')
-        .version('0.0.0')
-        .options([
-          option('a', 'array', '[arr...]', 'Option with array variable'),
-          option('r', 'required', '<reqA>', 'Option with required variable'),
-          option('o', 'optional', '[opt]', 'Option with optional variable'),
-          option('b', 'boolean', null, 'Option with no variable')
-        ])
-        .middleware(async (options) => await output.push({ name: 'middleware', options }))
-        .action(async (options) => await output.push({ name: 'action', options }))
-        .commands([
-          command('nested')
-          .options([
-            option('a', 'array', '[arr...]', 'Option with array variable'),
-            option('r', 'required', '<reqA>', 'Option with required variable'),
-            option('o', 'optional', '[opt]', 'Option with optional variable'),
-            option('b', 'boolean', null, 'Option with no variable')
-          ])
-          .middleware(async (options) => await output.push({ name: 'nested middleware', options }))
-          .action(async(options) => await output.push({ name: 'nested action', options }))
-        ])
-    })
-  })
-  describe('program.parse()', () => {
-    it('middleware should be called before action', async () => {
-      output = []
-      await program.parse('_ _'.split(' '))
-      output[0].name.is('default')
-      output[1].name.is('middleware')
-      output[2].name.is('action')
-    })
-  })
-  describe('program.parse()', () => {
-    it('parent middleware should be called first', async () => {
-      output = []
-      await program.parse('_ _ nested'.split(' '))
-      // hits default twice cause every command gets default, nested and top
-      output[0].name.is('default')
-      output[1].name.is('middleware')
-      output[2].name.is('default')
-      output[3].name.is('nested middleware')
-      output[4].name.is('nested action')
-    })
-  })
-  describe('program.parse()', () => {
-    it('should get options and variables', async () => {
-      output = []
-      await program.parse('_ _ test -r required nested -b'.split(' '))
-      // hits default twice cause every command gets default, nested and top
-      output[0].name.is('default')
-      output[1].name.is('middleware')
-      output[2].name.is('default')
-      output[3].name.is('nested middleware')
-      output[4].name.is('nested action')      // output[0].name.is('middleware')
-      // output[1].name.is('nested middleware')
-      // output[2].name.is('nested action')
-    })
-  })
-})