Fix match path on cmd prompt

[christianhelle]

This resolves #713 by showing a warning message to the user if the --match-path argument specified filters out all API endpoints

Screenshot

CoPilot Generated Summary

This pull request introduces enhancements to the Refitter project, focusing on improving code clarity, error handling, and test automation. The most significant changes include adding a property to expose OpenAPI specifications, improving error messaging for filtered API paths, and creating a comprehensive smoke test script for automated testing.

Enhancements to code clarity and functionality:

• src/Refitter.Core/RefitGenerator.cs: Added the OpenApiDocument property to expose the OpenAPI specifications used for generating Refit clients and interfaces. This improves code readability and provides direct access to the document.

Improved error handling:

• src/Refitter/GenerateCommand.cs: Added detailed warnings when all API paths are filtered out by --match-path patterns. The warnings include potential causes (e.g., regex syntax errors, command line interpretation issues) and solutions (e.g., using PowerShell or .refitter settings files).

Test automation:

• test/smoke-tests.bat: Introduced a comprehensive smoke test script to automate testing across multiple configurations. The script supports parallel execution, production mode, and dynamic generation of test cases based on OpenAPI files, URLs, and settings. It includes error handling for native failures and builds generated projects for validation.

Summary by CodeRabbit

• New Features

  • Added a warning message when all API paths are filtered out by path-matching patterns, including troubleshooting tips for common command line issues.
  • Introduced a batch script to automate smoke testing across various OpenAPI scenarios and configurations.

• Chores

  • Exposed the OpenAPI document used by the generator as a public read-only property for improved accessibility.

[coderabbitai]

Walkthrough

A new public property was added to expose the OpenAPI document in the generator class. The command-line tool now warns users if all API paths are filtered out by path-matching patterns, with guidance on common pitfalls and solutions. A comprehensive batch script for smoke testing various code generation scenarios was introduced.

Changes

