File must have at least min_lines lines (\n-terminated, with an unterminated trailing segment counting as one more — wc -l semantics). Use for “README has more than a title and a TODO”.
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
min_lines | integer (>= 0) | yes | Minimum allowed line count. |
Plus the common paths, level, id, and when fields. This table is generated from the JSON Schema; option types and defaults are authoritative.
Example
Section titled “Example”A stub with too few lines
Section titled “A stub with too few lines”The rule fires on this repository:
fine.mdstub.md# Project
A description.Usage: run me.# ProjectTODOWith this .alint.yml:
version: 1rules: - id: min-3-lines kind: file_min_lines paths: "**/*.md" min_lines: 3 level: infoalint check reports:
--- stub.md -------------------------------------------------------------------- i info min-3-lines file has 2 line(s); at least 3 required
Summary (1 violation): i 1 info 0 passing * 1 failingA file that clears the line floor
Section titled “A file that clears the line floor”This repository is compliant:
README.md# Demo
A description.Install: `cargo install foo`.Run: `foo`.With this .alint.yml:
version: 1rules: - id: min-4-lines kind: file_min_lines paths: "**/*.md" min_lines: 4 level: warningalint check reports:
v All 1 rule(s) passed.