1.0.1 • Published 6 years ago

happytracks v1.0.1

Weekly downloads
6
License
ISC
Repository
github
Last release
6 years ago

Happy Tracks

Make efficient CLI runners without all the bloat and dependency hell.

Basically, this will group the output of multiple processes by name so you can better read it in your terminal. Output can be difficult to read when you have multiple concurrent scripts running and this aims to solve that problem.

Installation

npm i happytracks

Use

There's only one method: track(name, childProcess)

happy.track("compile-js", spawn("./build-js", []));
happy.track("compile-styles", spawn("./build-css", []));

For convenience, you may also run them synchronously.

await happy.track("compile-js", spawn("./build-js", []));
await happy.track("compile-styles", spawn("./build-css", []));

Real life example

const spawn = require("child_process").spawn;
const happy = require("happytracks");

happy.track(
  "server",
  spawn(
    "nodemon",
    [
      "-V",
      "-x",
      "node --harmony --use_strict",
      "--watch",
      `${ROOT_DIR}/src/server/`,
      "--ignore",
      "schema.json",
      "--ignore",
      "public/",
      `${ROOT_DIR}/src/server/bin/www`
    ],
    {
      env: Object.assign({}, {
        NODE_ENV: env,
        DEBUG: "app:*",
        NODE_PATH: `${ROOT_DIR}/src/server`,
        NODE_CONFIG_DIR: `${ROOT_DIR}/src/server/config`,
        PORT: 3000
      }, process.env)
    }
  )
);

happy.track(
  "build-css",
  spawn(
    "nodemon",
    [
      path.join(__dirname, "/build-css"),
      "-x",
      "node --harmony",
      "-e",
      "styl",
      "--watch",
      `${ROOT_DIR}/src/client/stylus/`
    ],
    {
      env: Object.assign({}, process.env, {
        CLIENT_PATH: `${ROOT_DIR}/src/client`,
        SERVER_PATH: `${ROOT_DIR}/src/server`
      })
    }
  )
);

happy.track(
  "build-js",
  spawn(path.join(__dirname, "/build-js"), [], {
    env: Object.assign(
      {},
      {
        CLIENT_PATH: `${ROOT_DIR}/src/client`,
        SERVER_PATH: `${ROOT_DIR}/src/server`
      },
      process.env
    )
  })
);