Xml to markdown with Workflow

.github/workflows/ConvertGuidelinesXmlToMarkdown.yml

@@ -0,0 +1,53 @@
+#if the guidelines xml file is modified between commits to the master branch the associate markdown file is updated
+name: Update csharp Markdown
+
+on:
+  push:
+    branches: 
+      - 'master'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+         XmlFileName: "Guidelines(8th Edition).xml"
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+          ref: ${{ github.ref }}
+    - name: Simple Diff
+      uses: mudlabs/simple-diff@v1.0.2
+      id: diff
+      with:
+    # The path of the file or folder to find in the commits diff tree.
+        path: ./docs/${{ env.XmlFileName }}
+    # continue even if the xml file if the file isn't found in the diff tree (it wasn't changed). strict=true causes the action to fail otherwise
+        strict : false
+    - name: Guidelines xml status 
+      run: |
+        echo "${{ env.XmlFileName }} modified = ${{ steps.diff.outputs.modified }}"
+        echo "${{ steps.diff.outputs.name }}"     
+
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 3.1.301
+      if: steps.diff.outputs.modified == true
+
+    - name: restore_compile_run_createMD
+      run: |
+         dotnet restore
+         dotnet run --configuration Release --project ./XMLtoMD/GuidelineXmlToMD/GuidelineXmlToMD.csproj
+         ./XMLtoMD/GuidelineXmlToMD/bin/Release/netcoreapp3.1/GuidelineXmlToMD "${{ env.XmlFileName }}" 
+      if: steps.diff.outputs.modified == true
+
+    - name: Create commit and push to CodingGuideLinesMDUpdate
+      run: |
+          git config user.name '${{ github.actor }}'
+          git config user.email '${{ github.actor }}@users.noreply.github.com'
+          git add -A
+          git commit -m "new coding guidelines MD File created"
+          git push origin '${{ github.ref }}'
+      if: steps.diff.outputs.modified == true    

XMLtoMD/GuidelineXmlToMD/GlobalSuppressions.cs

@@ -0,0 +1,11 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Globalization", "CA1307:Specify StringComparison", Justification = "<Pending>")]
+[assembly: SuppressMessage("Globalization", "CA1303:Do not pass literals as localized parameters", Justification = "From an Old Github Project, not for production")]
+[assembly: SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "<Pending>")]
+

XMLtoMD/GuidelineXmlToMD/Guideline.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+
+
+namespace GuidelineXmlToMD
+{
+    public class Guideline
+    {
+        public string Key { get; set; } = "";
+        public string Text { get; set; } = "";
+
+        public string Severity { get; set; } = "";
+
+        public string Section { get; set; } = "";
+        public string Subsection { get; set; } = "";
+
+        public List<string> Comments { get;} = new List<string>();
+
+        public override int GetHashCode()
+        {
+            return Key.GetHashCode();
+        }
+
+        public override bool Equals(object obj)
+        {
+            Guideline otherGuideline = obj as Guideline;
+
+            return otherGuideline != null && string.Equals(otherGuideline.Key, this.Key);
+        }
+
+    }
+
+}

XMLtoMD/GuidelineXmlToMD/GuidelineXmlFileReader.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Xml.Linq;
+
+namespace GuidelineXmlToMD
+{
+    static class GuidelineXmlFileReader
+    {
+        public const string _Guideline = "guideline";
+        public const string _Key = "key";
+        public const string _Severity = "severity";
+
+        public const string _Section = "section";
+        public const string _Subsection = "subsection";
+        public const string _Comments = "comments";
+
+
+        public static ICollection<Guideline> ReadExisitingGuidelinesFile(string pathToExistingGuidelinesXml)
+        {
+
+            XDocument previousGuidelines = XDocument.Load(pathToExistingGuidelinesXml);
+
+            HashSet<Guideline> guidelines = new HashSet<Guideline>();
+
+            foreach (XElement guidelineFromXml in previousGuidelines.Root.DescendantNodes().OfType<XElement>())
+            {
+                Guideline guideline = new Guideline();
+                guideline.Severity = guidelineFromXml.Attribute(_Severity)?.Value;
+                guideline.Subsection = guidelineFromXml.Attribute(_Subsection)?.Value;
+                guideline.Section = guidelineFromXml.Attribute(_Section)?.Value;
+                guideline.Text = guidelineFromXml?.Value;
+                guideline.Key = guidelineFromXml.Attribute(_Key)?.Value;
+
+                guidelines.Add(guideline);
+            }
+            return guidelines;
+        }
+
+    }
+}

XMLtoMD/GuidelineXmlToMD/GuidelineXmlToMD.csproj

@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="MarkdownOut\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="IntelliTect.Analyzers" Version="0.1.8" />
+  </ItemGroup>
+
+</Project>

XMLtoMD/GuidelineXmlToMD/GuidelineXmlToMD.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30225.117
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GuidelineXmlToMD", "GuidelineXmlToMD.csproj", "{D9C7CC15-01DB-46FE-922A-6EB41CE1759B}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{D9C7CC15-01DB-46FE-922A-6EB41CE1759B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D9C7CC15-01DB-46FE-922A-6EB41CE1759B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D9C7CC15-01DB-46FE-922A-6EB41CE1759B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D9C7CC15-01DB-46FE-922A-6EB41CE1759B}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {A1FCF330-0100-466C-A566-FF92F0B59E10}
+	EndGlobalSection
+EndGlobal

