Merge pull request #166 from ghinks/codex/change-cli-arguments-from-underscores-to-dashes

Normalize CLI metric flags to use hyphenated metric names

Author: ghinks

README.md

@@ -111,7 +111,7 @@ review-tally -o expressjs --languages javascript --plot-sprint
 
 ### Plotting with custom chart type and metrics:
 ```shell
-review-tally -o expressjs --languages javascript --plot-sprint --chart-type line --chart-metrics total_reviews,unique_reviewers
+review-tally -o expressjs --languages javascript --plot-sprint --chart-type line --chart-metrics total-reviews,unique-reviewers
 ```
 
 ### Saving the plot to a file:
@@ -179,7 +179,7 @@ review-tally -o expressjs --languages javascript --plot-individual --save-plot r
 * --output-path specifies the output file for sprint analysis
 * --plot-sprint Generate interactive charts showing sprint metrics (opens in browser)
 * --chart-type Chart type for sprint metrics (bar or line). Default: bar
-* --chart-metrics Comma-separated sprint metrics to plot. Default: total_reviews,total_comments. Available: total_reviews,total_comments,unique_reviewers,avg_comments_per_review,reviews_per_reviewer,avg_response_time_hours,avg_completion_time_hours,active_review_days
+* --chart-metrics Comma-separated sprint metrics to plot. Default: total_reviews,total_comments. Available: total-reviews,total-comments,unique-reviewers,avg-comments-per-review,reviews-per-reviewer,avg-response-time-hours,avg-completion-time-hours,active-review-days
 * --save-plot Optional path to save the interactive HTML chart
 * --plot-individual Generate pie charts showing individual reviewer metric distribution (opens in browser)
 * --individual-chart-metric Metric to visualize in individual pie chart. Default: reviews. Available: reviews,comments,engagement_level,thoroughness_score,avg_response_time_hours,avg_completion_time_hours,active_review_days

reviewtally/cli/parse_cmd_line.py

@@ -59,6 +59,16 @@ class CommandLineArgs(TypedDict):
 }
 
 
+def _normalize_metric_identifier(value: str) -> str:
+    """Convert CLI-provided metric identifiers to internal snake_case."""
+    return value.replace("-", "_")
+
+
+def _format_cli_metric_identifier(value: str) -> str:
+    """Expose internal metric identifiers as CLI-friendly names."""
+    return value.replace("_", "-")
+
+
 def print_toml_version() -> None:
     version = importlib.metadata.version("review-tally")
     print(f"Current version is {version}")  # noqa: T201
@@ -253,10 +263,10 @@ def parse_cmd_line() -> CommandLineArgs:  # noqa: C901, PLR0912, PLR0915
         "--chart-metrics",
         help=(
             "Comma-separated sprint metrics to plot. "
-            "Supported: total_reviews,total_comments,unique_reviewers,"
-            "avg_comments_per_review,reviews_per_reviewer,"
-            "avg_response_time_hours,avg_completion_time_hours,"
-            "active_review_days"
+            "Supported: total-reviews,total-comments,unique-reviewers,"
+            "avg-comments-per-review,reviews-per-reviewer,"
+            "avg-response-time-hours,avg-completion-time-hours,"
+            "active-review-days"
         ),
     )
     parser.add_argument(
@@ -274,7 +284,10 @@ def parse_cmd_line() -> CommandLineArgs:  # noqa: C901, PLR0912, PLR0915
     )
     parser.add_argument(
         "--individual-chart-metric",
-        choices=sorted(ALLOWED_INDIVIDUAL_METRICS),
+        choices=sorted(
+            _format_cli_metric_identifier(metric)
+            for metric in ALLOWED_INDIVIDUAL_METRICS
+        ),
         help="Metric to visualize in individual pie chart",
     )
 
@@ -370,6 +383,9 @@ def parse_cmd_line() -> CommandLineArgs:  # noqa: C901, PLR0912, PLR0915
         if chart_metrics_input is not None
         else []
     )
+    chart_metrics = [
+        _normalize_metric_identifier(metric) for metric in chart_metrics
+    ]
     if not chart_metrics:
         chart_metrics = list(DEFAULT_CHART_METRICS)
 
@@ -388,6 +404,10 @@ def parse_cmd_line() -> CommandLineArgs:  # noqa: C901, PLR0912, PLR0915
         if args.individual_chart_metric is not None
         else _get_optional_str(config, "individual-chart-metric")
     )
+    if individual_chart_metric_input is not None:
+        individual_chart_metric_input = _normalize_metric_identifier(
+            individual_chart_metric_input,
+        )
     individual_metric_specified = individual_chart_metric_input is not None
     if (
         individual_chart_metric_input is not None

tests/cli/test_parse_cmd_line.py

@@ -414,6 +414,37 @@ def test_missing_org_or_repositories_exits(
             str(mock_print.call_args[0][0]),
         )
 
+    @patch("sys.exit")
+    @patch("sys.argv")
+    def test_hyphenated_metric_arguments_normalized(
+        self,
+        mock_argv: Any,
+        mock_exit: Any,
+    ) -> None:
+        """Hyphenated metric values from CLI are normalized to snake_case."""
+        mock_argv.__getitem__.side_effect = lambda x: [
+            "review-tally",
+            "--org",
+            "test-org",
+            "--chart-metrics",
+            "total-reviews,avg-response-time-hours",
+            "--individual-chart-metric",
+            "thoroughness-score",
+        ][x]
+        mock_argv.__len__.return_value = 7
+
+        result = parse_cmd_line()
+
+        mock_exit.assert_not_called()
+        self.assertEqual(
+            result["chart_metrics"],
+            ["total_reviews", "avg_response_time_hours"],
+        )
+        self.assertEqual(
+            result["individual_chart_metric"],
+            "thoroughness_score",
+        )
+
 
 class TestParseCmdLineConfiguration(ParseCmdLineTestCase):
     """Tests for TOML configuration support."""