Generate JSON output

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - run: pip install --user ruff
-    - run: ruff --format=github .
+    - run: ruff --output-format=github .
 
   pyright:
     runs-on: ubuntu-latest

pyproject.toml

@@ -147,12 +147,12 @@ target-version = "py37"
 known-local-folder = ["wily"]
 
 [tool.ruff.mccabe]
-max-complexity = 24
+max-complexity = 26
 
 [tool.ruff.per-file-ignores]
 "test/*" = ["D"]
 
 [tool.ruff.pylint]
-max-args = 10
-max-branches = 35
-max-statements = 100
+max-args = 12
+max-branches = 37
+max-statements = 105

src/wily/__main__.py

@@ -160,7 +160,12 @@ def build(ctx, max_revisions, targets, operators, archiver):
     default=True,
     help=_("Wrap index text to fit in terminal"),
 )
-def index(ctx, message, wrap):
+@click.option(
+    "--json/--table",
+    help=_("Display results as JSON"),
+    default=False,
+)
+def index(ctx, message, wrap, json):
     """Show the history archive in the .wily/ folder."""
     config = ctx.obj["CONFIG"]
 
@@ -169,7 +174,7 @@ def index(ctx, message, wrap):
 
     from wily.commands.index import index
 
-    index(config=config, include_message=message, wrap=wrap)
+    index(config=config, include_message=message, wrap=wrap, as_json=json)
 
 
 @cli.command(
@@ -218,8 +223,13 @@ def index(ctx, message, wrap):
     default=True,
     help=_("Wrap rank text to fit in terminal"),
 )
+@click.option(
+    "--json/--table",
+    help=_("Display results as JSON"),
+    default=False,
+)
 @click.pass_context
-def rank(ctx, path, metric, revision, limit, desc, threshold, wrap):
+def rank(ctx, path, metric, revision, limit, desc, threshold, wrap, json):
     """Rank files, methods and functions in order of any metrics, e.g. complexity."""
     config = ctx.obj["CONFIG"]
 
@@ -240,6 +250,7 @@ def rank(ctx, path, metric, revision, limit, desc, threshold, wrap):
         threshold=threshold,
         descending=desc,
         wrap=wrap,
+        as_json=json,
     )
 
 
@@ -281,9 +292,24 @@ def rank(ctx, path, metric, revision, limit, desc, threshold, wrap):
     default=True,
     help=_("Wrap report text to fit in terminal"),
 )
+@click.option(
+    "--json/--table",
+    help=_("Display results as JSON"),
+    default=False,
+)
 @click.pass_context
 def report(
-    ctx, file, metrics, number, message, format, console_format, output, changes, wrap
+    ctx,
+    file,
+    metrics,
+    number,
+    message,
+    format,
+    console_format,
+    output,
+    changes,
+    wrap,
+    json,
 ):
     """Show metrics for a given file."""
     config = ctx.obj["CONFIG"]
@@ -319,6 +345,7 @@ def report(
         console_format=style,
         changes_only=changes,
         wrap=wrap,
+        as_json=json,
     )
 
 
@@ -350,8 +377,13 @@ def report(
     default=True,
     help=_("Wrap diff text to fit in terminal"),
 )
+@click.option(
+    "--json/--table",
+    help=_("Display results as JSON"),
+    default=False,
+)
 @click.pass_context
-def diff(ctx, files, metrics, all, detail, revision, wrap):
+def diff(ctx, files, metrics, all, detail, revision, wrap, json):
     """Show the differences in metrics for each file."""
     config = ctx.obj["CONFIG"]
 
@@ -376,6 +408,7 @@ def diff(ctx, files, metrics, all, detail, revision, wrap):
         detail=detail,
         revision=revision,
         wrap=wrap,
+        as_json=json,
     )
 
 

src/wily/commands/diff.py

@@ -18,6 +18,7 @@
 from wily.config import DEFAULT_PATH
 from wily.config.types import WilyConfig
 from wily.helper import get_maxcolwidth, get_style