XMLtoMD/GuidelineXmlToMD/MarkdownOut/MdExtensions.cs

@@ -0,0 +1,47 @@
+namespace MarkdownOut {
+
+    /// <summary>
+    /// A container for extension methods related to Markdown styling and formatting.
+    /// </summary>
+    public static class MdExtensions {
+
+        /// <summary>
+        /// Styles one or more substrings of the provided string using the specified
+        /// <see cref="MdStyle"/>.
+        /// </summary>
+        /// <param name="str">The string containing the substring to style.</param>
+        /// <param name="substring">The substring to style.</param>
+        /// <param name="style">The Markdown style to apply.</param>
+        /// <param name="firstOnly">
+        /// If true, only the first occurrence of the substring is styled; otherwise, all
+        /// occurrences of the substring are styled.
+        /// </param>
+        /// <returns>
+        /// The selectively styled string. If <paramref name="str"/> does not contain any
+        /// occurrences of <paramref name="substring"/>, it is returned unchanged.
+        /// </returns>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1303:Do not pass literals as localized parameters", Justification = "<Pending>")]
+        public static string StyleSubstring(this string str, string substring, MdStyle style,
+                                            bool firstOnly = false) {
+            if (string.IsNullOrEmpty(str))
+            {
+                throw new System.ArgumentException("cannot stylize empty string", nameof(str));
+            }
+
+            if (string.IsNullOrEmpty(substring))
+            {
+                throw new System.ArgumentException("cannot stylize empty string", nameof(str));
+            }
+
+            if (!firstOnly) {
+                return str?.Replace(substring, MdText.Style(substring, style), System.StringComparison.Ordinal);
+            }
+            int pos = str.IndexOf(substring, System.StringComparison.Ordinal);
+            if (pos < 0) {
+                return str;
+            }
+            return str.Substring(0, pos) + MdText.Style(substring, style)
+                   + str.Substring(pos + substring.Length);
+        }
+    }
+}

XMLtoMD/GuidelineXmlToMD/MarkdownOut/MdFormat.cs

@@ -0,0 +1,65 @@
+namespace MarkdownOut {
+
+    /// <summary>
+    /// Specifies a Markdown format to apply to a line or block of text. Formats are applied with a
+    /// prefix string and, unlike Markdown styles (see <see cref="MdStyle"/>), cannot be selectively
+    /// applied to substrings.
+    /// </summary>
+    public enum MdFormat {
+
+        /// <summary>
+        /// No text format.
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// Heading 1 text format (inserts the string <c>"# "</c> in front of text).
+        /// </summary>
+        Heading1,
+
+        /// <summary>
+        /// Heading 2 text format (inserts the string <c>"## "</c> in front of text).
+        /// </summary>
+        Heading2,
+
+        /// <summary>
+        /// Heading 3 text format (inserts the string <c>"### "</c> in front of text).
+        /// </summary>
+        Heading3,
+
+        /// <summary>
+        /// Heading 4 text format (inserts the string <c>"#### "</c> in front of text).
+        /// </summary>
+        Heading4,
+
+        /// <summary>
+        /// Heading 5 text format (inserts the string <c>"##### "</c> in front of text).
+        /// </summary>
+        Heading5,
+
+        /// <summary>
+        /// Heading 6 text format (inserts the string <c>"###### "</c> in front of text).
+        /// </summary>
+        Heading6,
+
+        /// <summary>
+        /// Quote text format (inserts the string <c>"> "</c> in front of text).
+        /// </summary>
+        Quote,
+
+        /// <summary>
+        /// Unordered list item text format (inserts the string <c>"- "</c> in front of text).
+        /// </summary>
+        UnorderedListItem,
+
+        /// <summary>
+        /// Ordered list item text format (inserts the string <c>"1. "</c> in front of text).
+        /// </summary>
+        OrderedListItem,
+
+        /// <summary>
+        /// Creates a link to the heading that matches text to write (formats the text as [Foo](#foo)).
+        /// </summary>
+        InternalLink,
+    }
+}

XMLtoMD/GuidelineXmlToMD/MarkdownOut/MdStyle.cs

@@ -0,0 +1,40 @@
+namespace MarkdownOut {
+
+    /// <summary>
+    /// Specifies a Markdown style to apply to a string of text. Styles are applied by wrapping text
+    /// with a special string on each side and can be selectively applied to substrings.
+    /// </summary>
+    public enum MdStyle {
+
+        /// <summary>
+        /// No text styling.
+        /// </summary>
+        None,
+
+        /// <summary>
+        /// Italic text styling (surrounds text with a single <c>*</c> character on each side).
+        /// </summary>
+        Italic,
+
+        /// <summary>
+        /// Bold text styling (surrounds text with two <c>*</c> characters on each side).
+        /// </summary>
+        Bold,
+
+        /// <summary>
+        /// Bold italic text styling (surrounds text with three <c>*</c> characters on each side).
+        /// </summary>
+        BoldItalic,
+
+        /// <summary>
+        /// Code text styling (surrounds text with a single <c>`</c> character on each side).
+        /// </summary>
+        Code,
+
+        /// <summary>
+        /// Strike-through text styling (surrounds text with two <c>~</c> characters on each side).
+        /// This style may not be supported by all Markdown parsers.
+        /// </summary>
+        StrikeThrough,
+    }
+}