@auto-it/exec

Exec Plugin

Tap into hooks and run scripts on the terminal.

Read more about the available hooks.

Installation

This plugin is not included with the auto CLI installed via NPM. To install:

npm i --save-dev @auto-it/exec
# or
yarn add -D @auto-it/exec

Usage

Here is an example of replacing the npm plugins with a light-weight version.

All args to a hook are exposed on the process in environment variables. The format looks like $ARG_0, $ARG_1, and so on. Please look at the docs for writing plugins for more detail on what's available.

{
  "plugins": [
    [
      "exec",
      {
        "version": "npm version $ARG_0",
        "publish": "npm publish && git push --tags",
        "afterRelease": "yarn docs && push-dir --dir=docs --branch=gh-pages"
      }
    ]
    // other plugins
  ]
}

⚠️ If you are tapping into a waterfall or bail hook you will need to return some value (ex: JSON or a boolean). Please refer to the documentation and return the right thing!