prepress

Prepress is a command-line utility for programmatically generating content for fenced code blocks in markdown files. The tool assists in authoring and maintaining code blocks used for examples in documentation. Prepress can generate content for specially marked code blocks by

• incorporating the contents of a file
• capturing the output of a native executable or script
• logging interactive sessions with programs like the node read-eval-print-loop.

The examples in this README.md file were generated using prepress. You can view the prepress input used to generate this page at documentation/README.src.md.

Installation

Prepress is a Node.js program, written in TypeScript. In order to use prepress you must have Node installed on your machine. Prepress has been tested with Node version 13.7.0. Here's how to verify that Node is installed:

$ node --version
v16.0.0

Once you have Node, you can install the prepress package directly from npm:

$ npm install -g prepress

This will make the prepress command available in your shell. You can verify your installation by typing

$ prepress --help

Tutorial Builder

  This utility uses a markdown file as a template for generating documentation  
  by rerunning commands inside of markdown code blocks.                         

Usage

  node prepress.js <input file or dir> [<output file or dir>] [...<options>] 

Options

  -d, --dryrun       Dry run: process files and print to console 
  -r, --recursive    Process recursive directory tree            
  -h, --help         Print help message                          

Running Prepress

Prepress transforms markdown source files into markdown files, by supplying the contents for specially marked code blocks. The source file names must end with the extension, ".src.md". The generated markdown files will have the regular ".md" extension.

The syntax for the prepress command is

$ prepress <input> [<output>] [..<options>]

The first parameter specifics the location of the markdown source. This can be the path to a single file or a directory. In the latter case, prepress will process every source file in the directory. If the -r option is included, prepress will process every source file in directory tree.

The second parameter, which is optional, specifies the output location. It can be the path to a single file or a directory. If the output location is omitted, prepress will use the input directory.

You can use the -d option to do a "dry run" that processes the input and then displays the resulting markdown on the console, instead of writing to the output file. The output will include a line that describes where the output would be written when not doing a "dry run".

Authoring Markdown for Prepress

Each prepress code block is marked with special signature line that appears immediately before the start of the block. The signature has the following form:

