Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 3.19 KB

installation.md

File metadata and controls

128 lines (93 loc) · 3.19 KB
Raw

Installation

TextRunner works on all platforms supported by Node.JS, including macOS, Windows, and Linux. To get started:

  • install Node.JS version 16 or newer

  • in the terminal, cd into the folder in which you want to use TextRunner

  • make sure you have a file package.json with at least these entries:

    {
  "type": "module",
  "devDependencies": {
    "text-runner": "6.0.0",
    "ts-node": "10.9.1"
  }
}

  • install TextRunner:

    npm install -D text-runner ts-node

  • make sure it works by running:

    text-run help

This gives you an out-of-the-box installation of TextRunner, which checks that all links and images point to something.

Configuration

You can configure TextRunner via command-line options or a configuration file.

Creating a configuration file

To scaffold a config file, open a terminal, go to the folder where you want to configure TextRunner, and run:

$ text-run setup

This creates a configuration file called text-run.yml that looks like this:

# white-list for files to test
# This is a glob expression, see https://github.com/isaacs/node-glob#glob-primer
# The folder "node_modules" is already excluded.
# To exclude the "vendor" folder: '{,!(vendor)/**/}*.md'
files: "**/*.md"

# black-list of files not to test
# applied after the white-list above.
exclude: []

# the formatter to use (detailed, dot, progress, summary)
format: detailed

# regex patterns for link targets to ignore
ignoreLinkTargets: []

# Define which folders of your Markdown source get compiled to HTML
# and published under a different URL path.
#
# In this example, the public URL "/blog/foo"
# would be hosted as "post/foo.md":
# publications:
#   - localPath: /posts/
#     publicPath: /blog
#     publicExtension: ''

# Name of the default filename in folders.
# If you set this, and a link points to a folder,
# Text-Runner assumes the link points to the default file in that folder.
# defaultFile: index.md

# prefix that makes anchor tags active regions
regionMarker: type

# whether to display/emit skipped activities
showSkipped: false

# whether to run the tests in an external temp directory,
# uses ./tmp if false,
# you can also provide a custom directory path here
systemTmp: false

# whether to verify online files/links (warning: this makes tests flaky)
online: false

# whether to delete all files in the workspace folder before running the tests
emptyWorkspace: true

Using a custom configuration file

By default Text-Runner uses a file text-run.yml as the configuration file. You can tell it to use another configuration file with the --config command-line switch:

$ text-run --config=my-config.yml

Read more about:

Read more about: