Text-Runner Actions for Makefiles

This package provides Text-Runner actions for verifying documentation mentioning Make targets.

Installation

To use these actions, add this package as a development dependency by running npm i -D textrun-make or yarn i -D textrun-make.

Verify Make commands

The make/command action verifies that the mentioned Make command exists. As an example, consider a codebase that contains this Makefile:

foo:
  echo building foo

In the documentation of this codebase, for example its README.md file, we want to document how to build it. This part could look like this:

Build the foo package by running <code type="make/command">make foo</code>

Text-Runner verifies that the Makefile contains the foo target.

Verify Make targets

The make/target action verifies that the mentioned Make target exists. In our example codebase the README.md file could contain another part:

If it doesn't work, just run the <code type="make/target">foo</code> target
again.

Text-Runner verifies that the Makefile contains the foo target.

Specifying the directory of the Makefile

If the Makefile is not in the root directory of your documentation base, you can specify its directory using the dir attribute. As an example, this README.md file tells Text-Runner to use the Makefile in the parent directory of the documentation base:

Build the foo package by running
<code type="make/command" dir="..">make foo</code>