Improve Stats Output #16
Description
This issue tracks work for improving the default "stats" output of the cli.
Currently, the default output of the CLI looks like this:
$ gh combine owner/repo
Stats Summary:
Repositories Processed: 1
PRs Combined: 2
PRs Skipped (Merge Conflicts): 0
PRs Skipped (Criteria Not Met): 1
Execution Time: 5s
Links to Combined PRs:
- https://github.com/owner/repo/pull/123
Per-Repository Details:
owner/repo
Combined: 2
Skipped (Merge Conflicts): 0
Skipped (Criteria): 1
Combined PR: https://github.com/owner/repo/pull/123This is fine but it is not visually appealing. This issue tracks work to do the following tasks:
- Implements a new
--output=<type>flag - The output flag will default to
--output=tableif it isn't provided.- The
--output=tableformat should be fairly inspired by golang's tparse tabled output (example below)
- The
- The table output will use ascii formatting to display a clean, and human readable section of table summaries of what the CLI did during its run
- The current output will be moved to the
--output=plainto represent a plain text (non-table) format - A new
--output=jsontype will also be added that returns a JSON result to the terminal which can be piped into another cli tools likejqfor further parsing - The
--no-colorand--no-statsflags still work as expected
tparse table example format:
╭────────┬─────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬────────────────────────────╮
│ Status │ Elapsed │ Test │ Package │
├────────┼─────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────────────────────┤
│ PASS │ 0.00 │ TestCreatePullRequest │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestValidateLabels │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestApplyDefaultOwner │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestApplyDefaultOwner/empty_default_owner │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestApplyDefaultOwner/repo_already_has_owner │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestApplyDefaultOwner/repo_needs_default_owner │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/empty_inputs │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/single_repository_arg │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/multiple_repository_args │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/comma-separated_repository_args │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/with_default_owner │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/with_valid_file │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/with_invalid_file │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/with_both_args_and_file │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositories/with_whitespace_in_comma-separated_repos │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositoriesFileFormat │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestParseRepositoriesWithEmptyEntries │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestValidateLabels/#00 │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestValidateLabels/#01 │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestValidateLabels/#02 │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestValidateLabels/#03 │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_matches_all_criteria │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks/Branch_and_labels_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks/Branch_does_not_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/#00 │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/--ignore-labels_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_is_the_combine_branch │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_ends_with_the_combine_branch │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/No_filters_specified │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/No_filters_specified_and_partial_match_on_combine_branch_name │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Prefix_does_not_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/--ignore-labels_match_(with_one_out_of_two) │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Suffix_does_not_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Regex_does_not_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/no_labels_match_(select_or_ignore) │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Invalid_regex_pattern │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks/Labels_do_not_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/--select-labels_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks/Neither_branch_nor_labels_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_matches_prefix_only │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/--select-labels_match_(with_one_out_of_two)_and_ignore_labels_don't_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pull_request_has_no_labels │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_matches_suffix_only │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pull_request_has_no_labels_and_ignore_labels_don't_match_so_it_matches_-_but_select_labels_is_empty_so_it_means_all_labels_or_even_no_labels_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestPrMatchesCriteriaWithMocks/No_branch_or_label_filters_specified │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestBranchMatchesCriteria/Branch_matches_regex_only │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pull_request_has_no_labels_but_we_want_to_match_the_a_label │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/no_label_match_criteria,_so_it_matches │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/with_one_matching_label_and_no_matching_ignore_labels_so_it_matches │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_labels_match_the_select_and_ignore_labels_so_it_doesn't_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_has_one_label_but_no_defined_ignore_or_select_labels_so_it_matches │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_has_one_label_and_it_is_the_select_label_so_it_matches │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_has_labels_and_matching_select_labels_but_it_matches_an_ignore_label_so_it_doesn't_match │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_has_uppercase_labels_and_we_are_using_case_insensitive_labels_so_it_matches │ gh-combine/internal/cmd │
│ PASS │ 0.00 │ TestLabelsMatch/the_pr_has_uppercase_labels_and_we_are_using_case_sensitive_labels_so_it_doesn't_match │ gh-combine/internal/cmd │
│ │ │ │ │
│ PASS │ 0.00 │ TestParseRepo │ gh-combine/internal/github │
│ PASS │ 0.00 │ TestParseRepo/#00 │ gh-combine/internal/github │
│ PASS │ 0.00 │ TestParseRepo/#01 │ gh-combine/internal/github │
│ PASS │ 0.00 │ TestParseRepo/#02 │ gh-combine/internal/github │
│ PASS │ 0.00 │ TestParseRepo/#03 │ gh-combine/internal/github │
│ PASS │ 0.00 │ TestParseRepo/#04 │ gh-combine/internal/github │
│ │ │ │ │
╰────────┴─────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴────────────────────────────╯
╭────────┬──────────┬────────────────────────────┬───────┬──────┬──────┬──────╮
│ Status │ Elapsed │ Package │ Cover │ Pass │ Fail │ Skip │
├────────┼──────────┼────────────────────────────┼───────┼──────┼──────┼──────┤
│ PASS │ (cached) │ gh-combine/internal/cmd │ -- │ 59 │ 0 │ 0 │
│ PASS │ (cached) │ gh-combine/internal/github │ -- │ 6 │ 0 │ 0 │
╰────────┴──────────┴────────────────────────────┴───────┴──────┴──────┴──────╯