Rename labs-discussion/issue fields in YAML Frontmatter to discussion…

…/issue-id instead
CommunityToolkit · Nov 30, 2022 · d9a813d · d9a813d
1 parent b85f1ee
commit d9a813d
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 44 deletions.
diff --git a/...unityToolkit.Labs.Core.SourceGenerators.Tests/ToolkitSampleMetadataTests.Documentation.cs b/...unityToolkit.Labs.Core.SourceGenerators.Tests/ToolkitSampleMetadataTests.Documentation.cs
@@ -48,8 +48,8 @@ Without any front matter.
     [DataRow(4, DisplayName = "Keywords")]
     [DataRow(7, DisplayName = "Category")]
     [DataRow(8, DisplayName = "Subcategory")]
-    [DataRow(9, DisplayName = "Labs Discussion")]
-    [DataRow(10, DisplayName = "Labs Issue")]
+    [DataRow(9, DisplayName = "GitHub Discussion Id")]
+    [DataRow(10, DisplayName = "GitHub Issue Id")]
     [TestMethod]
     public void MissingFrontMatterField(int removeline)
     {
@@ -62,8 +62,8 @@ public void MissingFrontMatterField(int removeline)
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: 0
+discussion-id: 0
+issue-id: 0
 ---
 # This is some test documentation...
 > [!SAMPLE Sample]
@@ -89,8 +89,8 @@ public void MarkdownInvalidSampleReference()
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: 0
+discussion-id: 0
+issue-id: 0
 ---
 # This is some test documentation...
 > [!SAMPLE SampINVALIDle]
@@ -114,8 +114,8 @@ public void DocumentationMissingSample()
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: 0
+discussion-id: 0
+issue-id: 0
 ---
 # This is some test documentation...
 Without any sample.";
@@ -137,8 +137,8 @@ public void DocumentationValid()
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: 0
+discussion-id: 0
+issue-id: 0
 ---
 # This is some test documentation...
 Which is valid.
@@ -159,8 +159,8 @@ public void DocumentationInvalidDiscussionId()
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: https://github.com/1234
-labs-issue: 0
+discussion-id: https://github.com/1234
+issue-id: 0
 ---
 # This is some test documentation...
 Without an invalid discussion id.";
@@ -182,8 +182,8 @@ public void DocumentationInvalidIssueId()
     - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: https://github.com/1234
+discussion-id: 0
+issue-id: https://github.com/1234
 ---
 # This is some test documentation...
 Without an invalid discussion id.";

diff --git a/...mmunityToolkit.Labs.Core.SourceGenerators/ToolkitSampleMetadataGenerator.Documentation.cs b/...mmunityToolkit.Labs.Core.SourceGenerators/ToolkitSampleMetadataGenerator.Documentation.cs
@@ -29,10 +29,10 @@ public partial class ToolkitSampleMetadataGenerator
     private const string FrontMatterRegexSubcategoryExpression = @"^subcategory:\s*(?<subcategory>.*)$";
     private static readonly Regex FrontMatterRegexSubcategory = new Regex(FrontMatterRegexSubcategoryExpression, RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Multiline);
 
-    private const string FrontMatterRegexDiscussionIdExpression = @"^labs-discussion:\s*(?<discussionId>.*)$";
+    private const string FrontMatterRegexDiscussionIdExpression = @"^discussion-id:\s*(?<discussionid>.*)$";
     private static readonly Regex FrontMatterRegexDiscussionId = new Regex(FrontMatterRegexDiscussionIdExpression, RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Multiline);
 
-    private const string FrontMatterRegexIssueIdExpression = @"^labs-issue:\s*(?<issueId>.*)$";
+    private const string FrontMatterRegexIssueIdExpression = @"^issue-id:\s*(?<issueid>.*)$";
     private static readonly Regex FrontMatterRegexIssueId = new Regex(FrontMatterRegexIssueIdExpression, RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Multiline);
 
     private const string MarkdownRegexSampleTagExpression = @"^>\s*\[!SAMPLE\s*(?<sampleid>.*)\s*\]\s*$";
@@ -111,8 +111,9 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
                 var category = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexCategory, "category");
                 var subcategory = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexSubcategory, "subcategory");
 
-                var discussion = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexDiscussionId, "discussionId")?.Trim();
-                var issue = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexIssueId, "issueId")?.Trim();
+                // TODO: Should these just be optional?
+                var discussion = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexDiscussionId, "discussionid")?.Trim();
+                var issue = ParseYamlField(ref ctx, file.Path, ref frontmatter, FrontMatterRegexIssueId, "issueid")?.Trim();
 
                 // Check we have all the fields we expect to continue (errors will have been spit out otherwise already from the ParseYamlField method)
                 if (title == null || description == null || keywords == null ||
@@ -175,7 +176,7 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
                             DiagnosticDescriptors.MarkdownYAMLFrontMatterException,
                             Location.Create(file.Path, TextSpan.FromBounds(0, 1), new LinePositionSpan(LinePosition.Zero, LinePosition.Zero)),
                             file.Path,
-                            "Can't parse labs-discussion field, must be a positive integer or zero."));
+                            "Can't parse discussion-id field, must be a positive integer or zero."));
                     return null;
                 }
 
