Enable export rules in multitool

src/Sarif.Multitool/ExportCommand.cs

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+
+using Microsoft.CodeAnalysis.Sarif.Driver;
+using Microsoft.CodeAnalysis.Sarif.Multitool.Rules;
+
+namespace Microsoft.CodeAnalysis.Sarif.Multitool
+{
+    public class ExportCommand : CommandBase
+    {
+        private readonly IFileSystem _fileSystem;
+
+        public ExportCommand()
+        {
+            _fileSystem = new FileSystem();
+        }
+
+        public int Run(ExportOptions options)
+        {
+            try
+            {
+                var list = CompositionUtilities.GetExports<SarifValidationSkimmerBase>(
+                    new Assembly[] { Assembly.GetExecutingAssembly() }).ToList();
+
+                var sb = new StringBuilder();
+                sb.AppendLine($"# Rules{Environment.NewLine}");
+
+                foreach (SarifValidationSkimmerBase rule in list)
+                {
+                    BuildRule(rule, sb);
+                }
+
+                _fileSystem.WriteAllText($"{options.OutputDirectoryPath}\\rules.md", sb.ToString());
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine(ex);
+                return FAILURE;
+            }
+
+            return SUCCESS;
+        }
+
+        private void BuildRule(SarifValidationSkimmerBase rule, StringBuilder sb)
+        {
+            sb.AppendLine($"## Rule `{rule.Id}.{rule.Name}`{Environment.NewLine}");
+            sb.AppendLine($"### Description{Environment.NewLine}");
+            sb.AppendLine($"{rule.FullDescription.Text}{Environment.NewLine}");
+            sb.AppendLine($"### Messages{Environment.NewLine}");
+
+            foreach (System.Collections.Generic.KeyValuePair<string, MultiformatMessageString> message in rule.MessageStrings)
+            {
+                sb.AppendLine($"#### `{message.Key.Split('_').Last()}`: {rule.DefaultLevel}{Environment.NewLine}");
+                sb.AppendLine($"{message.Value.Text}{Environment.NewLine}");
+            }
+
+            sb.AppendLine($"---{Environment.NewLine}");
+        }
+    }
+}

src/Sarif.Multitool/ExportOptions.cs

@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using CommandLine;
+
+namespace Microsoft.CodeAnalysis.Sarif.Multitool
+{
+    [Verb("export", HelpText = "Export rules to md file.")]
+    public class ExportOptions
+    {
+        [Option(
+               'o',
+               "output-directory",
+               HelpText = "A directory to output the exported file.")]
+        public string OutputDirectoryPath { get; internal set; }
+    }
+}

src/Sarif.Multitool/Program.cs

@@ -13,6 +13,7 @@ internal static class Program
         public static int Main(string[] args)
         {
             return Parser.Default.ParseArguments<
+                ExportOptions,
                 ValidateOptions,
                 ConvertOptions,
                 RewriteOptions,
@@ -26,6 +27,7 @@ public static int Main(string[] args)
                 ResultMatchSetOptions,
                 FileWorkItemsOptions>(args)
                 .MapResult(
+                (ExportOptions options) => new ExportCommand().Run(options),
                 (ValidateOptions validateOptions) => new ValidateCommand().Run(validateOptions),
                 (ConvertOptions convertOptions) => new ConvertCommand().Run(convertOptions),
                 (RewriteOptions rewriteOptions) => new RewriteCommand().Run(rewriteOptions),

src/Shared/CommonAssemblyInfo.cs

@@ -14,6 +14,9 @@
 [assembly: CLSCompliant(false)]
 [assembly: NeutralResourcesLanguage("en-US", UltimateResourceFallbackLocation.MainAssembly)]
 
+// This reference necessary for Multitool.
+[assembly: InternalsVisibleTo("Sarif.Multitool, PublicKey=0024000004800000940000000602000000240000525341310004000001000100433fbf156abe9718142bdbd48a440e779a1b708fd21486ee0ae536f4c548edf8a7185c1e3ac89ceef76c15b8cc2497906798779a59402f9b9e27281fb15e7111566cdc9a9f8326301d45320623c5222089cf4d0013f365ae729fb0a9c9d15138042825cd511a0f3d4887a7b92f4c2749f81b410813d297b73244cf64995effb1")]
+
 // This reference necessary for the MOQ test engine.
 [assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]