resolve #34 (#35)

* replace pylint with ruff and fix docs/tests

* allow LGTM comment when no files checked or failed

* do not exit early if no files are checked

allows LGTM comment in such a case
fix unit test and comments.json debug output file

* ensure CACHE_PATH exists before doing anything

* tally format advice if file-annotations is false

applied in make_annotations()

* annotate tidy advice if file-annotations is on

found a bug where file-annotations=false & tidy advice was still posted

* modify log output to reflect count not annotations

* fix filename matching for tidy annotations

also adjust unit test to use a src that triggers tidy annotations

Author: 2bndy5

.pre-commit-config.yaml

@@ -17,14 +17,12 @@ repos:
     hooks:
       - id: black
         args: ["--diff"]
-  - repo: https://github.com/pycqa/pylint
-    rev: v3.0.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.0.287
     hooks:
-      - id: pylint
-        name: pylint (action code)
+      - id: ruff
         types: [python]
-        exclude: "^(docs/|tests/|setup.py$)"
-        additional_dependencies: [pyyaml, requests]
   - repo: local
     # this is a "local" hook to run mypy (see https://pre-commit.com/#repository-local-hooks)
     # because the mypy project doesn't seem to be compatible with pre-commit hooks

cpp_linter/__init__.py

@@ -8,9 +8,9 @@
 from requests import Response
 
 if TYPE_CHECKING:  # Used to avoid circular imports
-    from cpp_linter.clang_format_xml import XMLFixit
-    from cpp_linter.clang_tidy_yml import YMLFixit
-    from cpp_linter.clang_tidy import TidyNotification
+    from cpp_linter.clang_format_xml import XMLFixit  # noqa: F401
+    from cpp_linter.clang_tidy_yml import YMLFixit  # noqa: F401
+    from cpp_linter.clang_tidy import TidyNotification  # noqa: F401
 
 FOUND_RICH_LIB = False
 try:
@@ -132,7 +132,7 @@ def range_of_changed_lines(
         ]
         if get_ranges:
             return ranges
-        return [l for r in ranges for l in range(r[0], r[1])]
+        return [line for r in ranges for line in range(r[0], r[1])]
     # we return an empty list (instead of None) here so we can still iterate it
     return []  # type: ignore[return-value]
 

cpp_linter/cli.py

@@ -157,15 +157,30 @@
     See `Authenticating with the GITHUB_TOKEN
     <https://docs.github.com/en/actions/reference/authentication-in-a-workflow>`_
 
+Defaults to ``%(default)s``.""",
+)
+cli_arg_parser.add_argument(
+    "-g",
+    "--no-lgtm",
+    default="true",
+    type=lambda input: input.lower() == "true",
+    help="""Set this option to true or false to enable or disable the use of a
+thread comment that basically says 'Looks Good To Me' (when all checks pass).
+
+.. seealso::
+    The :std:option:`--thread-comments` option also notes further implications.
+
 Defaults to ``%(default)s``.""",
 )
 cli_arg_parser.add_argument(
     "-t",
     "--thread-comments",
     default="false",
-    type=lambda input: input.lower() == "true",
-    help="""Set this option to true or false to enable or disable the use of
-thread comments as feedback.
+    choices=['true', 'false', 'update'],
+    help="""Set this option to 'true' or 'false' to enable or disable the use of
+thread comments as feedback. Set this to 'update' to update an existing comment
+if one exists; the value 'true' will always delete an old comment and post a new one
+if necessary.
 
 .. note::
     To use thread comments, the ``GITHUB_TOKEN`` (provided by