# @zppack/zp-plugin-intro

> A plugin for zp to personalize introduction text.

Latest version **0.1.3** (published 2021-06-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zppack/zp-plugin-intro
pnpm add @zppack/zp-plugin-intro
yarn add @zppack/zp-plugin-intro
bun add @zppack/zp-plugin-intro
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2021-06-29 |
| First published | 2021-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 3 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | John Chan |
| Maintainers | johnch |

## Links

- npm: https://www.npmjs.com/package/@zppack/zp-plugin-intro
- Repository: https://github.com/zppack/zp-plugin-intro
- Issues: https://github.com/zppack/zp-plugin-intro/#issues
- npm.io page: https://npm.io/package/@zppack/zp-plugin-intro

## Dependencies (3)

- [boxen](https://npm.io/package/boxen.md) ^5.0.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [@zppack/log](https://npm.io/package/@zppack/log.md) ^1.0.2

## Recent versions

- 0.1.3 (latest) — 2021-06-29
- 0.1.2 — 2021-06-28
- 0.1.1 — 2021-06-28
- 0.1.0 — 2021-06-28

## README

# @zppack/zp-plugin-intro

A plugin for zp to personalize introduction text.

## Start

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

```toml
[[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?](CONTRIBUTING.md)

## Recently changes

See the [change log](CHANGELOG.md).

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/@zppack/zp-plugin-intro · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._