nss-run
Version:
nss-run (not so simple run) is a very simplistic build tool.
1 lines • 7.4 kB
Markdown
nss-run [](https://badge.fury.io/js/nss-run)
=======
nss-run (not so simple run) is a very simplistic build tool.
You can find the source code on [github](https://github.com/fkrauthan/nss-run/).
Instead of something like `gulp` or `grunt` where you are
required to execute all your build steps through plugins `nss-run`
just gives you an easy way to call any external tool without
having to find a special plugin first.
> In version >=0.2 the style of this plugin got changed from being sync to async (through Promise) only.
> This change allows way more complex tasks. In most cases it should be very simply to migrate.
> Please take a look at the UPGRADE documentation!
Get started
-----------
Install globally (for a command line script):
npm install nss-run -g
or
yarn global add nss-run
Install in your project (to use nss-run api inside your `nss-runfile.js`):
npm install nss-run --save-dev
or
yarn add nss-run --dev
If you want to use Babel (7.x)
npm install babel-core babel-preset-env babel-register --save-dev
or
yarn add /core @babel/preset-env /register --dev
Create a `nss-runfile.js` (if you don't want to use babel) / `nss-runfile.babel.js` (if you want to use babel)
```javascript
import { task, taskGroup, runTask, run } from "nss-run";
task("create:component", function (name) {
console.log("Component with name " + name + " created");
});
task("lint", function () {
return runTask("lint:test")
.then(function () {
return runTask("lint:source");
});
});
taskGroup("lint:test", ["lint:test:unit", "lint:test:integration"]);
task("lint:test:unit", function () {
return run("eslint ./test/unit");
});
// With ES6 Arrow functions you can do this
task("lint:test:integration", () => run("eslint ./test/integration"));
// And with babel (enabling async/await) you can also do this
task("lint:source", async () => {
await run("eslint ./src");
// Do something else here
});
```
Run:
```
nss-run create:component test
nss-run lint
nss-run lint:test
nss-run lint:test:unit
```
Tips:
* `./node_modules/.bin/` is included into PATH when running commands by `nss-run` api method
* Executing `nss-run` command without arguments displays list of all available tasks (+ description if available)
* `nss-run` will automatic require `babel-register` if it can not find a `nss-runfile.js` but
a `nss-runfile.babel.js` before including the runfile.
Why nss-run?
------------
Is there really a need for a new build tool? We already have Grunt, Gulp,
npm scripts, Makefile, runjs and many more.
Gulp and Grunt are very complex and require special plugins to run the tools
that make our nodejs development environment.
Makefiles require you to install a tool outside of the nodejs ecosystem which
makes getting started with a project harder then it needs to be.
npm scripts in my opinion are creating to much clutter within your package.json
Your dependency file should not need to know how to build your project.
runjs is already going into the right direction (and this tool is heavily inspired
by runjs). But some of the design decisions (it is to simple) makes it hard to be
used for bigger projects where you just need a bit more flexibility in terms of
how you wanna organize your tasks. In addition the design to make it all synchronize
can cause a lot conflicts with existing nodejs libraries that might not support
synchronized execution (e.g. some file parsers).
nss-run provides you with an very simple way to execute command line tools, npm
installed tools as well as writing custom Javascript and using any npm library
to create your own simple processing. No need to wait until a plugin makes your
favorite tool available thru your build tool. I tried to combine my favorite part
of gulp (the task definition system) and the simplicity of runjs to create a simpel
(but not so simple ;)) build tool for any project size.
API
---
```javascript
import { task, taskGroup, runTask, run } from "nss-run";
```
**task(name, cb[, options])**
Register a new task with the given name (do not use spaces in your name). If the task is
going to be called the provided callback will be executed. A task might return a `Promise`
to wait for async code to complete. Otherwise the task will be finished as soon as the
callback returns.
Options:
```javascript
{
description: ..., // provide a description for this task for the task list output (String)
hidden: ..., // Hide this task from the task list output (true/false) - default: false
}
```
Examples:
```javascript
task("test", function () {
// my task logic here
});
task("test", function () {
// my task logic here
}, {
description: "My test description"
});
```
**taskGroup(name, tasksToExecute[, options])**
Registers a new task (do not use spaces in your task name) that when called automatic
calls all provided task names in a sequence (`tasksToExecute` has to be a string array). If
you provide within the `tasksToExecute` array a array of strings the tasks in that sub array
are going to be executed in parallel before proceeding with the next sequence item.
The options are the same as the options for `task`.
Options:
```javascript
{
description: ..., // provide a description for this task for the task list output (String)
hidden: ..., // Hide this task from the task list output (true/false) - default: false
}
```
Examples:
```javascript
taskGroup("test", ["task1", "task2", "task3"]);
taskGroup("test", ["task1", "task2", "task3"], {
description: "This task will call first task1, then task2 and last task3"
});
taskGroup("test", [["task1", "task2"], "task3"]);
```
**runTask(name[, arg1[, ...]])**
This will execute a registered task with the given name. All arguments you pass
after the name will be directly passed thru to the tasks function callback. This method
will always return a Promise that you should use to find out if the tasks has finished.
Examples:
```javascript
runTask("lint");
runTask("lint", true, "my-second-argument");
```
**run(cmd[, options])**
Run given command as a child process and log the call in the output. It will always return
a promise.
Options:
```javascript
{
cwd: ..., // current working directory (String)
canFail: ..., // should promise be failed if program execution failed/returned error (true/false) - default: false
stream: ..., // directly log the process output (true/false) - default: true
env: ..., // environment variables to be passed down to the command (object)
autoAnswer: ... // an array of auto answer objects to automatic answer interactive shell questions (array of Auto Answer Object's)
}
```
Auto Answer Object:
```javascript
search: ..., // the text to search for in the commands output (String)
answer: ..., // the answer either a string or a function that either returns the answer string or a Promise (String|Function)
hide: ..., // hide the answer in the terminal output if streaming is enabled (true/false) - default: false
```
Examples:
```javascript
run("rm -rf ./lib");
run("http-server .").then((stdout) => {
log(stdout);
}).catch((error) => {
throw error;
});
run("http-server .", { stream: false }).then((stdout) => {
log(stdout);
}).catch((error) => {
throw error;
});
```