Plain text on Katalyst Documentation

Denylist

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: text_denylist

Purpose#

Forbid any of a list of literal substrings in the body text.

Configuration keys#

Field	Required	Default	Meaning
`values`	yes	-	Literal substrings to forbid; regex metacharacters are inert.
`target`	no	`body`	Span selector: body, line, first-line, or matched-lines.
`select`	no	-	Line-filter regex; required for and only valid with target matched-lines.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: text_denylist
 values: [TODO, FIXME, XXX]

Forbids

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: text_forbids

Purpose#

Forbid a regular expression from appearing in the body text.

Configuration keys#

Field	Required	Default	Meaning
`pattern`	yes	-	Go regular expression, matched unanchored.
`target`	no	`body`	Span selector: body, line, first-line, or matched-lines.
`select`	no	-	Line-filter regex; required for and only valid with target matched-lines.
`fix`	no	-	Optional replacement template (regexp capture syntax) applied to the matched text by the fix command.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: text_forbids
 target: line
 pattern: '\bTODO\b'

Worked example#

The text_forbids check forbids a trailing period on the first line; its fix template strips it. Only the matched text changes; the later keep this. line is untouched.

Requires

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: text_requires

Purpose#

Require a regular expression to appear in the body text.

Configuration keys#

Field	Required	Default	Meaning
`pattern`	yes	-	Go regular expression, matched unanchored (appears somewhere in the span).
`target`	no	`body`	Span selector: body, line, first-line, or matched-lines.
`select`	no	-	Line-filter regex; required for and only valid with target matched-lines.
`match`	no	`any`	For multi-span targets: any (at least one span matches) or all (every span matches).

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: text_requires
 pattern: Sources