Skip to content

Commit

Permalink
Wrap lines in all guides
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotgoodrich committed Jul 19, 2024
1 parent e4d0e6c commit 19f6057
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions guides/Why Ninjutsu Build.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# Why Choose Ninjutsu Build?

Ninjutsu Build is a collection of packages designed to help create a `.ninja` file. This file outlines all dependencies between inputs and outputs in your projects, along with the necessary shell commands to generate those files.
Ninjutsu Build is a collection of packages designed to help create a `.ninja`
file. This file outlines all dependencies between inputs and outputs in your
projects, along with the necessary shell commands to generate those files.

The [`ninja`](https://ninja-build.org/) executable reads this file. Known for its speed, Ninja is used to build large C++ applications like [Chromium](https://chromium.googlesource.com/chromium/src/+/main/docs/linux/build_instructions.md#setting-up-the-build) and [LLVM](https://www.llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm).
The [`ninja`](https://ninja-build.org/) executable reads this file. Known for
its speed, Ninja is used to build large C++ applications like
[Chromium](https://chromium.googlesource.com/chromium/src/+/main/docs/linux/build_instructions.md#setting-up-the-build)
and
[LLVM](https://www.llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm).

Using Ninjutsu Build, you orchestrate your build process with JavaScript while executing it with `ninja`. This approach combines JavaScript's flexibility with the speed of a native build orchestrator. Modern tools for transpiling TypeScript to JavaScript allow you to separate typechecking and type generation from running tests, providing faster feedback during development.
Using Ninjutsu Build, you orchestrate your build process with JavaScript while
executing it with `ninja`. This approach combines JavaScript's flexibility with
the speed of a native build orchestrator. Modern tools for transpiling
TypeScript to JavaScript allow you to separate typechecking and type generation
from running tests, providing faster feedback during development.

After making changes to files, `ninja` will identifies which output files are outdated and determines the quickest way to update them. For instance, the Ninjutsu `node` plugin tracks all JavaScript files imported during each test run, so after modifying one file, `ninja` will only rerun the subset of tests that imported that file.
After making changes to files, `ninja` will identifies which output files are
outdated and determines the quickest way to update them. For instance, the
Ninjutsu `node` plugin tracks all JavaScript files imported during each test
run, so after modifying one file, `ninja` will only rerun the subset of tests
that imported that file.

Consider using Ninjutsu Build if:

* You are dissatisfied with the large number of `package.json` scripts.
* You have non-standard build steps.
* You already use a JavaScript/TypeScript script to orchestrate your build but seek improved performance or better dependency tracking.
* You want to integrate formatting, linting, transpiling, and/or typechecking into the same build command.
* You already use a JavaScript/TypeScript script to orchestrate your build but
seek improved performance or better dependency tracking.
* You want to integrate formatting, linting, transpiling, and/or typechecking
into the same build command.

0 comments on commit 19f6057

Please sign in to comment.