@zppack/zp-plugin-intro

0.1.3 • Public • Published

@zppack/zp-plugin-intro

A plugin for zp to personalize introduction text.

Start

Config introduction text in .zprc or .user.zprc file as following:

[[init.plugins]]
  name = 'ZpIntroPlugin'
  hook = 'after-create'
  pkgName = '@zppack/zp-plugin-intro'
  pkgVersion = 'latest'

  [init.plugins.config]

    # interpolation
    # prefix = '{'
    # suffix = '}'

    [[init.plugins.config.list]]
      text = ' Now you can do following: '
      chalk = ['yellow', 'underline', 'bgBlue']
    [[init.plugins.config.list]]
      text = ' '
    [[init.plugins.config.list]]
      [[init.plugins.config.list.texts]]
        text = '{zp-tab}'
      [[init.plugins.config.list.texts]]
        text = 'cd {name}'
        chalk = ['blueBright']
    [[init.plugins.config.list]]
      text = ' '
    [[init.plugins.config.list]]
      [[init.plugins.config.list.texts]]
        text = '{zp-tab}'
      [[init.plugins.config.list.texts]]
        text = 'npm start'
        chalk = ['blueBright']
      [[init.plugins.config.list.texts]]
        text = '{zp-tab}(open browser at "localhost:3000")'
        chalk = ['gray']
    [[init.plugins.config.list]]
      text = '{zp-newline}'

Variables replacement

As you see above, variable template in text field will be replaced with context options data. In addition to options data, zp-tab, zp-newline, zp-space are added to data, inferring to '\t', '\n', ' '. If the default interpolation (prefix { and suffix }) bothers you, you can change it by setting prefix and suffix of config.

Contributing

How to contribute to this?

Recently changes

See the change log.

License

MIT

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.1.3
    0
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.1.3
    0
  • 0.1.2
    1
  • 0.1.1
    1
  • 0.1.0
    1

Package Sidebar

Install

npm i @zppack/zp-plugin-intro

Weekly Downloads

3

Version

0.1.3

License

MIT

Unpacked Size

7.12 kB

Total Files

5

Last publish

Collaborators

  • johnch