User Guide
Code Documentation
Constants
CppConfig
GitConfig
init_config()
add_license_header()
build_cpp_rules()
filter_buggy_cpp()
run_cpp_checks()
LogLevel
StrEnum
FileType
determine_file_type()
file_exist()
filter_cpp_files()
get_dirs_in_dir()
get_files_in_dirs()
get_staged_files()
open_file()
write_text()
GitTagError
get_latest_tag()
ResultType
ResultTypeEnum
FileRuleInput
Rule
RuleInputType
RuleType
filter_cpp_rules()
filter_file_rules()
filter_line_rules()
is_file_rule()
is_line_rule()
check_key_sequence_ordered()
mstd_print()
Module defining C++ check rules.
Functions
cpp_checks([license_header, dirs])
cpp_checks
Run C++ code quality checks.
license_header (str | None) – The path to the license header file. If None, uses the global configuration.
dirs (list[str] | None) – List of directories to check. If None, uses all directories in the current directory.
None