cli¶

Setup the options for CLI arguments.

class cpp_linter.cli.Args(dict=None, /, **kwargs)[source]¶

A pseudo namespace declaration. Each attribute is initialized with the corresponding CLI arg’s default value.

verbosity : bool = False¶

See --verbosity.

database : str = ''¶

See --database.

style : str = 'llvm'¶

See --style.

tidy_checks : str = 'boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'¶

See --tidy-checks.

version : str = ''¶

See --version.

extensions : List[str] = ['c', 'h', 'C', 'H', 'cpp', 'hpp', 'cc', 'hh', 'c++', 'h++', 'cxx', 'hxx']¶

See --extensions.

repo_root : str = '.'¶

See --repo-root.

ignore : str = '.github'¶

See --ignore.

lines_changed_only : int = 0¶

See --lines-changed-only.

files_changed_only : bool = False¶

See --files-changed-only.

thread_comments : str = 'false'¶

See --thread-comments.

step_summary : bool = False¶

See --step-summary.

file_annotations : bool = True¶

See --file-annotations.

extra_arg : List[str] = []¶

See --extra-arg.

no_lgtm : bool = True¶

See --no-lgtm.

files : List[str] = []¶

See files.

tidy_review : bool = False¶

See --tidy-review.

format_review : bool = False¶

See --format-review.

jobs : int | None = 1¶

See --jobs.

ignore_tidy : str = ''¶

See --ignore-tidy.

ignore_format : str = ''¶

See --ignore-format.

passive_reviews : bool = False¶

See --passive-reviews.

command : str | None = None¶

A subcommand if provided

cpp_linter.cli.get_cli_parser() → ArgumentParser[source]¶