+from wily.helper.output import print_json
 from wily.operators import (
     BAD_COLORS,
     GOOD_COLORS,
@@ -37,17 +38,20 @@ def diff(
     detail: bool = True,
     revision: Optional[str] = None,
     wrap: bool = False,
+    as_json: bool = False,
 ) -> None:
     """
     Show the differences in metrics for each of the files.
 
-    :param config: The wily configuration
+    :param config: The wily configuration.
     :param files: The files to compare.
     :param metrics: The metrics to measure.
     :param changes_only: Only include changes files in output.
-    :param detail: Show details (function-level)
-    :param revision: Compare with specific revision
-    :param wrap: Wrap output
+    :param detail: Show details (function-level).
+    :param revision: Compare with specific revision.
+    :param wrap: Wrap output.
+    :param as_json: Output results as JSON.
+
     """
     config.targets = files
     files = list(files)
@@ -142,11 +146,11 @@ def diff(
             if new != current:
                 has_changes = True
             if metric.metric_type in (int, float) and new != "-" and current != "-":
-                if current > new:  # type: ignore
+                if current > new and not as_json:  # type: ignore
                     metrics_data.append(
                         f"{current:n} -> \u001b[{BAD_COLORS[metric.measure]}m{new:n}\u001b[0m"
                     )
-                elif current < new:  # type: ignore
+                elif current < new and not as_json:  # type: ignore
                     metrics_data.append(
                         f"{current:n} -> \u001b[{GOOD_COLORS[metric.measure]}m{new:n}\u001b[0m"
                     )
@@ -165,15 +169,18 @@ def diff(
     descriptions = [metric.description for _, metric in resolved_metrics]
     headers = ("File", *descriptions)
     if len(results) > 0:
-        maxcolwidth = get_maxcolwidth(headers, wrap)
-        style = get_style()
-        print(
-            # But it still makes more sense to show the newest at the top, so reverse again
-            tabulate.tabulate(
-                headers=headers,
-                tabular_data=results,
-                tablefmt=style,
-                maxcolwidths=maxcolwidth,
-                maxheadercolwidths=maxcolwidth,
+        if as_json:
+            print_json(results, headers)
+        else:
+            maxcolwidth = get_maxcolwidth(headers, wrap)
+            style = get_style()
+            print(
+                # But it still makes more sense to show the newest at the top, so reverse again
+                tabulate.tabulate(
+                    headers=headers,
+                    tabular_data=results,
+                    tablefmt=style,
+                    maxcolwidths=maxcolwidth,
+                    maxheadercolwidths=maxcolwidth,
+                )
             )
-        )

src/wily/commands/index.py

@@ -10,18 +10,23 @@
 from wily import MAX_MESSAGE_WIDTH, format_date, format_revision, logger
 from wily.config.types import WilyConfig
 from wily.helper import get_maxcolwidth, get_style
+from wily.helper.output import print_json
 from wily.state import State
 
 
 def index(
-    config: WilyConfig, include_message: bool = False, wrap: bool = False
+    config: WilyConfig,
+    include_message: bool = False,
+    wrap: bool = False,
+    as_json: bool = False,
 ) -> None:
     """
     Show information about the cache and runtime.
 
-    :param config: The wily configuration
-    :param include_message: Include revision messages
-    :param wrap: Wrap long lines
+    :param config: The wily configuration.
+    :param include_message: Include revision messages.
+    :param wrap: Wrap long lines.
+    :param as_json: Output results as JSON.
     """
     state = State(config=config)
     logger.debug("Running show command")
@@ -58,14 +63,17 @@ def index(
         headers = ("Revision", "Author", "Message", "Date")
     else:
         headers = ("Revision", "Author", "Date")
-    maxcolwidth = get_maxcolwidth(headers, wrap)
-    style = get_style()
-    print(
-        tabulate.tabulate(
-            headers=headers,
-            tabular_data=data,
-            tablefmt=style,
-            maxcolwidths=maxcolwidth,
-            maxheadercolwidths=maxcolwidth,
+    if as_json:
+        print_json(data, headers)
+    else:
+        maxcolwidth = get_maxcolwidth(headers, wrap)
+        style = get_style()
+        print(
+            tabulate.tabulate(
+                headers=headers,
+                tabular_data=data,
+                tablefmt=style,
+                maxcolwidths=maxcolwidth,
+                maxheadercolwidths=maxcolwidth,
+            )
         )
-    )

src/wily/commands/rank.py

@@ -20,6 +20,7 @@
 from wily.archivers import resolve_archiver
 from wily.config import DEFAULT_PATH, WilyConfig
 from wily.helper import get_maxcolwidth, get_style
+from wily.helper.output import print_json
 from wily.operators import resolve_metric_as_tuple
 from wily.state import State
 
@@ -33,6 +34,7 @@ def rank(
     threshold: int,
     descending: bool,
     wrap: bool,
+    as_json: bool = False,
 ) -> None:
     """
     Rank command ordering files, methods or functions using metrics.
@@ -43,8 +45,9 @@ def rank(
     :param revision_index: Version of git repository to revert to.
     :param limit: Limit the number of items in the table.
     :param threshold: For total values beneath the threshold return a non-zero exit code.
-    :param descending: Rank in descending order
-    :param wrap: Wrap output
+    :param descending: Rank in descending order.
+    :param wrap: Wrap output.
+    :param as_json: Output results as JSON.
 
     :return: Sorted table of all files in path, sorted in order of metric.
     """
@@ -131,17 +134,21 @@ def rank(
     data.append(("Total", total))
 
     headers = ("File", resolved_metric.description)
-    maxcolwidth = get_maxcolwidth(headers, wrap)
-    style = get_style()
-    print(
-        tabulate.tabulate(
-            headers=headers,
-            tabular_data=data,
-            tablefmt=style,
-            maxcolwidths=maxcolwidth,
-            maxheadercolwidths=maxcolwidth,
+
+    if as_json:
+        print_json(data, headers)
+    else:
+        maxcolwidth = get_maxcolwidth(headers, wrap)
+        style = get_style()
+        print(
+            tabulate.tabulate(
+                headers=headers,
+                tabular_data=data,
+                tablefmt=style,
+                maxcolwidths=maxcolwidth,
+                maxheadercolwidths=maxcolwidth,
+            )
         )
-    )
 
     if threshold and total < threshold:
         logger.error(

src/wily/commands/report.py

@@ -15,6 +15,7 @@
 from wily.config.types import WilyConfig
 from wily.helper import get_maxcolwidth
 from wily.helper.custom_enums import ReportFormat
+from wily.helper.output import print_json
 from wily.lang import _
 from wily.operators import MetricType, resolve_metric_as_tuple
 from wily.state import State
@@ -35,20 +36,22 @@ def report(
     format: ReportFormat = ReportFormat.CONSOLE,
     changes_only: bool = False,
     wrap: bool = False,
+    as_json: bool = False,
 ) -> None:
     """
     Show metrics for a given file.
 
-    :param config: The configuration
-    :param path: The path to the file
-    :param metrics: List of metrics to report on
-    :param n: Number of items to list
-    :param output: Output path
-    :param include_message: Include revision messages
-    :param format: Output format
-    :param console_format: Grid format style for tabulate
-    :param changes_only: Only report revisions where delta != 0
-    :param wrap: Wrap output
+    :param config: The configuration.
+    :param path: The path to the file.
+    :param metrics: List of metrics to report on.
+    :param n: Number of items to list.
+    :param output: Output path.
+    :param include_message: Include revision messages.
+    :param format: Output format.
+    :param console_format: Grid format style for tabulate.
+    :param changes_only: Only report revisions where delta != 0.
+    :param wrap: Wrap output.
+    :param as_json: Output results as JSON.
     """
     metrics = sorted(metrics)
     logger.debug("Running report command")
@@ -114,6 +117,9 @@ def report(
 
                     if delta == 0:
                         delta_col = delta
+                    elif as_json and not format == ReportFormat.HTML:
+                        # Only strip colors if format isn't HTML, so HTML colors work
+                        delta_col = f"{delta:n}"
                     elif delta < 0:
                         delta_col = (
                             f"\u001b[{meta['decrease_color']}m{delta:n}\u001b[0m"
@@ -201,13 +207,16 @@ def report(
 
         logger.info("wily report was saved to %s", report_path)
     else:
-        maxcolwidth = get_maxcolwidth(headers, wrap)
-        print(
-            tabulate.tabulate(
-                headers=headers,
-                tabular_data=data[::-1],
-                tablefmt=console_format,
-                maxcolwidths=maxcolwidth,
-                maxheadercolwidths=maxcolwidth,
+        if as_json:
+            print_json(data[::-1], headers, path)
+        else:
+            maxcolwidth = get_maxcolwidth(headers, wrap)
+            print(
+                tabulate.tabulate(
+                    headers=headers,
+                    tabular_data=data[::-1],
+                    tablefmt=console_format,
+                    maxcolwidths=maxcolwidth,
+                    maxheadercolwidths=maxcolwidth,
+                )
             )
-        )