File(s)	Change Summary
src/Refitter.Core/RefitGenerator.cs	Added public read-only property OpenApiDocument to expose the internal OpenAPI document.
src/Refitter/GenerateCommand.cs	Added warning and guidance if all API paths are filtered out by --match-path; clarified feature logging.
test/smoke-tests.bat	Introduced a new batch script to automate smoke tests for code generation, building, and validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GenerateCommand
    participant RefitGenerator

    User->>GenerateCommand: Execute with --match-path
    GenerateCommand->>RefitGenerator: Generate code with filters
    RefitGenerator-->>GenerateCommand: Return OpenApiDocument (possibly with 0 paths)
    GenerateCommand->>GenerateCommand: Check if all paths filtered out
    alt All paths filtered
        GenerateCommand->>User: Output warning and troubleshooting suggestions
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Warn user if all API paths are filtered out by --match-path (#713)	✅
Provide guidance and troubleshooting for match-path issues (#713)	✅
No unrelated changes to match-path logic or OpenAPI parsing (#713)	✅

Poem

A bunny with scripts and warnings to share,
Ensures your paths are filtered with care.
If CMD escapes make your matches go poof,
The console now tells you the honest truth.
With smoke tests hopping and OpenAPI in view,
Refitter’s more helpful—thanks to this crew!
🐇✨

✨ 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 resolves issue #713 by adding user warnings when --match-path excludes all API endpoints, exposes the OpenAPI document for external access, and introduces a new batch-based smoke test script.

• Expose the OpenAPI specification via a new OpenApiDocument property on the generator.
• Add detailed console warnings in GenerateCommand when all paths are filtered out.
• Add test/smoke-tests.bat to automate generation and build verification across formats and variants.

Reviewed Changes

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

File	Description
src/Refitter.Core/RefitGenerator.cs	Added OpenApiDocument property to expose the loaded specification
src/Refitter/GenerateCommand.cs	Inserted warning messages when no API paths match --match-path
test/smoke-tests.bat	Introduced comprehensive smoke test batch script

Comments suppressed due to low confidence (2)

src/Refitter.Core/RefitGenerator.cs:12

• [nitpick] Property summaries should follow the "Gets" pattern. For example: "Gets the OpenAPI document used to generate Refit clients and interfaces."

    /// <summary>

test/smoke-tests.bat:154

• To verify the new warning path, add a smoke test case where --match-path uses a pattern that matches no paths (e.g. ^$). This ensures the warning branch is exercised in CI.

                call :generate_and_build "%%f" "!namespace!.MatchPathFiltered" "MatchPathFiltered!output_path!" "--match-path ^^/pet/.*" "" "" "%build_from_source_param%"

[Copilot]

Consider writing warning messages to the error stream using Console.Error.WriteLine so they’re clearly distinguished from normal output and can be redirected separately.

Suggested change

	Console.WriteLine("⚠️ WARNING: All API paths were filtered out by --match-path patterns. ⚠️");
	Console.WriteLine($" Match Patterns used: {string.Join(", ", refitGeneratorSettings.IncludePathMatches)}");
	Console.WriteLine();
	Console.WriteLine(" This could indicate that:");
	Console.WriteLine(" 1. The regex patterns don't match any available paths");
	Console.WriteLine(" 2. There's a syntax error in the regex patterns");
	Console.WriteLine(" 3. The patterns were corrupted by command line interpretation");
	Console.WriteLine();
	Console.WriteLine(" This commonly happens when using the Windows Command Prompt (CMD) instead of PowerShell.");
	Console.WriteLine(" The ^ character in regex patterns is interpreted as an escape character in CMD.");
	Console.WriteLine();
	Console.WriteLine(" Solutions:");
	Console.WriteLine(" 1. Use PowerShell instead of CMD");
	Console.WriteLine(" 2. In CMD, escape the ^ character or use different quoting");
	Console.WriteLine(" 3. Use a .refitter settings file instead of command line arguments");
	Console.WriteLine();
	Console.Error.WriteLine("⚠️ WARNING: All API paths were filtered out by --match-path patterns. ⚠️");
	Console.Error.WriteLine($" Match Patterns used: {string.Join(", ", refitGeneratorSettings.IncludePathMatches)}");
	Console.Error.WriteLine();
	Console.Error.WriteLine(" This could indicate that:");
	Console.Error.WriteLine(" 1. The regex patterns don't match any available paths");
	Console.Error.WriteLine(" 2. There's a syntax error in the regex patterns");
	Console.Error.WriteLine(" 3. The patterns were corrupted by command line interpretation");
	Console.Error.WriteLine();
	Console.Error.WriteLine(" This commonly happens when using the Windows Command Prompt (CMD) instead of PowerShell.");
	Console.Error.WriteLine(" The ^ character in regex patterns is interpreted as an escape character in CMD.");
	Console.Error.WriteLine();
	Console.Error.WriteLine(" Solutions:");
	Console.Error.WriteLine(" 1. Use PowerShell instead of CMD");
	Console.Error.WriteLine(" 2. In CMD, escape the ^ character or use different quoting");
	Console.Error.WriteLine(" 3. Use a .refitter settings file instead of command line arguments");
	Console.Error.WriteLine();

[Copilot]

The method parameter is captured from %~1 but never used inside :run_tests. Either use this value in the test logic or remove the unused parameter.

Suggested change

	set "method=%~1"
	set "parallel_param=%~2"
	set "build_from_source_param=%~3"
	set "parallel_param=%~1"
	set "build_from_source_param=%~2"

[Copilot]

The parallel_param flag is parsed but not used to control test execution. Consider implementing parallel execution based on this flag or removing it if it’s not needed.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Refitter/GenerateCommand.cs (1)

78-97: Excellent user-friendly warning implementation.

The warning message effectively addresses a common user pain point with detailed explanations and actionable solutions. The check correctly validates both conditions before displaying the warning.

Consider escaping special regex characters when displaying the patterns to users for clarity:

-                Console.WriteLine($"   Match Patterns used: {string.Join(", ", refitGeneratorSettings.IncludePathMatches)}");
+                Console.WriteLine($"   Match Patterns used: [{string.Join("], [", refitGeneratorSettings.IncludePathMatches)}]");

test/smoke-tests.bat (1)

216-216: Add newline at end of file.

The file is missing a newline character at the end, which could cause issues with some version control systems and text processing tools.

 endlocal
+

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26d108e and 92c55b9.

📒 Files selected for processing (3)

• src/Refitter.Core/RefitGenerator.cs (1 hunks)
• src/Refitter/GenerateCommand.cs (1 hunks)
• test/smoke-tests.bat (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

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

🔇 Additional comments (4)

src/Refitter.Core/RefitGenerator.cs (1)

12-16: LGTM! Clean property addition.

The new OpenApiDocument property is well-implemented with proper encapsulation and clear documentation. This provides safe read-only access to the OpenAPI specification for external components.

src/Refitter/GenerateCommand.cs (1)

74-76: Good separation of concerns.

Separating the Analytics call from the file writing logic improves code readability.

test/smoke-tests.bat (2)

1-215: Comprehensive smoke test implementation!

The script provides excellent coverage of Refitter's features with proper error handling and flexible execution modes. The structure with reusable functions and parameterized test generation is well-designed.

---

154-154: Correct CMD escape sequence usage.

The ^^ escape sequence for the caret character is the correct approach for Windows CMD. This aligns perfectly with the warning message added in GenerateCommand.cs about command line interpretation issues.

[sonarqubecloud]

Quality Gate passed

Issues
0 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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.52%. Comparing base (aac42a2) to head (92c55b9).
Report is 16 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #719   +/-   ##
=======================================
  Coverage   98.52%   98.52%           
=======================================
  Files          60       60           
  Lines        2910     2918    +8     
=======================================
+ Hits         2867     2875    +8     
  Misses          4        4           
  Partials       39       39           

Flag	Coverage Δ
unittests	98.52% <ø> (+<0.01%)	⬆️

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.