addresses #7 (#9)

2bndy5 · web-flow · commit 192b7e449bc4 · 2022-09-07T19:23:07.000-07:00
* addresses #7 * extra-arg accumulates as a list * admonish nuances in docs
diff --git a/cpp_linter/run.py b/cpp_linter/run.py
@@ -124,7 +124,7 @@
   installed (if using a custom install location). All paths specified
   here are converted to absolute.
 
-Default is """
+Default is """,
 )
 assert arg.help is not None
 arg.help += "a blank string." if not arg.default else f"``{arg.default}``."
@@ -237,6 +237,23 @@
 
 Defaults to ``%(default)s``.""",
 )
+cli_arg_parser.add_argument(
+    "-x",
+    "--extra-arg",
+    default=[],
+    action="append",
+    help="""A string of extra arguments passed to clang-tidy for use as
+compiler arguments. This can be specified more than once for each
+additional argument. Recommend using quotes around the value and
+avoid using spaces between name and value (use ``=`` instead):
+
+.. code-block:: shell
+
+    cpp-linter --extra-arg="-std=c++17" --extra-arg="-Wall"
+
+Defaults to ``'%(default)s'``.
+""",
+)
 
 
 def set_exit_code(override: int = None) -> int:
@@ -477,6 +494,7 @@ def run_clang_tidy(
     lines_changed_only: int,
     database: str,
     repo_root: str,
+    extra_args: List[str],
 ) -> None:
     """Run clang-tidy on a certain file.
 
@@ -489,6 +507,23 @@ def run_clang_tidy(
         diff info.
     :param database: The path to the compilation database.
     :param repo_root: The path to the repository root folder.
+    :param extra_args: A list of extra arguments used by clang-tidy as compiler
+        arguments.
+
+        .. note::
+            If the list is only 1 item long and there is a space in the first item,
+            then the list is reformed from splitting the first item by whitespace
+            characters.
+
+            .. code-block:: shell
+
+                cpp-linter -extra-arg="-std=c++14 -Wall"
+
+            is equivalent to
+
+            .. code-block:: shell
+
+                cpp-linter -extra-arg=-std=c++14 --extra-arg=-Wall
     """
     if checks == "-*":  # if all checks are disabled, then clang-tidy is skipped
         # clear the clang-tidy output file and exit function
@@ -511,6 +546,10 @@ def run_clang_tidy(
         line_ranges = dict(name=filename, lines=file_obj["line_filter"][ranges])
         logger.info("line_filter = %s", json.dumps([line_ranges]))
         cmds.append(f"--line-filter={json.dumps([line_ranges])}")
+    if len(extra_args) == 1 and " " in extra_args[0]:
+        extra_args = extra_args[0].split()
+    for extra_arg in extra_args:
+        cmds.append(f"--extra-arg={extra_arg}")
     cmds.append(filename)
     # clear yml file's content before running clang-tidy
     Path("clang_tidy_output.yml").write_bytes(b"")
@@ -623,6 +662,7 @@ def capture_clang_tools_output(
     lines_changed_only: int,
     database: str,
     repo_root: str,
+    extra_args: List[str],
 ):
     """Execute and capture all output from clang-tidy and clang-format. This aggregates
     results in the :attr:`~cpp_linter.Globals.OUTPUT`.
@@ -636,14 +676,23 @@ def capture_clang_tools_output(
         diff info.
     :param database: The path to the compilation database.
     :param repo_root: The path to the repository root folder.
+    :param extra_args: A list of extra arguments used by clang-tidy as compiler
+        arguments.
     """
     # temporary cache of parsed notifications for use in log commands
     tidy_notes: List[TidyNotification] = []
     for file in Globals.FILES:
         filename = cast(str, file["filename"])
         start_log_group(f"Performing checkup on {filename}")
         run_clang_tidy(
-            filename, file, version, checks, lines_changed_only, database, repo_root
+            filename,
+            file,
+            version,
+            checks,
+            lines_changed_only,
+            database,
+            repo_root,
+            extra_args,
         )
         run_clang_format(filename, file, version, style, lines_changed_only)
         end_log_group()
@@ -962,6 +1011,7 @@ def main():
         args.lines_changed_only,
         args.database,
         args.repo_root,
+        args.extra_arg,
     )
 
     start_log_group("Posting comment(s)")
diff --git a/pyproject.toml b/pyproject.toml
@@ -440,7 +440,23 @@ confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFIN
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-symbolic-message-instead", "invalid-sequence-index", "anomalous-backslash-in-string", "too-few-public-methods", "consider-using-f-string", "subprocess-run-check"]
+disable = [
+    "raw-checker-failed",
+    "bad-inline-option",
+    "locally-disabled",
+    "file-ignored",
+    "suppressed-message",
+    "useless-suppression",
+    "deprecated-pragma",
+    "use-symbolic-message-instead",
+    "invalid-sequence-index",
+    "anomalous-backslash-in-string",
+    "too-few-public-methods",
+    "consider-using-f-string",
+    "subprocess-run-check",
+    "missing-timeout",
+    "too-many-lines"
+]
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
diff --git a/tests/capture_tools_output/test_database_path.py b/tests/capture_tools_output/test_database_path.py
@@ -48,6 +48,7 @@ def test_db_detection(
         lines_changed_only=0,  # analyze complete file
         database=database,
         repo_root=rel_root,
+        extra_args=[],
     )
     matched_args = []
     for record in caplog.records:
diff --git a/tests/capture_tools_output/test_tools_output.py b/tests/capture_tools_output/test_tools_output.py
@@ -113,6 +113,7 @@ def test_format_annotations(
         lines_changed_only=lines_changed_only,
         database="",
         repo_root="",
+        extra_args=[],
     )
     assert "Output from `clang-tidy`" not in cpp_linter.Globals.OUTPUT
     caplog.set_level(logging.INFO, logger=log_commander.name)
@@ -162,6 +163,7 @@ def test_tidy_annotations(
         lines_changed_only=lines_changed_only,
         database="",
         repo_root="",
+        extra_args=[],
     )
     assert "Run `clang-format` on the following files" not in cpp_linter.Globals.OUTPUT
     caplog.set_level(logging.INFO, logger=log_commander.name)
@@ -195,6 +197,7 @@ def test_diff_comment(lines_changed_only: int):
         lines_changed_only=lines_changed_only,
         database="",
         repo_root="",
+        extra_args=[],
     )
     diff_comments = list_diff_comments(lines_changed_only)
     # output = Path(__file__).parent / "diff_comments.json"
diff --git a/tests/test_cli_args.py b/tests/test_cli_args.py
@@ -36,6 +36,7 @@ class Args:
     files_changed_only: bool = False
     thread_comments: bool = False
     file_annotations: bool = True
+    extra_arg: List[str] = []
 
 
 def test_defaults():
@@ -62,6 +63,8 @@ def test_defaults():
         ("files-changed-only", "True", "files_changed_only", True),
         ("thread-comments", "True", "thread_comments", True),
         ("file-annotations", "False", "file_annotations", False),
+        ("extra-arg", "-std=c++17", "extra_arg", ["-std=c++17"]),
+        ("extra-arg", '"-std=c++17 -Wall"', "extra_arg", ['"-std=c++17 -Wall"']),
     ],
 )
 def test_arg_parser(

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ def test_db_detection(`
`48`	`48`	`lines_changed_only=0, # analyze complete file`
`49`	`49`	`database=database,`
`50`	`50`	`repo_root=rel_root,`
	`51`	`+ extra_args=[],`
`51`	`52`	`)`
`52`	`53`	`matched_args = []`
`53`	`54`	`for record in caplog.records:`