Skip to content

Commit f177795

Browse files
committed
REFACTOR: Base URI for all help links is constant
1 parent 4979bf7 commit f177795

1 file changed

Lines changed: 8 additions & 26 deletions

File tree

XrmPluginCore.SourceGenerator/DiagnosticDescriptors.cs

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ namespace XrmPluginCore.SourceGenerator;
1414
internal static class DiagnosticDescriptors
1515
{
1616
private const string Category = "XrmPluginCore.SourceGenerator";
17-
18-
#region XPC1xxx - Informational Messages
17+
private const string HelpLinkBaseUri = "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules";
1918

2019
public static readonly DiagnosticDescriptor GenerationSuccess = new(
2120
id: "XPC1001",
@@ -25,22 +24,14 @@ internal static class DiagnosticDescriptors
2524
DiagnosticSeverity.Info,
2625
isEnabledByDefault: true);
2726

28-
#endregion
29-
30-
#region XPC2xxx - Plugin Class Structure
31-
3227
public static readonly DiagnosticDescriptor NoParameterlessConstructor = new(
3328
id: "XPC2001",
3429
title: "No parameterless constructor found",
3530
messageFormat: "Plugin class '{0}' has no parameterless constructor. Image wrappers will not be generated for this plugin.",
3631
category: Category,
3732
defaultSeverity: DiagnosticSeverity.Warning,
3833
isEnabledByDefault: true,
39-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC2001.md");
40-
41-
#endregion
42-
43-
#region XPC3xxx - Code Style & Best Practices
34+
helpLinkUri: $"{HelpLinkBaseUri}/XPC2001.md");
4435

4536
public static readonly DiagnosticDescriptor PreferNameofOverStringLiteral = new(
4637
id: "XPC3001",
@@ -50,7 +41,7 @@ internal static class DiagnosticDescriptors
5041
defaultSeverity: DiagnosticSeverity.Warning,
5142
isEnabledByDefault: true,
5243
description: "Using nameof() provides compile-time verification that the method exists and enables refactoring support.",
53-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC3001.md");
44+
helpLinkUri: $"{HelpLinkBaseUri}/XPC3001.md");
5445

5546
public static readonly DiagnosticDescriptor LegacyImageRegistration = new(
5647
id: "XPC3002",
@@ -59,7 +50,7 @@ internal static class DiagnosticDescriptors
5950
category: Category,
6051
defaultSeverity: DiagnosticSeverity.Info,
6152
isEnabledByDefault: true,
62-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC3002.md");
53+
helpLinkUri: $"{HelpLinkBaseUri}/XPC3002.md");
6354

6455
public static readonly DiagnosticDescriptor ImageWithoutMethodReference = new(
6556
id: "XPC3003",
@@ -68,11 +59,7 @@ internal static class DiagnosticDescriptors
6859
category: Category,
6960
defaultSeverity: DiagnosticSeverity.Warning,
7061
isEnabledByDefault: true,
71-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC3003.md");
72-
73-
#endregion
74-
75-
#region XPC4xxx - Handler Method Issues
62+
helpLinkUri: $"{HelpLinkBaseUri}/XPC3003.md");
7663

7764
public static readonly DiagnosticDescriptor HandlerMethodNotFound = new(
7865
id: "XPC4001",
@@ -81,7 +68,7 @@ internal static class DiagnosticDescriptors
8168
category: Category,
8269
defaultSeverity: DiagnosticSeverity.Error,
8370
isEnabledByDefault: true,
84-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC4001.md");
71+
helpLinkUri: $"{HelpLinkBaseUri}/XPC4001.md");
8572

8673
public static readonly DiagnosticDescriptor HandlerSignatureMismatch = new(
8774
id: "XPC4002",
@@ -90,7 +77,7 @@ internal static class DiagnosticDescriptors
9077
category: Category,
9178
defaultSeverity: DiagnosticSeverity.Warning,
9279
isEnabledByDefault: true,
93-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC4002.md");
80+
helpLinkUri: $"{HelpLinkBaseUri}/XPC4002.md");
9481

9582
public static readonly DiagnosticDescriptor HandlerSignatureMismatchError = new(
9683
id: "XPC4003",
@@ -99,11 +86,7 @@ internal static class DiagnosticDescriptors
9986
category: Category,
10087
defaultSeverity: DiagnosticSeverity.Error,
10188
isEnabledByDefault: true,
102-
helpLinkUri: "https://github.com/delegateas/XrmPluginCore/blob/main/XrmPluginCore.SourceGenerator/rules/XPC4003.md");
103-
104-
#endregion
105-
106-
#region XPC5xxx - Internal Errors
89+
helpLinkUri: $"{HelpLinkBaseUri}/XPC4003.md");
10790

10891
public static readonly DiagnosticDescriptor SymbolResolutionFailed = new(
10992
id: "XPC5001",
@@ -121,5 +104,4 @@ internal static class DiagnosticDescriptors
121104
DiagnosticSeverity.Error,
122105
isEnabledByDefault: true);
123106

124-
#endregion
125107
}

0 commit comments

Comments
 (0)