cpp_linter/__init__.py (1)

12-12: Make version import resilient when _version.py is missing (editable/dev installs).

Fall back to importlib.metadata when the generated file isn’t present to avoid ImportError during local runs or docs builds.

-from ._version import version
+try:
+    from ._version import version
+except Exception:
+    from importlib.metadata import version as _pkg_version
+    version = _pkg_version("cpp-linter")

docs/conf.py (3)

242-242: Provide a safe default for subcommand badge versions.

Prevents KeyError if a subcommand lacks an entry and eases future additions.

-SUBCOMMAND_VERSIONS = {"version": "1.11.0"}
+SUBCOMMAND_VERSIONS = {"version": "1.11.0"}  # minimal supporting versions
+DEFAULT_SUBCOMMAND_VERSION = release

---

293-299: Replace asserts with safe guards (ruff S101) and handle missing help text.

Avoids runtime aborts during doc build while keeping output stable.

-            assert arg.dest is not None
-            if arg.dest != "command":
-                doc.write(f"\n.. std:option:: {arg.dest.lower()}\n\n")
-                assert arg.help is not None
-                doc.write("\n    ".join(arg.help.splitlines()))
+            if arg.dest is None:
+                continue
+            if arg.dest != "command":
+                doc.write(f"\n.. std:option:: {arg.dest.lower()}\n\n")
+                help_text = arg.help or ""
+                doc.write("\n    ".join(help_text.splitlines()))
             else:
                 sub_commands = arg

---

327-339: Harden Subcommands section and remove assert (ruff S101).

• Drop redundant assert.
• Fallback version if not mapped.
• Tolerate missing descriptions.

-        if sub_commands is not None:
-            assert sub_commands is not None
+        if sub_commands is not None:
             choices = cast(Dict[str, argparse.ArgumentParser], sub_commands.choices)
             doc.write("\n\nSubcommands\n")
             doc.write("-----------\n")
             for sub_cmd in choices:
                 doc.write(f"\n.. std:option:: {sub_cmd}\n")
-                version = SUBCOMMAND_VERSIONS[sub_cmd]
+                version = SUBCOMMAND_VERSIONS.get(sub_cmd, DEFAULT_SUBCOMMAND_VERSION)
                 doc.write(f"\n    :badge-version:`{version}`\n\n    ")
-                sub_cmd_action = choices[sub_cmd]
-                assert sub_cmd_action.description is not None
-                doc.write("\n    ".join(sub_cmd_action.description.splitlines()) + "\n")
+                sub_cmd_action = choices[sub_cmd]
+                desc = getattr(sub_cmd_action, "description", "") or ""
+                doc.write("\n    ".join(desc.splitlines()) + "\n")

tests/list_changes/test_get_file_changes.py (1)

8-8: Prefer public API/constant over importing a private, build-generated module.

Importing cpp_linter._version can break local/editable installs where _version.py isn’t present. Use the public constant already exposed by the package and remove string duplication in headers.

Apply:

-from cpp_linter._version import version
+from cpp_linter.rest_api import USER_AGENT

-                "User-Agent": f"cpp-linter/{version}",
+                "User-Agent": USER_AGENT,

-                        "User-Agent": f"cpp-linter/{version}",
+                        "User-Agent": USER_AGENT,

Also applies to: 118-126, 136-142

cpp_linter/rest_api/__init__.py (1)

16-16: Drop the version‐import fallback and set a default User-Agent on the session

• _version.py is always generated by setuptools-scm (dynamic = ["version"] in pyproject.toml), so remove the try/except around from .._version import version.
• In RestApiClient.__init__, after creating self.session, add:

  self.session.headers.update({"User-Agent": USER_AGENT})

  to apply the default UA globally.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/__init__.py:12-12
Timestamp: 2025-09-04T02:26:17.714Z
Learning: In the cpp-linter project, _version.py is always generated by setuptools_scm during build/install, so ImportError fallbacks for this import are not needed.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/__init__.py:12-12
Timestamp: 2025-09-04T02:26:17.714Z
Learning: In the cpp-linter project, setuptools-scm generates _version.py at install time and distributes it with both editable and binary wheels, making fallback imports unnecessary for the version module.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/rest_api/__init__.py:16-0
Timestamp: 2025-09-04T02:25:26.661Z
Learning: setuptools-scm with version_file configuration generates the _version.py file at install time, including for editable installs (pip install -e .), making direct imports from the generated version file reliable without need for fallback imports.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#143
File: noxfile.py:10-10
Timestamp: 2025-05-31T03:53:32.334Z
Learning: In cpp-linter project, dev dependencies including `nox`, `mypy`, `ruff`, `pre-commit`, `rich`, and `types-requests` are properly configured in pyproject.toml under the `[dependency-groups]` dev section. Running `uv sync` installs all necessary dev requirements.

cpp_linter/cli.py (1)

400-404: Subparser for version — consider minor ergonomics

Explicitly set required=False for stability across Python versions and future-proofing. Optional: wire a handler via set_defaults(func=...) to avoid branching in main().

