pyright-to-gitlab 1.0.2__tar.gz → 1.1.0__tar.gz

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Upcoming]
+## [1.1.0] - 2025-06-03
+### Added
+- Support for -i/--input and -o/--output options to specify input and output files.
 
 ## [1.0.2] - 2025-06-02
 ### Added
@@ -13,5 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Advertise the no-dependency in the README.md.
 
 ## [1.0.1] - 2025-06-02
+- Support for custom path prefix with the `--prefix` option.
+## [1.0.0] - 2025-06-02
 Initial release.
 

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyright-to-gitlab
-Version: 1.0.2
+Version: 1.1.0
 Summary: Convert Pyright JSON output to GitLab CI/CD format
 Project-URL: homepage, https://github.com/schollm/pyright-to-gitlab/
 Project-URL: repository, https://github.com/schollm/pyright-to-gitlab/

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyright-to-gitlab"
-version = "1.0.2"
+version = "1.1.0"
 description = "Convert Pyright JSON output to GitLab CI/CD format"
 readme = "README.md"
 requires-python = ">=3.6"

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/src/pyright_to_gitlab.py

@@ -4,10 +4,11 @@ import argparse
 import hashlib
 import json
 import sys
-from typing import cast
+import textwrap
+from typing import TextIO, cast
 
 
-def _pyright_to_gitlab(prefix: str = "") -> str:
+def _pyright_to_gitlab(input_: TextIO, prefix: str = "") -> str:
     """Convert pyright.json output to GitLab Code Quality report format.
 
     :arg prefix: A string to prepend to each file path in the output.
@@ -17,7 +18,7 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
     Pyright format at https://github.com/microsoft/pyright/blob/main/docs/command-line.md
     Gitlab format at https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
     """
-    data = cast("dict", json.load(sys.stdin))
+    data = cast("dict", json.load(input_))
 
     issues = []
     for issue in data.get("generalDiagnostics", []):
@@ -49,17 +50,42 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
 def main() -> None:
     """Parse arguments and call the conversion function."""
     parser = argparse.ArgumentParser(
-        description="Convert pyright.json to GitLab Code Quality report."
+        description=textwrap.dedent("""
+        Convert pyright.json to GitLab Code Quality report.
+        By default, reads from stdin and writes to stdout."""),
+        epilog=textwrap.dedent(
+            """
+
+        Example usage:
+        > python pyright . --outputjson | pyright-to-gitlab > gitlab_code_quality.json
+        > pyright-to-gitlab -i pyright.json -o gitlab_code_quality.json
+        """
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-i",
+        "--input",
+        type=argparse.FileType("r"),
+        default=sys.stdin,
+        help="Input file (default: stdin)",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=argparse.FileType("w"),
+        default=sys.stdout,
+        help="Output file (default: stdout)",
     )
     parser.add_argument(
         "--prefix",
         type=str,
         default="",
-        help="Prefix to add to each file (default: empty string)",
+        help="Prefix to add to each file entry. This can be used if pyright is run"
+        " from a subdirectory of the repository. (default: empty string)",
     )
     args = parser.parse_args()
-
-    print(_pyright_to_gitlab(prefix=args.prefix))  # noqa: T201
+    args.output.write(_pyright_to_gitlab(input_=args.input, prefix=args.prefix))
 
 
 if __name__ == "__main__":  # pragma: no cover

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/tests/test_main.py

@@ -4,6 +4,10 @@ from __future__ import annotations
 
 import io
 import json
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pathlib import Path
 
 import pytest
 
@@ -93,6 +97,37 @@ def test(
     assert json.loads(captured.out) == gitlab
 
 
+@pytest.mark.parametrize(
+    ("pyright", "gitlab"),
+    [
+        ({}, []),  # Empty input should yield empty output
+        (PYRIGHT, GITLAB),
+    ],
+)
+def test_input_output_file(
+    monkeypatch: pytest.MonkeyPatch,
+    tmp_path: Path,
+    pyright: dict,
+    gitlab: list[dict],
+) -> None:
+    """Test that the pyright.json is converted to GitLab Code Quality report format."""
+    input_file = tmp_path / "pyright.json"
+    input_file.write_text(json.dumps(pyright))
+    output_file = tmp_path / "gitlab.json"
+    monkeypatch.setattr(
+        "sys.argv",
+        [
+            "pyright_to_gitlab.py",
+            "-i",
+            input_file.as_posix(),
+            "-o",
+            output_file.as_posix(),
+        ],
+    )
+    main()
+    assert json.loads(output_file.read_text("utf-8")) == gitlab
+
+
 @pytest.mark.parametrize(
     ("pyright", "gitlab"),
     [

{pyright_to_gitlab-1.0.2 → pyright_to_gitlab-1.1.0}/uv.lock

@@ -601,7 +601,7 @@ wheels = [
 
 [[package]]
 name = "pyright-to-gitlab"
-version = "1.0.2"
+version = "1.1.0"
 source = { editable = "." }
 
 [package.dev-dependencies]