Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Script Processor

Purpose

Runs a user-configured script or command as a linter on discovered files. This is a generic linter that lets you plug in any script without writing a custom processor.

How It Works

Discovers files matching the configured extensions in the configured scan directory, then runs the configured linter command on each file (or batch of files). A non-zero exit code from the script fails the product.

This processor is disabled by default — you must set enabled = true and provide a command in your rsconstruct.toml.

This processor supports batch mode, allowing multiple files to be checked in a single invocation for better performance.

Source Files

  • Input: configured via src_extensions and src_dirs
  • Output: none (checker)

Configuration

[processor.script]
enabled = true
command = "python"
args = ["scripts/md_lint.py", "-q"]
src_extensions = [".md"]
src_dirs = ["marp"]
KeyTypeDefaultDescription
enabledboolfalseMust be set to true to activate
commandstring(required)The command to run
argsstring[][]Extra arguments passed before file paths
src_extensionsstring[][]File extensions to scan for
src_dirsstring[][""]Directory to scan (empty = project root)
dep_inputsstring[][]Extra files whose changes trigger rebuilds
dep_autostring[][]Auto-detected input files

Batch support

The tool accepts multiple files on the command line. When batching is enabled (default), rsconstruct passes all files in a single invocation for better performance.