@zppack/zp-vars

A middleware for zp to support interactive Q&A and do replacement to template files.

Also provide a cli tool for test or development.

Start

Config

• middleware name: @zppack/zp-vars

• config file: .zp/.zp-vars.toml, TOML v1.0.

• config options:

  • zpvars: a list, to configure inquirer questions name or more fields. If only name field, can be shorted as a string.
  • replaceName: boolean, to decide whether to replace file and directory's name or not.
  • interpolation: an object, including prefix and suffix fields, which are to configure the prefix and suffix of interpolation identifier for replacing. Default prefix and suffix are {{{ and }}}.

Config Examples

# TOML v1.0
# Variables will ask to input

zpvars = [
  'name', # same as { name = 'name' }, or { name = 'name', message = 'Input name: ' },
  'description',
  'author',
  { name = 'remote', message = 'Git remote url: ' },
  'homepage',
  { name = 'license', default = 'MIT' },
]

# replaceName = false # do not replace file or directory name by default
# interpolation = { prefix = '{{{', suffix = '}}}' } # change default interpolation identifiers

# TOML v1.0

replaceName = true

[[interpolation]]
prefix = '<{%'
suffix = '%}>'

[[zpvars]]
name = 'name'

[[zpvars]]
name = 'remote'
message = 'Git remote url: '

[[zpvars]]
name = 'license'
default = 'MIT'

CLI

npx @zppack/zp-vars [path]

Contributing

How to contribute to this?

Recently changes

See the change log.

License

MIT