Log error if json or http block is not preceded by HTML comment metad…

…ata (#254)
OneDrive · Feb 5, 2024 · 5501a5c · 5501a5c
1 parent 9ce27cb
commit 5501a5c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/ApiDoctor.Validation/DocFile.cs b/ApiDoctor.Validation/DocFile.cs
@@ -586,6 +586,20 @@ protected bool ParseMarkdownBlocks(IssueLogger issues)
                         issues.Message($"Found description: {methodDescription}");
                     }
                 }
+                else if (block.BlockType == BlockType.codeblock && (block.CodeLanguage == "json" || block.CodeLanguage == "http"))
+                {
+                    //If the previous block is html (metadata)
+                    var previousBlockIndex = i - 1;
+                    if (previousBlockIndex >= 0)
+                    {
+                        var previousBlock = this.OriginalMarkdownBlocks[previousBlockIndex];
+                        if (null != previousBlock && previousBlock.BlockType != BlockType.html)
+                        {
+                            issues.Error(ValidationErrorCode.MissingMetadataBlock,
+                                $"Missing metadata for code block:{Environment.NewLine}{block}");
+                        }
+                    }
+                }
                 else if (block.BlockType == BlockType.html)
                 {
                     // If the next block is a codeblock we've found a metadata + codeblock pair

diff --git a/ApiDoctor.Validation/Error/validationerror.cs b/ApiDoctor.Validation/Error/validationerror.cs
@@ -130,6 +130,7 @@ public enum ValidationErrorCode
 
         AmbiguousExample,
         HttpMethodOutOfRange,
+        MissingMetadataBlock,
 
         DeduplicationWasUnsuccessful,
         IncorrectSampleKey,