Adapted help links to new folder structure introduced in CSharpGuidelines v5.5

Author: Bart Koelman

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/AnalyzerCategory.cs

@@ -1,53 +1,57 @@
-using JetBrains.Annotations;
+using System;
+using JetBrains.Annotations;
 
 namespace CSharpGuidelinesAnalyzer
 {
     internal sealed class AnalyzerCategory
     {
-        private const string CommitHash = "7a66f7468da6ce1477753a02e416e04bc9a44e45";
+        private const string CommitHash = "4ad2ebe71296a1d6e70d2f22f7b997edcd9e257d";
 
         [NotNull]
-        public static readonly AnalyzerCategory ClassDesign = new AnalyzerCategory("Class Design", "1000_ClassDesignGuidelines.md");
+        public static readonly AnalyzerCategory ClassDesign = new AnalyzerCategory("Class Design");
 
         [NotNull]
-        public static readonly AnalyzerCategory MemberDesign = new AnalyzerCategory("Member Design", "1100_MemberDesignGuidelines.md");
+        public static readonly AnalyzerCategory MemberDesign = new AnalyzerCategory("Member Design");
 
         [NotNull]
-        public static readonly AnalyzerCategory MiscellaneousDesign = new AnalyzerCategory("Miscellaneous Design", "1200_MiscellaneousDesignGuidelines.md");
+        public static readonly AnalyzerCategory MiscellaneousDesign = new AnalyzerCategory("Miscellaneous Design");
 
         [NotNull]
-        public static readonly AnalyzerCategory Maintainability = new AnalyzerCategory("Maintainability", "1500_MaintainabilityGuidelines.md");
+        public static readonly AnalyzerCategory Maintainability = new AnalyzerCategory("Maintainability");
 
         [NotNull]
-        public static readonly AnalyzerCategory Naming = new AnalyzerCategory("Naming", "1700_NamingGuidelines.md");
+        public static readonly AnalyzerCategory Naming = new AnalyzerCategory("Naming");
 
         [NotNull]
-        public static readonly AnalyzerCategory Framework = new AnalyzerCategory("Framework", "2200_FrameworkGuidelines.md");
+        public static readonly AnalyzerCategory Framework = new AnalyzerCategory("Framework");
 
         [NotNull]
-        public static readonly AnalyzerCategory Documentation = new AnalyzerCategory("Documentation", "2300_DocumentationGuidelines.md");
+        public static readonly AnalyzerCategory Documentation = new AnalyzerCategory("Documentation");
 
         [NotNull]
-        public static readonly AnalyzerCategory Layout = new AnalyzerCategory("Layout", "2400_LayoutGuidelines.md");
-
-        [NotNull]
-        private readonly string helpCategoryUri;
+        public static readonly AnalyzerCategory Layout = new AnalyzerCategory("Layout");
 
         [NotNull]
         public string DisplayName { get; }
 
-        private AnalyzerCategory([NotNull] string displayName, [NotNull] string documentName)
+        private AnalyzerCategory([NotNull] string displayName)
         {
             DisplayName = displayName;
-            helpCategoryUri = $"https://github.com/dennisdoomen/CSharpGuidelines/blob/{CommitHash}/_pages/{documentName}";
         }
 
         [NotNull]
         public string GetHelpLinkUri([NotNull] string ruleId)
         {
             Guard.NotNullNorWhiteSpace(ruleId, nameof(ruleId));
 
-            return helpCategoryUri + "#" + ruleId.ToLowerInvariant();
+            if (!ruleId.StartsWith("AV", StringComparison.Ordinal) || ruleId.Length != 6)
+            {
+                throw new InvalidOperationException($"Rule '{ruleId}' does not match the format AVnnnn.");
+            }
+
+            string ruleNumber = ruleId.Substring(2);
+            return $"https://github.com/dennisdoomen/CSharpGuidelines/blob/{CommitHash}/_rules/{ruleNumber}.md";
+
         }
     }
 }

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/NullCheckOnNullableValueTypeAnalyzer.cs

@@ -23,7 +23,7 @@ public sealed class NullCheckOnNullableValueTypeAnalyzer : DiagnosticAnalyzer
 
         [NotNull]
         private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category.DisplayName,
-            DiagnosticSeverity.Hidden, false, Description, Category.GetHelpLinkUri(DiagnosticId));
+            DiagnosticSeverity.Hidden, false, Description);
 
         [ItemNotNull]
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/OperationHasKeywordAnalyzer.cs

@@ -23,7 +23,7 @@ public sealed class OperationHasKeywordAnalyzer : DiagnosticAnalyzer
 
         [NotNull]
         private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category.DisplayName,
-            DiagnosticSeverity.Hidden, false, Description, Category.GetHelpLinkUri(DiagnosticId));
+            DiagnosticSeverity.Hidden, false, Description);
 
         [ItemNotNull]
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

src/CSharpGuidelinesAnalyzer/CSharpGuidelinesAnalyzer/Rules/OperationIsStatementAnalyzer.cs

@@ -23,7 +23,7 @@ public sealed class OperationIsStatementAnalyzer : DiagnosticAnalyzer
 
         [NotNull]
         private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category.DisplayName,
-            DiagnosticSeverity.Hidden, false, Description, Category.GetHelpLinkUri(DiagnosticId));
+            DiagnosticSeverity.Hidden, false, Description);
 
         [ItemNotNull]
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);