Fancy CLI output using Spectre Console

[christianhelle]

This pull request enhances the Refitter codebase with significant updates to improve user experience, readability, and functionality. The changes include adding detailed panels and tables for better formatting, introducing spinners to indicate progress, and replacing plain text outputs with structured, visually appealing summaries. Below is a breakdown of the most important changes:

Enhanced User Feedback and Formatting:

• Branding and Success/Error Panels: Added visually appealing panels for branding, success summaries, error messages, and support information. These panels use borders, headers, and icons to improve readability and user experience. (src/Refitter/GenerateCommand.cs, [1] [2]
• Warnings and Donation Banner: Replaced plain text warnings and donation banners with structured panels and tables, making them more user-friendly and visually engaging. (src/Refitter/GenerateCommand.cs, src/Refitter/GenerateCommand.csL194-R407)

Improved Progress Indicators:

• Spinners for Long Operations: Introduced spinners to indicate progress during code generation and OpenAPI validation, enhancing user experience during potentially time-consuming tasks. (src/Refitter/GenerateCommand.cs, [1] [2]

Detailed Output Summaries:

• File and Validation Statistics: Added tables to display detailed statistics for generated files and OpenAPI validation results, including metrics like file size, line count, and API specification details. (src/Refitter/GenerateCommand.cs, src/Refitter/GenerateCommand.csL305-R540)

Encoding Update:

• UTF-8 Output Encoding: Updated the program to use UTF-8 encoding for console output, ensuring compatibility with special characters and icons used in the new panels and tables. (src/Refitter/Program.cs, src/Refitter/Program.csR19-R20)

Screenshot

Summary by CodeRabbit

• New Features

  • Enhanced console interface with styled panels, tables, and spinners for a more user-friendly experience during code generation and validation.
  • Added detailed output tables showing file names, directories, sizes, and line counts for generated files.
  • Improved error and warning reporting with structured displays and helpful guidance.
  • Displayed validation statistics with icons and descriptions for better clarity.

• Chores

  • Updated console output to support UTF-8 encoding for improved character display.

[coderabbitai]

Walkthrough

The updates enhance the console user interface of the GenerateCommand class, introducing structured panels, tables, spinners, and improved error handling using Spectre.Console. Console output encoding is now explicitly set to UTF-8 in the entry point. Several helper methods are added for formatting, and warnings, errors, and statistics are now displayed in styled formats.

Changes

File(s)	Change Summary
src/Refitter/GenerateCommand.cs	Enhanced console UI with panels, tables, spinners, and structured error/warning/statistics output. Added helper methods for formatting. Improved error handling and user feedback.
src/Refitter/Program.cs	Set console output encoding to UTF-8 at application startup.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GenerateCommand
    participant SpectreConsole
    participant RefitGenerator

    User->>GenerateCommand: ExecuteAsync()
    GenerateCommand->>SpectreConsole: Display header panel
    GenerateCommand->>GenerateCommand: ValidateOpenApiSpec()
    GenerateCommand->>SpectreConsole: Show spinner for validation
    alt Validation fails
        GenerateCommand->>SpectreConsole: Show error panel and details
        GenerateCommand->>User: Return error code
    else Validation succeeds
        GenerateCommand->>SpectreConsole: Show statistics table
        GenerateCommand->>RefitGenerator: Generate code (single or multi-file)
        GenerateCommand->>SpectreConsole: Show spinner during generation
        GenerateCommand->>SpectreConsole: Show output table(s)
        GenerateCommand->>SpectreConsole: Show success panel
        GenerateCommand->>SpectreConsole: Show warnings/support panel if needed
        GenerateCommand->>User: Return success code
    end

Loading

Poem

In the console’s glow, a rabbit hops—
With panels and tables, the output pops!
UTF-8 shines, spinners whirl in delight,
Errors and stats now clear in sight.
With Spectre’s style, the code’s refined—
A carrot for the user, so well-designed!
🥕✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This pull request updates the Refitter codebase to improve the user experience by adding enhanced UI elements using Spectre Console. Key changes include UTF-8 encoding for console output, new branding panels and progress spinners, and detailed tables for file and API validation statistics.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
src/Refitter/Program.cs	Updated to use UTF-8 output encoding for console compatibility.
src/Refitter/GenerateCommand.cs	Added branding panels, spinners, and tables for progress and stats; refactored warnings and donation banners.

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

src/Refitter/GenerateCommand.cs (1)

261-270: Remove artificial delay from multiple files spinner.

Similar to the single file generation, the artificial delay serves no functional purpose.

-        var generatorOutput = await AnsiConsole.Status()
-            .Spinner(Spinner.Known.Dots)
-            .SpinnerStyle(Style.Parse("green bold"))
-            .StartAsync("[yellow]🔧 Generating multiple files...[/]", async _ =>
-            {
-                await Task.Delay(100); // Brief delay to show spinner
-                return generator.GenerateMultipleFiles();
-            });
+        var generatorOutput = await AnsiConsole.Status()
+            .Spinner(Spinner.Known.Dots)
+            .SpinnerStyle(Style.Parse("green bold"))
+            .StartAsync("[yellow]🔧 Generating multiple files...[/]", async _ =>
+            {
+                return generator.GenerateMultipleFiles();
+            });

🧹 Nitpick comments (1)

src/Refitter/GenerateCommand.cs (1)

37-50: Consider terminal compatibility for Unicode box characters.

The hard-coded Unicode box drawing characters may not render correctly on all terminals or console environments, especially older ones or those with limited Unicode support.

Consider using Spectre.Console's built-in panel functionality instead of manually drawing borders:

-            // Header with branding
-            AnsiConsole.WriteLine();
-            AnsiConsole.MarkupLine("[bold cyan]╔══════════════════════════════════════════════════════════════════════════════╗[/]");
-            AnsiConsole.MarkupLine($"[bold cyan]║[/] [bold white]🚀 Refitter v{version,-63}[/] [bold cyan]║[/]");
-            AnsiConsole.MarkupLine($"[bold cyan]║[/] [dim]   OpenAPI to Refit Interface Generator[/]{new string(' ', 37)} [bold cyan]║[/]");
-            AnsiConsole.MarkupLine("[bold cyan]╚══════════════════════════════════════════════════════════════════════════════╝[/]");
-            AnsiConsole.WriteLine();
+            // Header with branding
+            var headerPanel = new Panel(
+                $"[bold white]🚀 Refitter v{version}[/]\n" +
+                "[dim]OpenAPI to Refit Interface Generator[/]"
+            )
+            .BorderColor(Color.Cyan)
+            .RoundedBorder()
+            .HeaderAlignment(Justify.Center);
+            
+            AnsiConsole.Write(headerPanel);
+            AnsiConsole.WriteLine();

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 443913d and 6a21983.

⛔ Files ignored due to path filters (1)

• images/console-output.png is excluded by !**/*.png

📒 Files selected for processing (1)

• src/Refitter/GenerateCommand.cs (7 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: script
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: Analyze (csharp)

🔇 Additional comments (9)

src/Refitter/GenerateCommand.cs (9)

76-89: LGTM! Excellent success summary implementation.

The success panel provides clear feedback with performance metrics and generation mode information. The styling and structure are well-designed.

---

99-150: Well-structured error handling with comprehensive user guidance.

The error handling enhancement provides clear visual feedback and helpful guidance for different error scenarios. The separation of concerns between different error types and the inclusion of support information is excellent.

---

216-233: Excellent table formatting for single file output.

The table implementation provides clear, well-structured information about the generated file with appropriate styling and formatting.

---

242-255: LGTM! Correct file size formatting implementation.

The file size formatting logic correctly handles the conversion from bytes to human-readable format with appropriate precision and units.

---

271-354: Excellent multi-file output table with comprehensive summary.

The table implementation effectively displays detailed information for each generated file and provides a useful summary row with totals. The logic preserves the original file generation behavior while enhancing the presentation.

---

357-401: Great improvement from plain text to structured warnings table.

The conversion of configuration warnings to a structured table format significantly improves readability and user experience. The warning categorization with icons is intuitive.

---

404-417: Well-designed donation/support panel.

The support panel provides clear information about sponsorship and issue reporting with good visual hierarchy and appropriate styling.

---

456-520: Excellent OpenAPI validation enhancement with detailed statistics.

The validation process now provides clear feedback during the operation and comprehensive statistics afterward. The statistics table provides valuable insights into the API specification structure.

---

521-551: Well-implemented helper methods for statistics display.

The icon and description mapping methods provide good separation of concerns and make the statistics table more informative and visually appealing. The pattern matching approach is clean and maintainable.

[coderabbitai]

🛠️ Refactor suggestion

Remove artificial delay from spinner.

The Task.Delay(100) introduces an unnecessary artificial delay that doesn't serve a functional purpose and may degrade user experience.

-        await AnsiConsole.Status()
-            .Spinner(Spinner.Known.Dots)
-            .SpinnerStyle(Style.Parse("green bold"))
-            .StartAsync("[yellow]🔧 Generating code...[/]", async _ =>
-            {
-                await Task.Delay(100); // Brief delay to show spinner
-            });
+        await AnsiConsole.Status()
+            .Spinner(Spinner.Known.Dots)
+            .SpinnerStyle(Style.Parse("green bold"))
+            .StartAsync("[yellow]🔧 Generating code...[/]", async _ =>
+            {
+                // Code generation happens after this status block
+            });

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	// Show progress while generating
	await AnsiConsole.Status()
	.Spinner(Spinner.Known.Dots)
	.SpinnerStyle(Style.Parse("green bold"))
	.StartAsync("[yellow]🔧 Generating code...[/]", async _ =>
	{
	await Task.Delay(100); // Brief delay to show spinner
	});
	// Show progress while generating
	await AnsiConsole.Status()
	.Spinner(Spinner.Known.Dots)
	.SpinnerStyle(Style.Parse("green bold"))
	.StartAsync("[yellow]🔧 Generating code...[/]", async _ =>
	{
	// Code generation happens after this status block
	});

🤖 Prompt for AI Agents

In src/Refitter/GenerateCommand.cs around lines 204 to 211, remove the
Task.Delay(100) call inside the spinner's StartAsync method to eliminate the
artificial delay. Instead, keep the spinner running only for the actual
asynchronous operations needed during code generation without any unnecessary
pauses.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.51%. Comparing base (f43b94c) to head (6a21983).
Report is 14 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #695   +/-   ##
=======================================
  Coverage   98.51%   98.51%           
=======================================
  Files          60       60           
  Lines        2901     2901           
=======================================
  Hits         2858     2858           
  Misses          4        4           
  Partials       39       39           

Flag	Coverage Δ
unittests	98.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.