zce / zce-cli

A CLI tool for my personal productivity, Scaffolding tools move to zce/caz 👉

zce-cli

⚠️ zce-cli is deprecated, see the new tools [caz](https://github.com/zce/caz)

👉 https://github.com/zce/caz

zce-cli's Issues

Prompts config defaults

Plugin validate

wrapper.js

/**
 * Wrapper plugin
 * @param  {Function} plugin Plugin function
 * @return {Function}        Plugin function
 */
const defaultPlugin = (files, app, next) => next()

module.exports = plugin => {
  if (typeof plugin !== 'function') return defaultPlugin

  const fnStr = plugin.toString()
  const matches = /\(\s*([\s\S]*?)\s*\)/.exec(fnStr)

  if (!matches) return defaultPlugin

  const params = matches[1].split(/\s*,\s*/)

  if (params.length !== 3) return defaultPlugin

  // https://github.com/goatslacker/get-parameter-names/blob/master/index.js
  const code = fnStr.replace(/((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg, '')

  const regexp = new RegExp(`${params[2]}\\(\\s*\\)`)
  return regexp.test(code) ? plugin : defaultPlugin
}

Canot find module "ts-node"

本地全局安装zce-cli，执行zce命令创建项目报错，截图如下：

Rename feature BUG in Windows

.\bin\{{name}}.js => .\bin{{name}}.js

Refactor the project

Prompts default

const path = require('path')
const { execSync } = require('child_process')
const validateName = require('validate-npm-package-name')
const semver = require('semver')
const rc = require('rc')
const util = require('./util')

const options = {}

const defaultPrompts = {
  name: { type: 'input', message: 'name' }
}

const defaultValues = {
  get name () {
    return path.basename(options.dest)
  },

  get author () {
    const npmrc = rc('npm', {
      'init-author-name': '',
      'init-author-email': '',
      'init-author-url': ''
    })
    const email = npmrc['init-author-email']
    const url = npmrc['init-author-url']
    return npmrc['init-author-name'] + (email ? ` <${email}>` : '') + (url ? ` (${url})` : '')
  },

  get version () {
    const npmrc = rc('npm', {
      'init-version': '0.1.0'
    })
    return npmrc['init-version']
  },

  get license () {
    const npmrc = rc('npm', {
      'init-license': 'MIT'
    })
    return npmrc['init-license']
  },

  get repository () {
    if (!util.execSync(options.dest)) return
    try {
      return execSync(`cd ${options.dest} && git config --local --get remote.origin.url`).toString().trim()
    } catch (e) {}
  }
}

const defaultValidates = {
  name: input => {
    const result = validateName(input)
    if (result.validForNewPackages) return true
    return `Sorry, ${(result.errors || []).concat(result.warnings || []).join(' and ')}.`
  },

  version: input => {
    const result = semver.valid(input)
    if (result) return true
    return `Sorry, The '${input}' is not a semantic version.`
  }
}

/**
 * Convert all questions
 * @param  {Object}  prompts  Prompts
 * @return {String}  dest     Destination path
 * @return {Array}            All questions
 */
module.exports = (dest, prompts) => {
  // globally dest
  options.dest = dest

  prompts = Object.assign({}, defaultPrompts, prompts)

  return Object.keys(prompts).map(key => {
    const item = Object.assign({ name: key }, prompts[key])

    // default value
    if (typeof item.default === 'string' && item.default.startsWith('$')) {
      item.default = defaultValues[item.default.substr(1)]
    }

    // default validate
    const builtIn = defaultValidates[key]
    if (builtIn) {
      const custom = item.validate
      item.validate = input => {
        const result = builtIn(input)
        if (result !== true) return result
        return typeof custom !== 'function' ? true : custom(input)
      }
    }

    return item
  })
}

Manual cancel prompt

prompt when press ^C at any time.

Integrated Git

Git init when init completed

Ideas

https://github.com/volojs/volo

Gluegun

https://github.com/infinitered/gluegun

Change template engine

Use Nunjucks