Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 4.24 KB

README.md

File metadata and controls

115 lines (79 loc) · 4.24 KB
Raw

Grunion

Run multiple commands using glob patterns.

version status dependencies devDependencies node

Why Grunion?

  • Sometimes you want to run multiple scripts in separate processes.
  • node, babel-node only run one file at a time.
  • tape and blue-tap run globs of files in a single process.
  • AVA is not a generic runner.

Features

  • Runs one shell command per file, based on a extended glob (see globby).
  • Defaults to running node concurrently.
  • Use complex commands using template strings.
  • Doesn't require bash scripts.
  • Prefers locally installed binaries by default (see execa).
  • Promise API interface.

Tested on mac, windows cmd, and cygwin

Install

npm install -g grunion

CLI Usage

Usage
  grunion [<file|directory|glob> ...]

Options,

  --run, -r          Command template to run (default: "node <%= file.path %>")
  --fail-fast        Stop after first failure (default: false)
  --serial, -s       Run serially (same as -m 1, default: false)
  --max, -m          Maximum number of commands running at the same time (default: 10)
  --dry-run          Don't actually run each command (use with DEBUG=grunion, default: false)
  --local            Prefer locally installed binaries (default: true)
  --silent           Don't write output (default: false)
  --headings         Write the file names and commands (default: true)
  --summary          Write the summary (default: true)
  --raw, -w          Only write stdout and stderr (same as --no-headings --no-summary --silent)
  --delay            Delay N ms between runs (default: 0)

Examples:

grunion a.js b.js

Runs node on a.js and b.js, each in a separate node process.

grunion *.js # same as grunion *.js -m 10

Runs node on each file matching *.js, up to 10 at a time.

grunion *.js --serial # same as grunion *.js -m 1

Runs node on each file matching *.js sequentially.

grunion --run "babel-node <%= file.path %>" *.js -m 3

Runs babel-node on each file matching *.js, up to 3 at a time.

grunion --run "browserify <%= file.path > --im ./out/<%= file.basename >" ./src/*.js

Runs browserify on each file matching /src/*.js with output to /out/*.js.

API

TBR

Recipes

Coming soon...

Things that go well with Grunion

License

MIT License

Copyright (c) 2016 Jayson Harshbarger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.