feat: update AsShouldBeUsedOnlyForInterfaceAnalyzer metadata for better diagnostics by Copilot · Pull Request #668 · rjmurillo/moq.analyzers

Copilot · 2025-07-28T00:44:09Z

This PR updates the metadata for AsShouldBeUsedOnlyForInterfaceAnalyzer to provide more informative diagnostics and better categorization.

Changes Made

Enhanced Diagnostic Messaging

Moved existing message to description: The static message "Mock.As() should take interfaces only" is now the diagnostic description
Added format string message: New message format "Mock.As() should take interfaces only, but '{0}' is not an interface" includes the actual type name
Updated analysis method: Now passes the type name to the diagnostic for parameter substitution

Category Improvement

Changed category from "Moq" to "Usage": Better reflects that this is a usage guidance rule rather than a framework-specific issue
Added Usage category: Extended DiagnosticCategory to include the new Usage constant

Example Output Improvement

Before:

Mock.As() should take interfaces only

After:

Mock.As() should take interfaces only, but 'TestClass' is not an interface

The enhanced message clearly identifies which specific type is problematic, making it easier for developers to understand and fix the issue.

Validation

All existing tests continue to pass
Build succeeds with no warnings
Message format substitution verified to work correctly
Release tracking updated for category change

Fixes #648.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

codacy-production · 2025-07-28T00:50:27Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.01% (target: -1.00%)	✅ 100.00% (target: 95.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`1d5a6d0`)	1830	1635	89.34%
Head commit (`46fb920`)	1832 (+2)	1637 (+2)	89.36% (+0.01%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#668)	6	6	100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

…sted Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>

rjmurillo · 2025-07-28T01:07:27Z

Reviewer note: I'm A/B against #669

coderabbitai · 2025-07-28T01:07:28Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 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? Join our Discord community 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 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 PR enhances the AsShouldBeUsedOnlyForInterfaceAnalyzer by improving diagnostic messaging and updating categorization. The analyzer now provides more specific error messages that include the actual problematic type name, making it easier for developers to identify and fix issues.

Key Changes

Enhanced diagnostic message format to include the specific type name that's causing the error
Changed diagnostic category from "Moq" to "Usage" for better classification
Added Usage category to the DiagnosticCategory class

Reviewed Changes

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

File	Description
`src/Common/DiagnosticCategory.cs`	Added new "Usage" category constant
`src/Analyzers/AsShouldBeUsedOnlyForInterfaceAnalyzer.cs`	Updated diagnostic metadata with format string message, description, and category change; modified analysis to pass type name
`src/Analyzers/AnalyzerReleases.Unshipped.md`	Added release tracking entry for category change

Copilot · 2025-07-28T01:29:47Z

src/Analyzers/AsShouldBeUsedOnlyForInterfaceAnalyzer.cs

 {
    private static readonly LocalizableString Title = "Moq: Invalid As type parameter";
-    private static readonly LocalizableString Message = "Mock.As() should take interfaces only";
+    private static readonly LocalizableString Message = "Mock.As() should take interfaces only, but '{0}' is not an interface";


[nitpick] The description ends with a period while the message format string doesn't. For consistency, either both should have periods or neither should.

Suggested change

private static readonly LocalizableString Message = "Mock.As() should take interfaces only, but '{0}' is not an interface";

private static readonly LocalizableString Message = "Mock.As() should take interfaces only, but '{0}' is not an interface.";

Initial plan

942fa5a

Copilot AI assigned Copilot and rjmurillo Jul 28, 2025

Copilot started work on behalf of rjmurillo July 28, 2025 00:44 View session

rjmurillo mentioned this pull request Jul 28, 2025

refactor: Update AsShouldBeUsedOnlyForInterfaceAnalyzer description and category #669

Closed

feat: update AsShouldBeUsedOnlyForInterfaceAnalyzer metadata as reque…

46fb920

…sted Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update Metadata for AsShouldBeUsedOnlyForInterfaceAnalyzer~~ feat: update AsShouldBeUsedOnlyForInterfaceAnalyzer metadata for better diagnostics Jul 28, 2025

Copilot AI requested a review from rjmurillo July 28, 2025 01:05

Copilot finished work on behalf of rjmurillo July 28, 2025 01:06

rjmurillo requested a review from MattKotsenas July 28, 2025 01:07

rjmurillo added documentation releasable labels Jul 28, 2025

rjmurillo approved these changes Jul 28, 2025

View reviewed changes

rjmurillo marked this pull request as ready for review July 28, 2025 01:29

Copilot AI review requested due to automatic review settings July 28, 2025 01:29

Copilot AI reviewed Jul 28, 2025

View reviewed changes

rjmurillo merged commit 81ad590 into main Jul 28, 2025
26 checks passed

rjmurillo deleted the copilot/fix-648 branch July 28, 2025 01:46

rjmurillo added this to the vNext milestone Jul 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update AsShouldBeUsedOnlyForInterfaceAnalyzer metadata for better diagnostics#668

feat: update AsShouldBeUsedOnlyForInterfaceAnalyzer metadata for better diagnostics#668
rjmurillo merged 2 commits intomainfrom
copilot/fix-648

Copilot AI commented Jul 28, 2025 •

edited

Loading

Uh oh!

codacy-production bot commented Jul 28, 2025 •

edited

Loading

Uh oh!

rjmurillo commented Jul 28, 2025

Uh oh!

coderabbitai bot commented Jul 28, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	private static readonly LocalizableString Message = "Mock.As() should take interfaces only, but '{0}' is not an interface";
	private static readonly LocalizableString Message = "Mock.As() should take interfaces only, but '{0}' is not an interface.";

Conversation

Copilot AI commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Enhanced Diagnostic Messaging

Category Improvement

Example Output Improvement

Validation

Uh oh!

codacy-production bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage summary from Codacy

See diff coverage on Codacy

See your quality gate settings Change summary preferences

Uh oh!

rjmurillo commented Jul 28, 2025

Uh oh!

coderabbitai bot commented Jul 28, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jul 28, 2025 •

edited

Loading

codacy-production bot commented Jul 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)