Skip to content

Condition

Loader condition

The most common condition type. Loads a value from the file using a Loader and checks it against a Comparator.

Options

  • type: "loader" (optional, this is the default)
  • data: what data loader to use (such as filename or filesize), see Loader

Examples

{
    "data": "filename",
    "glob": "*.jpg; *.png"
}

{
    "type": "loader",
    "data": "created",
    "min": "2017-07-24T15:46:29"
}

Content condition

Matches against the text content of a file. The comparator is applied line by line; the condition passes if any line matches. Files larger than 10 MB or containing binary data are skipped.

Options

  • type: "content"
  • extractor: how to read the file's text

Extractors

  • text: plain text file (.txt, .md, .log, etc.)
  • pdf: PDF document (requires pdftotext)
  • docx: Microsoft Word document (.docx). The legacy Word 97–2003 format(.doc) is not supported.

Examples

{
    "type": "content",
    "extractor": "text",
    "regex": "TODO|FIXME"
}

Process condition

Runs a command and check if it exits with code 0.

Options

  • type: "process"
  • cmd: the binary to call
  • args: the list of arguments to pass to the binary, {var} in either will be replaced by the variables below
  • timeout: maximum time in milliseconds to wait for the process to finish (default: 30000); use null to wait indefinitely

Available variables

  • path: the file absolute path
  • dir: the directory absolute path
  • filename: the full file name (including the extension)
  • basename: the file name without the extension (until the last dot)
  • ext: the file extension (starting from the last dot)
  • /: the native separator of your platform (\ on Windows, / on UNIX)

Examples

{
    "type": "process",
    "cmd": "my-validator",
    "args": ["{path}"]
}