A TypeScript library for creating ninja files (https://ninja-build.org/).
Some of the selling points of ninjutsu-build are:
- TypeScript
- Type-safe design - easy to create build rules that require certain variables, or can have optionally specified variables
- Simple and quick - all methods calls write directly to a
stringproperty - Ninja rules return the value of the
outargument, which makes it easier to use linting tools to find unused build artifatcts - Zero dependencies
This project requires NodeJS (version 18 or later) and npm.
Most likely you require @ninjutsu-build/core as a devDependency, which can be
achieved by running the following npm command:
$ npm install @ninjutsu-build/core --save-devimport { NinjaBuilder, needs } from "@ninjutsu-build/core";
import { writeFileSync } from "fs";
// Create a `NinjaBuilder`
const ninja = new NinjaBuilder({
ninja_required_version: "1.1",
builddir: ".mybuilddir",
});
// Create the `touch` rule
const touch = ninja.rule("touch", {
command: "touch $out",
description: "Creating $out",
out: needs<string>(),
});
// Create a build edge using `touch` and store the value
// of the `out` property
const example = touch({
out: "$builddir/example.stamp",
});
// Create the `copy` rule
const copy = ninja.rule("cp", {
command: "cp $in $out",
description: "Copying $in to $out",
out: needs<string>(),
in: needs<string>(),
});
// Copy the file created previously
copy({
in: example,
out: "$builddir/example.copy.stamp",
});
// Write the ninja file to disk
writeFileSync("build.ninja", ninja.output);