Skip to main content

Crate todolint

Crate todolint 

Source
Expand description

todolint provides predicates for scanning for incomplete tasks.

Structs§

Linter
Linters conducts code quality scans.
Warning
Warning models a TODO finding.

Enums§

TodolintError
TodolintError models bad computer states.

Statics§

CONFIGURATION_FILENAME
CONFIGURATION_FILENAME denotes the file path to an optional TOML configuration file, relative to the current working directory.
DEFAULT_FORMAL_TASK_PATTERN
DEFAULT_FORMAL_TASK_PATTERN matches standardized, crossreferenced code snippets of the form pending: <uri>.
DEFAULT_SKIP_PATHS
DEFAULT_SKIP_PATHS collects common third party file paths.
DEFAULT_TASK_NAMES
DEFAULT_TASK_NAMES collect common task terms.
GENERAL_TASK_PATTERN_REPLACE_TEMPLATE
GENERAL_TASK_PATTERN_REPLACE_TEMPLATE combines task_names and a pipe (|) delimited task name string, to form a patteron for matching incomplete code snippets.
SKIP_PATHS_PATTERN_REPLACE_TEMPLATE
SKIP_PATHS_PATTERN_REPLACE_TEMPLATE combines skip_paths and a pipe (|) delimited file paths string to form a pattern matching skippable file paths.
TEXT_MIMETYPE_PATTERN

Functions§

generate_skip_path_pattern
generate_skip_path_pattern builds a file path matching pattern from a collection of file paths.
generate_task_pattern
generate_task_pattern builds a task pattern from a collection of task names.