Review analyzer Description, Message, and Category

[MattKotsenas]

I'm not sure we're following best practices for the strings for analyzers.

• Currently our Message doesn't accept any format strings, it probably belongs in Description instead
• We should have a Message that includes the text of whatever's incorrect (via the {0} format strings)
• All analyzers are currently in the "Moq" category; should these instead be in the "Usage" or another category?

[coderabbitai]

Progress Update from PR #416

PR #416 has made significant progress on addressing the analyzer string best practices but has diverged too far from main to be easily merged. Here's a comprehensive summary for continuing this work:

Strategy Implemented in PR #416

The PR successfully addressed all three checklist items from this issue:

✅ 1. Message Format Strings

• Before: Generic messages like "Sealed classes cannot be mocked"
• After: Specific messages with format strings like "Sealed class '{0}' cannot be mocked"
• Pattern: Messages now include placeholders to report specific type/member names

✅ 2. Description Property Added

• Before: Only Title and Message properties
• After: Added detailed Description explaining the rule and why it's important
• Example: "Sealed classes cannot be mocked. Mock<T> requires types that can be overridden or implemented."

✅ 3. Category Change

• Before: All analyzers used DiagnosticCategory.Moq
• After: Changed to DiagnosticCategory.Usage following Roslyn conventions
• Implementation: Updated DiagnosticCategory.cs to include both constants

Files That Need Updates

Based on PR #416, the following analyzer files need the string improvements:

• NoSealedClassMocksAnalyzer.cs (Moq1000)
• AsShouldBeUsedOnlyForInterfaceAnalyzer.cs (Moq1300)
• CallbackSignatureShouldMatchMockedMethodAnalyzer.cs (Moq1100)
• ConstructorArgumentsShouldMatchAnalyzer.cs (Moq1001, Moq1002)
• SetupShouldBeUsedOnlyForOverridableMembersAnalyzer.cs (Moq1200)
• SetupShouldNotIncludeAsyncResultAnalyzer.cs (Moq1201)
• NoMethodsInPropertySetupAnalyzer.cs (Moq1101)
• SetExplicitMockBehaviorAnalyzer.cs (Moq1400)
• SetStrictMockBehaviorAnalyzer.cs (Moq1410)

Implementation Pattern

Each analyzer should follow this pattern:

private static readonly LocalizableString Title = "Moq: [Short title]";
private static readonly LocalizableString Message = "[Specific message with '{0}' placeholders]";
private static readonly LocalizableString Description = "[Detailed explanation of the rule and why it matters]";

private static readonly DiagnosticDescriptor Rule = new(
    DiagnosticIds.[RuleId],
    Title,
    Message,
    DiagnosticCategory.Usage,  // Changed from DiagnosticCategory.Moq
    DiagnosticSeverity.Warning,
    isEnabledByDefault: true,
    description: Description,
    helpLinkUri: $"https://github.com/rjmurillo/moq.analyzers/blob/{ThisAssembly.GitCommitId}/docs/rules/{DiagnosticIds.[RuleId]}.md");

Next Steps for Fresh Implementation

1. Start from recent main branch to avoid merge conflicts
2. Update DiagnosticCategory.cs to include Usage constant
3. Apply the pattern above to each analyzer file systematically
4. Update AnalyzerReleases.Unshipped.md with the changes
5. Test the changes to ensure format strings work correctly with actual reported values

Key Examples from PR #416

• Moq1000: "Sealed class '{0}' cannot be mocked"
• Moq1300: "Mock.As<{0}>() should only be used with interfaces"
• Moq1200: "Setup member '{0}' should be overridable"
• Moq1101: "Method '{0}' should use Setup instead of SetupGet/SetupSet"

The approach in PR #416 was well-executed and comprehensive. A fresh implementation should follow the same strategy but start from a current main branch.

---

This update was generated from analysis of PR #416 (link) which diverged from main.