@@ -186,7 +187,7 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
                             DiagnosticDescriptors.MarkdownYAMLFrontMatterException,
                             Location.Create(file.Path, TextSpan.FromBounds(0, 1), new LinePositionSpan(LinePosition.Zero, LinePosition.Zero)),
                             file.Path,
-                            "Can't parse labs-issue field, must be a positive integer or zero."));
+                            "Can't parse issue-id field, must be a positive integer or zero."));
                     return null;
                 }
 

diff --git a/labs/CanvasLayout/samples/CanvasLayout.Samples/CanvasLayout.md b/labs/CanvasLayout/samples/CanvasLayout.Samples/CanvasLayout.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 311
-labs-issue: 213
+discussion-id: 311
+issue-id: 213
 ---
 
 # CanvasLayout

diff --git a/labs/CanvasView/samples/CanvasView.Samples/CanvasView.md b/labs/CanvasView/samples/CanvasView.Samples/CanvasView.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 310
-labs-issue: 212
+discussion-id: 310
+issue-id: 212
 ---
 
 # CanvasView

diff --git a/labs/RivePlayer/samples/RivePlayer.Samples/RivePlayer.md b/labs/RivePlayer/samples/RivePlayer.Samples/RivePlayer.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Animations
 subcategory: Media
-labs-discussion: 309
-labs-issue: 0
+discussion-id: 309
+issue-id: 0
 ---
 
 # RivePlayer

diff --git a/labs/SettingsControls/samples/SettingsControls.Samples/SettingsCard.md b/labs/SettingsControls/samples/SettingsControls.Samples/SettingsCard.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 129
-labs-issue: 216
+discussion-id: 129
+issue-id: 216
 ---
 
 # SettingsCard

diff --git a/labs/SettingsControls/samples/SettingsControls.Samples/SettingsExpander.md b/labs/SettingsControls/samples/SettingsControls.Samples/SettingsExpander.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 129
-labs-issue: 216
+discussion-id: 129
+issue-id: 216
 ---
 
 # SettingsExpander

diff --git a/labs/SettingsControls/samples/SettingsControls.Samples/SettingsPageExample.md b/labs/SettingsControls/samples/SettingsControls.Samples/SettingsPageExample.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 129
-labs-issue: 216
+discussion-id: 129
+issue-id: 216
 ---
 
 # Settings Page Example

diff --git a/labs/SizerBase/samples/SizerBase.Samples/ContentSizer.md b/labs/SizerBase/samples/SizerBase.Samples/ContentSizer.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 96
-labs-issue: 101
+discussion-id: 96
+issue-id: 101
 ---
 
 # ContentSizer

diff --git a/labs/SizerBase/samples/SizerBase.Samples/GridSplitter.md b/labs/SizerBase/samples/SizerBase.Samples/GridSplitter.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 96
-labs-issue: 101
+discussion-id: 96
+issue-id: 101
 ---
 
 # GridSplitter

diff --git a/labs/SizerBase/samples/SizerBase.Samples/PropertySizer.md b/labs/SizerBase/samples/SizerBase.Samples/PropertySizer.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 96
-labs-issue: 101
+discussion-id: 96
+issue-id: 101
 ---
 
 # PropertySizer

diff --git a/labs/SizerBase/samples/SizerBase.Samples/SizerControls.md b/labs/SizerBase/samples/SizerBase.Samples/SizerControls.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 96
-labs-issue: 101
+discussion-id: 96
+issue-id: 101
 ---
 
 # Sizer Controls

diff --git a/...or/samples/StackedNotificationsBehavior.Samples/StackedNotificationsBehavior.md b/...or/samples/StackedNotificationsBehavior.Samples/StackedNotificationsBehavior.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Behaviors
 subcategory: StatusAndInfo
-labs-discussion: 312
-labs-issue: 210
+discussion-id: 312
+issue-id: 210
 ---
 
 # StackedNotificationsBehavior

diff --git a/template/lab/samples/ProjectTemplate.Samples/ProjectTemplate.md b/template/lab/samples/ProjectTemplate.Samples/ProjectTemplate.md
@@ -7,8 +7,8 @@ dev_langs:
   - csharp
 category: Controls
 subcategory: Layout
-labs-discussion: 0
-labs-issue: 0
+discussion-id: 0
+issue-id: 0
 ---
 
 <!-- To know about all the available Markdown syntax, Check out https://docs.microsoft.com/contribute/markdown-reference -->