stouputils.check.cli module#

Command line of stouputils check: which files to read, the rules on any text file, and the report.

BANNED_CHARACTERS: Pattern[str] = re.compile('[\\N{EM DASH}\\N{EN DASH}\\N{HORIZONTAL ELLIPSIS}\\N{MULTIPLICATION SIGN}\\N{RIGHTWARDS ARROW}\\N{LEFT SINGLE QUOTATION MARK}\\N{RIGHT SINGLE QUOTATION MARK}\\N{LEFT DOUBLE QUOTATION MARK}\\N{RIGHT D)[source]#

long dashes, ellipsis, arrows, curly quotes and box-drawing comment banners.

Type:: Typography that marks text as AI-written

check_cli() → None[source]#: CLI entry point for the check command. Usage: stouputils check [path]…

expand_paths( paths: Iterable[Path], ) → Iterator[Path][source]#

Files as given, and every file under a directory that git tracks or does not ignore.

Outside a git repository, a directory expands to every file below it whose path has no hidden part.

check_file( path: Path, config: CheckConfig, ) → list[Violation][source]#

Every violation in a file, sorted by line.

Binary and non UTF-8 files yield nothing.