Add Custom Lint Rules

[[custom_rules]] lets you declare project-specific lint rules directly in .zenzic.toml. Each rule applies a regular expression line-by-line to every .md file and produces a finding when the pattern matches. No Python is required — the DSL is pure TOML.

For the full field reference, severity matrix, and output format, see Configuration Reference — [[custom_rules]].

---

Syntax

[[custom_rules]]
id       = "ZZ-NOINTERNAL"
pattern  = "internal\\.corp\\.example\\.com"
message  = "Internal hostname must not appear in public documentation."
severity = "error"

[[custom_rules]]
id       = "ZZ-NODRAFT"
pattern  = "(?i)\\bDRAFT\\b"
message  = "Remove DRAFT marker before publishing."
severity = "warning"

Each [[custom_rules]] header appends one rule to the list. Use double brackets — that is the TOML array-of-tables syntax.

---

TOML placement

Place all [[custom_rules]] blocks before the [build_context] section. [build_context] must be the last section in .zenzic.toml — TOML table headers apply to all subsequent keys, so any top-level field written after [build_context] would silently become a build_context sub-key.

# Correct ordering
docs_dir = "docs"

[[custom_rules]]
id       = "ZZ-NODRAFT"
pattern  = "(?i)\\bDRAFT\\b"
message  = "Remove DRAFT marker before publishing."
severity = "warning"

[build_context]          # ← always last
engine = "mkdocs"

---

Pattern tips

Goal	Pattern
Case-insensitive word boundary	(?i)\\bDRAFT\\b
Literal dot (hostname)	internal\\.corp\\.example\\.com
Match anywhere on line	TODO (no anchors needed — matching is per-line)
Exclude false positives	Use word boundaries \\b to avoid matching TODOS when looking for TODO

All patterns are applied with Python re.search — a match anywhere on the line triggers the finding. Use ^ and $ anchors only when you need to constrain to the start or end of the line.