-    sub_parser = cli_parser.add_subparsers(
-        description="Subcommands for special behavior", dest="command"
-    )
+    sub_parser = cli_parser.add_subparsers(
+        description="Subcommands for special behavior", dest="command", required=False
+    )
-    version_help = "Show the cpp-linter version and exit"
-    sub_parser.add_parser("version", description=version_help, help=version_help)
+    version_help = "Show the cpp-linter version and exit"
+    sub_parser.add_parser("version", description=version_help, help=version_help)
+    # Optional:
+    # sub_parser.choices["version"].set_defaults(func=lambda *_: print(version))

tests/test_cli_args.py (1)

51-59: Ruff S101 in tests — silence or configure

If Bandit’s S101 is enforced on tests, add a targeted ignore or configure per-file ignores.

Option A (inline ignores):

-    assert getattr(args, attr_name) == attr_value
-    assert args.command is None
+    assert getattr(args, attr_name) == attr_value  # noqa: S101 - pytest assert in tests
+    assert args.command is None  # noqa: S101 - pytest assert in tests

Option B (preferred: repo-wide config):

• Add to pyproject.toml:

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["S101"]

cpp_linter/__init__.py (1)

19-23: Early-exit for version — small polish optional

Current approach works. If you adopt handler-based subcommands, this branch can be removed. If kept, consider sys.exit(0) for explicit exit status (behavior is effectively the same today).

-    if args.command == "version":
-        print(version)
-        return
+    if args.command == "version":
+        print(version)
+        return  # or: sys.exit(0)

cpp_linter/rest_api/github_api.py (1)

32-32: Standardized User-Agent is correctly applied.

Importing USER_AGENT and setting it in make_headers() aligns with GitHub’s requirements and your tests.

Since __init__ seeds session.headers via self.make_headers(), you could rely on the session default UA for most calls and only override Accept per request to reduce per-call header construction. Optional.

Also applies to: 206-207

tests/list_changes/test_get_file_changes.py (2)

8-8: Avoid importing the private module; use the public constant instead.

Import USER_AGENT from cpp_linter.rest_api to decouple tests from the generated _version.py file and keep expectations DRY with production.

-from cpp_linter._version import version
+from cpp_linter.rest_api import USER_AGENT

---

122-123: Use USER_AGENT to build request header consistently.

Prevents future drift if the prefix changes and removes direct dependency on version in tests.

-                "User-Agent": f"cpp-linter/{version}",
+                "User-Agent": USER_AGENT,

Also applies to: 140-141

cpp_linter/rest_api/__init__.py (1)

16-16: Make version import resilient in editable/dev installs.

cpp_linter/_version.py may not exist before build; add a fallback to package metadata to avoid import-time failures.

-from .._version import version
+try:
+    # Generated at build/install time
+    from .._version import version
+except Exception:
+    try:
+        from importlib.metadata import version as _pkg_version  # py3.8+
+    except Exception:  # pragma: no cover
+        from importlib_metadata import version as _pkg_version  # backport
+    try:
+        version = _pkg_version("cpp-linter")
+    except Exception:
+        version = "0.0.0+dev"

If your CI already generates _version.py before tests, ignore; otherwise consider adding this for robustness.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/__init__.py:12-12
Timestamp: 2025-09-04T02:26:17.714Z
Learning: In the cpp-linter project, _version.py is always generated by setuptools_scm during build/install, so ImportError fallbacks for this import are not needed.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/__init__.py:12-12
Timestamp: 2025-09-04T02:26:17.714Z
Learning: In the cpp-linter project, setuptools-scm generates _version.py at install time and distributes it with both editable and binary wheels, making fallback imports unnecessary for the version module.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#150
File: cpp_linter/rest_api/__init__.py:16-0
Timestamp: 2025-09-04T02:25:26.661Z
Learning: setuptools-scm with version_file configuration generates the _version.py file at install time, including for editable installs (pip install -e .), making direct imports from the generated version file reliable without need for fallback imports.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#143
File: noxfile.py:10-10
Timestamp: 2025-05-31T03:53:32.334Z
Learning: In cpp-linter project, dev dependencies including `nox`, `mypy`, `ruff`, `pre-commit`, `rich`, and `types-requests` are properly configured in pyproject.toml under the `[dependency-groups]` dev section. Running `uv sync` installs all necessary dev requirements.

docs/conf.py (2)

6-10: Imports look good; optional typing modernization.

Optional: if the supported Python is >=3.9, consider dropping Dict/Optional and using builtin generics/PEP 604 unions to reduce imports.

---

327-338: Tighten subcommand emission: iterate items, avoid double indexing, stable ordering, optional fallback for badge.

• Iterate choices.items() to avoid repeated lookups and simplify the loop.
• Optionally sort for stable, alphabetic output.
• If you want every subcommand to carry a badge, fall back to release; otherwise your current get(...) is fine and avoids implying a wrong minimum.

Apply this diff:

-        if sub_commands is not None:
-            choices = cast(Dict[str, argparse.ArgumentParser], sub_commands.choices)
+        if sub_commands is not None:
+            choices = cast(dict[str, argparse.ArgumentParser], sub_commands.choices)
             doc.write("\n\nSubcommands\n")
             doc.write("-----------\n")
