tool chain for node-cli

Install

npm install ciny

Usage

const shellkit = createShellKit({
  mixins: [CommandMixin, PromptMixin, TemplateMixin, PackageMixin],
})

shellkit.addCommand({
  name: 'init',
  description: 'init the project',
  callback: () => {
    shellkit.prompt({
      name: 'name',
      message: 'What is the project name?',
    })
  },
})

await shellkit.parse()
shellkit.copyFromTemplate().toDest()

Api

createShellKit

• description: create a shellkit instance
• params:
  • config: ShellKitConfig
• return: ShellkitContext

Mixin

mixin methods to the shellkit instance

commandMixin

• description: mixin command methods to the shellkit instance
• config:
  • locale: string
  • usage: string
• methods:
  • addCommand: add a command to the shellkit instance
  • addOption: add a option to the command
  • parse: parse the command and options

promptMixin

• description: mixin prompt methods to the shellkit instance
• methods:
  • prompt: prompt the user for input

templateMixin

• description: mixin template methods to the shellkit instance
• methods:
  • copyFromRoot: copy a file from the root directory
  • copyFromTemplate: copy a file from the template directory
  • copyFromDest: copy a file from the destination directory

packageMixin

• description: mixin package methods to the shellkit instance
• methods:
  • setPkgManager: set the package manager
  • runScript: run a script with the package manager
  • install: install a package with the package manager