[//]: # (<command> <parameters>)
~~~
~~~

In the above example, <command> should be replaced by the file, interactive, script, or spawn command. The <parameters> should be replaced by the command's parameters.

Please note that it is important to include a blank line before the signature line. If you don't include the blank line, the signature will be rendered by the markdown viewer.

Verbatim Blocks

If you want prepress to copy a block verbatim, just omit the signature line.

Files

You can use the file command to incorporate the contents of a file within a code block:

[//]: # (file documentation/airplanes.yaml)
~~~yaml
~~~

Prepress will convert this block into the following markdown:

airplanes:
  - type: Cessna
    model: 172
    engines: 1
  - type: Beechcraft
    model: King Air 260
    engines: 2

Executables

The spawn command runs a native executable. Note that spawn does not start a shell, so it cannot run scripts and batch files. Use the script command for scenarios the require a shell.

Here's an example that uses spawn to run node:

[//]: # (spawn node --version)
~~~
~~~

Prepress will convert this block into the following markdown:

$ node --version
v16.0.0

Scripts

The script command runs scripts and batch files in the shell. Here's an example that uses script to run the npm batch file (or npm.cmd on Windows) :

[//]: # (script npm --version)
~~~
~~~

Prepress will convert this block into the following markdown:

$ npm --version
7.10.0

Interactive Sessions

The iscript and ispawn commands capture the input and output associated with one or more interative sessions with a script or native executable. Here's the source for an interactive block that displays a session with the node read-eval-print-loop:

[//]: # (ispawn one > node -i)
~~~
> a = 'hello from session one!'
> b = 1 + 2
~~~

The above signature includes the following elements:

• interactive - the command name
• one - a unique session identifier, used to spread a single interactive session across multiple blocks. Subsequent blocks with this same identifier will continue the session. Blocks with different identifiers will start new sessions.
• > - the prompt character or string. Prepress needs to know the prompt to parse the source block and interative session output.
• node -i - the native executable (with its command line arguments) that provides the interactive experience.

The code blocks contains commands to be submitted to the interactive session. Each command is preceded by the prompt. Here's the output of the interactive session:

> a = 'hello from session one!'
'hello from session one!'
> b = 1 + 2
3

A few notes about interactive sessions:

• You can include the process invocation command at the top of your initial session block, by placing an invocation directive on the line immediately after the ispawn directive. The invocation directive has the form [//]: # (invocation text), where text is the invocation command line. You can see this in the next example.
• You can include other text, such as placeholder output in your session block. Prepress will strip this text out and replace it with the actual output from the session.
• Some interactive sessions display a welcome message before the first prompt. If you would like to display the welcome message, include at least one line, with any content, before the first prompt. If you would like to suppress the welcome message, just put the first command on the first line of the block.

Let's start a second interactive session, and this time show the invocation line and the welcome message. We indicate it is a new session by supplying a new session id, in this case, "two". Next we include the invocation directive with the command line. Then, inside the block, we include a placeholder line at the top to indicate that we'd like to see the welcome message and any other text that appears before the first prompt.

Placeholder line for welcome message
[//]: # (ispawn two > node -i)
[//]: # (invocation $ node -i)
~~~
> a
> a = 'greetings from session two!'
~~~

We can see that this is a different session because it displays a welcome message and variable a is undefined:

$ node -i

Welcome to Node.js v16.0.0.
Type ".help" for more information.
> a
Uncaught ReferenceError: a is not defined
> a = 'greetings from session two!'
'greetings from session two!'

We can then go back and continue our original session by reusing its session identifier:

[//]: # (ispawn one > node -i)
~~~
> a
> b = 'goodbye!'
~~~

We can see here that a has its value from session one:

> a
'hello from session one!'
> b = 'goodbye!'
'goodbye!'

The above examples used ispawn to spawn an interactive session with node, which is a native executable. To run an interactive script from a shell use the iscript command. Here's an example running npm, which is a script:

[//]: # (iscript three > npm --version)
[//]: # (invocation $ npm --version)
~~~
Version placeholder
~~~

Here's the output:

$ npm --version

7.10.0

Building Prepress from Sources

You may also clone and build prepress from sources. Please be aware that the prepress command is configured on package installation. Since the build process doesn't install the package, the prepress command won't be configured. To run prepress from your build, simply type

$ node build/src/apps/prepress.js

Here are the steps for cloning and building prepress from sources:

$ git clone [email protected]:MikeHopcroft/prepress.git
$ cd prepress
$ npm install
$ npm run compile

You can verify your build by running the following command:

$ node build/src/apps/prepress.js --help

Tutorial Builder

  This utility uses a markdown file as a template for generating documentation  
  by rerunning commands inside of markdown code blocks.                         

Usage

  node prepress.js <input file or dir> [<output file or dir>] [...<options>] 

Options

  -d, --dryrun       Dry run: process files and print to console 
  -r, --recursive    Process recursive directory tree            
  -h, --help         Print help message                          

You can test your build by running the unit test suite:

$ npm run test

> [email protected] pretest
> npm run compile


> [email protected] compile
> tsc


> [email protected] test
> mocha 'build/test/**/*.js'

hello, world


  Apps
    prepress
      √ show usage -h
      √ show usage --help
      with mock filesystem
        errors
          √ no input file
          √ input file not found
          √ input file does not end with .src.md
          √ output file ends with .src.md
          √ input directory to existing output file
        valid
          √ from file to explicit existing file
          √ from file to explicit new file
          √ from file to implicit existing file
          √ from file to implicit new file
          √ from file to explicit directory (new file)
          √ from file to explicit directory (existing file)
          √ from directory to explicit existing directory
          √ from directory to explicit new directory
          √ from directory to explicit new directory recursive
          √ from directory to same directory
          √ from directory to same directory recursive

  Tutorial builder
    √ bad block
    file block
      √ file not found
      √ file
      √ file numbered
      √ file yaml
    script
      - bad script
      √ good script (750ms)
    spawn
      √ bad executable
      √ good executable (51ms)
    verbatim block
      √ verbatim
    iscript block
      √ simple (738ms)
    ispawn block
      √ empty body (62ms)
      √ invocation (66ms)
      √ preserve empty prompt (66ms)
      √ suppress prologue (63ms)
      √ display prologue (64ms)
      √ one session, multiple blocks (63ms)
      √ multiple sessions (127ms)

  Utilities
    parseArgs
      errors
        √ too many parameters
        √ too few parameters
      valid
        √ exact parameter count
        √ rest parameters


  39 passing (2s)
  1 pending


> [email protected] posttest
> npm run lint


> [email protected] lint
> gts lint

version: 16