-            for sub_cmd in choices:
-                doc.write(f"\n.. std:option:: {sub_cmd}\n\n    ")
-                version = SUBCOMMAND_VERSIONS.get(sub_cmd)
-                if version is not None:
-                    doc.write(f":badge-version:`{version}`\n\n    ")
-                sub_cmd_action = choices[sub_cmd]
-                assert sub_cmd_action.description is not None
-                doc.write("\n    ".join(sub_cmd_action.description.splitlines()) + "\n")
+            for sub_cmd, sub_cmd_action in sorted(choices.items()):
+                doc.write(f"\n.. std:option:: {sub_cmd}\n\n    ")
+                version = SUBCOMMAND_VERSIONS.get(sub_cmd, release)
+                doc.write(f":badge-version:`{version}`\n\n    ")
+                assert sub_cmd_action.description is not None
+                doc.write("\n    ".join(sub_cmd_action.description.splitlines()) + "\n")

Note: Good call switching to get(...) to avoid a KeyError when a new subcommand is added.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#155
File: docs/conf.py:292-292
Timestamp: 2025-09-04T23:14:04.822Z
Learning: Ruff S* (flake8-bandit) rules are not enabled by default in the cpp-linter project, so assert statements don't trigger S101 warnings. This is intentional because assert isinstance() is common practice for type checking.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#155
File: docs/conf.py:284-299
Timestamp: 2025-09-04T23:06:44.559Z
Learning: In cpp-linter project, the maintainer 2bndy5 prefers using assert statements in documentation generation code (like docs/conf.py) rather than safe guards, as they want the doc generation to fail fast if expected conditions aren't met. This ensures complete CLI documentation is produced.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#124
File: cpp_linter/clang_tools/clang_tidy.py:145-145
Timestamp: 2024-10-05T05:49:09.136Z
Learning: In the `get_suggestions_from_patch` method in `cpp_linter/clang_tools/clang_tidy.py`, it is acceptable to use `assert` statements for type checking when the assertion cannot evaluate as false due to `review_comments` data being passed by reference, and when it's intended exclusively for type checking tools. In such cases, writing unit tests to cover the assertion may be unnecessary.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#143
File: noxfile.py:10-10
Timestamp: 2025-05-31T03:53:32.334Z
Learning: The cpp-linter project does not use pylint for linting because it's too slow. Instead, it uses `mypy` for type checking and `ruff` for linting, both listed as dev dependencies in pyproject.toml.

docs/conf.py (1)

333-335: Always emit a version badge; fall back to current release.

Avoid missing badges when a subcommand lacks an explicit entry.

Apply this diff:

-                version = SUBCOMMAND_VERSIONS.get(sub_cmd)
-                if version is not None:
-                    doc.write(f":badge-version:`{version}`\n\n    ")
+                version = SUBCOMMAND_VERSIONS.get(sub_cmd, release)
+                doc.write(f":badge-version:`{version}`\n\n    ")

docs/conf.py (1)

331-338: Minor: iterate items to avoid double lookup.

Slightly cleaner and avoids repeated dict indexing.

Apply this diff:

-            for sub_cmd in choices:
+            for sub_cmd, sub_cmd_action in choices.items():
                 doc.write(f"\n.. std:option:: {sub_cmd}\n\n    ")
-                version = SUBCOMMAND_VERSIONS.get(sub_cmd)
+                version = SUBCOMMAND_VERSIONS.get(sub_cmd)
                 if version is not None:
                     doc.write(f":badge-version:`{version}`\n\n    ")
-                sub_cmd_action = choices[sub_cmd]
                 assert sub_cmd_action.description is not None
                 doc.write("\n    ".join(sub_cmd_action.description.splitlines()) + "\n")

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#155
File: docs/conf.py:292-292
Timestamp: 2025-09-04T23:14:04.822Z
Learning: Ruff S* (flake8-bandit) rules are not enabled by default in the cpp-linter project, so assert statements don't trigger S101 warnings. This is intentional because assert isinstance() is common practice for type checking.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#155
File: docs/conf.py:284-299
Timestamp: 2025-09-04T23:06:44.559Z
Learning: In cpp-linter project, the maintainer 2bndy5 prefers using assert statements in documentation generation code (like docs/conf.py) rather than safe guards, as they want the doc generation to fail fast if expected conditions aren't met. This ensures complete CLI documentation is produced.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#124
File: cpp_linter/clang_tools/clang_tidy.py:145-145
Timestamp: 2024-10-05T05:49:09.136Z
Learning: In the `get_suggestions_from_patch` method in `cpp_linter/clang_tools/clang_tidy.py`, it is acceptable to use `assert` statements for type checking when the assertion cannot evaluate as false due to `review_comments` data being passed by reference, and when it's intended exclusively for type checking tools. In such cases, writing unit tests to cover the assertion may be unnecessary.

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter#143
File: noxfile.py:10-10
Timestamp: 2025-05-31T03:53:32.334Z
Learning: The cpp-linter project does not use pylint for linting because it's too slow. Instead, it uses `mypy` for type checking and `ruff` for linting, both listed as dev dependencies in pyproject.toml.