bumped-terminal/README.md

Executes whatever terminal command inside as bumped plugin.

# bumped-terminal

<h1 align="center">
  <br>
  <img src="http://i.imgur.com/DmMbFwL.png" alt="bumped">
  <br>
  <br>
</h1>

![Last version](https://img.shields.io/github/tag/bumped/bumped-terminal.svg?style=flat-square)
[![Dependency status](http://img.shields.io/david/bumped/bumped-terminal.svg?style=flat-square)](https://david-dm.org/bumped/bumped-terminal)
[![Dev Dependencies Status](http://img.shields.io/david/dev/bumped/bumped-terminal.svg?style=flat-square)](https://david-dm.org/bumped/bumped-terminal#info=devDependencies)
[![NPM Status](http://img.shields.io/npm/dm/bumped-terminal.svg?style=flat-square)](https://www.npmjs.org/package/bumped-terminal)
[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/kikobeats)

> Executes whatever terminal command inside bumped as `prerelease` or `postrelease` action.

Configure your .bumpedrc adding a entry for `bumped-terminal` as the follow example:


```cson
files: [
  'package.json'
]

plugins:

  prerelease:
    'Linting config files':
      plugin: 'bumped-finepack'

  postrelease:

    'Generating CHANGELOG file':
      plugin: 'bumped-changelog'

    'Commiting new version':
      plugin: 'bumped-terminal'
      command: 'git add CHANGELOG.md package.json && git commit -m "Release $newVersion"'
```

which produces the following output:

<p align="center"><img src="example.png" alt="example"></p>

## Install

> You don't need to install it! Bumped automatically resolve the plugins dependencies. However if you still want to do so must be globally accessible:

```bash
$ npm install -g bumped-terminal
```

The plugin provide you a serie of keywords for use in your commands as well:

* **$newVersion**: Alias for `bumped._version` (the current semver version).
* **$oldVersion**: Alias for `bumped._oldVersion` (the before semver version).

Additionally you can provide [child_process.spawn#options](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)

## API

### command

*Required*
Type: `string`

Command to be executed. You can use the follow template words:

- `$newVersion`: The bumped version before the release.
- `$oldVersion`: The bumped version after the release.

### opts

Type: `object`

Additional options to be passed to [execspawn](https://github.com/AndreasMadsen/execspawn#execspawn).

## License

MIT © Bumped