Add a flag (ca|commandArgs) to disable the command line args comment

By default, a comment with the exact command line arguments that were used to generate the source code is generated, only when run from `xcsgen` or `XmlSchemaClassGenerator.Console`.

Author: 0xced

XmlSchemaClassGenerator.Console/Program.cs

@@ -54,6 +54,7 @@ static void Main(string[] args)
             var uniqueTypeNamesAcrossNamespaces = false;
             var createGeneratedCodeAttributeVersion = true;
             var netCoreSpecificCode = false;
+            var generateCommandLineArgs = true;
 
             var options = new OptionSet {
                 { "h|help", "show this message and exit", v => showHelp = v != null },
@@ -126,6 +127,7 @@ A file name may be given by appending a pipe sign (|) followed by a file name (l
                 { "un|uniqueTypeNames", "generate type names that are unique across namespaces (default is false)", v => uniqueTypeNamesAcrossNamespaces = v != null },
                 { "gc|generatedCodeAttribute", "add version information to GeneratedCodeAttribute (default is true)", v => createGeneratedCodeAttributeVersion = v != null },
                 { "nc|netCore", "generate .NET Core specific code that might not work with .NET Framework (default is false)", v => netCoreSpecificCode = v != null },
+                { "ca|commandArgs", "generate a comment with the exact command line arguments that were used to generate the source code (default is true)", v => generateCommandLineArgs = v != null },
             };
 
             var globsAndUris = options.Parse(args);
@@ -200,7 +202,8 @@ A file name may be given by appending a pipe sign (|) followed by a file name (l
                 CompactTypeNames = compactTypeNames,
                 UniqueTypeNamesAcrossNamespaces = uniqueTypeNamesAcrossNamespaces,
                 CreateGeneratedCodeAttributeVersion = createGeneratedCodeAttributeVersion,
-                NetCoreSpecificCode = netCoreSpecificCode
+                NetCoreSpecificCode = netCoreSpecificCode,
+                GenerateCommandLineArgumentsComment = generateCommandLineArgs,
             };
 
             generator.CommentLanguages.AddRange(commentLanguages);

XmlSchemaClassGenerator.Tests/XmlTests.cs

@@ -1049,7 +1049,7 @@ public void ComplexTypeWithAttributeGroupExtension()
             var csharp = Assert.Single(contents);
 
             CompareOutput(
-                $@"//------------------------------------------------------------------------------
+                @"//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by a tool.
 //
@@ -1058,47 +1058,46 @@ public void ComplexTypeWithAttributeGroupExtension()
 // </auto-generated>
 //------------------------------------------------------------------------------
 
-// This code was generated by Tests using the following command:
-// {Extensions.GetFormattedCommandLineArgs()}
+// This code was generated by Tests
 namespace Test
-{{
+{
 
 
     [System.CodeDom.Compiler.GeneratedCodeAttribute(""Tests"", """")]
     [System.SerializableAttribute()]
     [System.Xml.Serialization.XmlTypeAttribute(""group-name"", Namespace="""")]
     [System.ComponentModel.DesignerCategoryAttribute(""code"")]
     public partial class Group_Name
-    {{
+    {
 
         /// <summary>
         /// <para xml:lang=""de"">Ruft den Text ab oder legt diesen fest.</para>
         /// <para xml:lang=""en"">Gets or sets the text value.</para>
         /// </summary>
         [System.Xml.Serialization.XmlTextAttribute()]
-        public string Value {{ get; set; }}
+        public string Value { get; set; }
 
         [System.Xml.Serialization.XmlAttributeAttribute(""justify"")]
-        public SimpleType Justify {{ get; set; }}
+        public SimpleType Justify { get; set; }
 
         /// <summary>
         /// <para xml:lang=""de"">Ruft einen Wert ab, der angibt, ob die Justify-Eigenschaft spezifiziert ist, oder legt diesen fest.</para>
         /// <para xml:lang=""en"">Gets or sets a value indicating whether the Justify property is specified.</para>
         /// </summary>
         [System.Xml.Serialization.XmlIgnoreAttribute()]
-        public bool JustifySpecified {{ get; set; }}
-    }}
+        public bool JustifySpecified { get; set; }
+    }
 
     [System.CodeDom.Compiler.GeneratedCodeAttribute(""Tests"", """")]
     [System.SerializableAttribute()]
     [System.Xml.Serialization.XmlTypeAttribute(""simpleType"", Namespace="""")]
     public enum SimpleType
-    {{
+    {
 
         [System.Xml.Serialization.XmlEnumAttribute(""foo"")]
         Foo,
-    }}
-}}
+    }
+}
 ", csharp);
         }
 

XmlSchemaClassGenerator/CommandLineArgumentsProvider.cs

@@ -0,0 +1,18 @@
+using System;
+using System.IO;
+using System.Linq;
+
+namespace XmlSchemaClassGenerator
+{
+    public class CommandLineArgumentsProvider
+    {
+        public virtual string CommandLineArguments
+        {
+            get
+            {
+                var args = Environment.GetCommandLineArgs();
+                return string.Join(" ", args.Take(1).Select(Path.GetFileNameWithoutExtension).Concat(args.Skip(1)).Select(Extensions.QuoteIfNeeded));
+            }
+        }
+    }
+}

XmlSchemaClassGenerator/Extensions.cs

@@ -43,12 +43,6 @@ public static IEnumerable<TSource> DistinctBy<TSource, TKey>(this IEnumerable<TS
             return source.GroupBy(propertySelector).Select(x => x.First());
         }
 
-        public static string GetFormattedCommandLineArgs()
-        {
-            var args = Environment.GetCommandLineArgs();
-            return string.Join(" ", args.Take(1).Select(Path.GetFileNameWithoutExtension).Concat(args.Skip(1)).Select(QuoteIfNeeded));
-        }
-
         public static string QuoteIfNeeded(this string text)
         {
             if (string.IsNullOrEmpty(text))

XmlSchemaClassGenerator/Generator.cs

@@ -288,6 +288,18 @@ public bool NetCoreSpecificCode
             set { _configuration.NetCoreSpecificCode = value; }
         }
 
+        public bool GenerateCommandLineArgumentsComment
+        {
+            get { return _configuration.GenerateCommandLineArgumentsComment; }
+            set { _configuration.GenerateCommandLineArgumentsComment = value; }
+        }
+
+        public CommandLineArgumentsProvider CommandLineArgumentsProvider
+        {
+            get { return _configuration.CommandLineArgumentsProvider; }
+            set { _configuration.CommandLineArgumentsProvider = value; }
+        }
+
         static Generator()
         {
             Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
@@ -334,9 +346,15 @@ public void Generate(XmlSchemaSet set)
                     {
                         comment.Append($" version {Version.Version}");
                     }
-                    comment.Append(" using the following command:");
+                    if (GenerateCommandLineArgumentsComment)
+                    {
+                        comment.Append(" using the following command:");
+                    }
                     ns.Comments.Add(new CodeCommentStatement(comment.ToString()));
-                    ns.Comments.Add(new CodeCommentStatement(Extensions.GetFormattedCommandLineArgs()));
+                    if (GenerateCommandLineArgumentsComment)
+                    {
+                        ns.Comments.Add(new CodeCommentStatement(CommandLineArgumentsProvider?.CommandLineArguments ?? "N/A"));
+                    }
                 }
 
                 writer.Write(ns);

XmlSchemaClassGenerator/GeneratorConfiguration.cs

@@ -38,6 +38,7 @@ public GeneratorConfiguration()
             NamingProvider = new NamingProvider(NamingScheme);
             Version = VersionProvider.CreateFromAssembly();
             EnableUpaCheck = true;
+            CommandLineArgumentsProvider = new CommandLineArgumentsProvider();
         }
 
         /// <summary>
@@ -304,5 +305,16 @@ public void WriteLog(string message)
         /// </list>
         /// </summary>
         public bool NetCoreSpecificCode { get; set; }
+
+        /// <summary>
+        /// Adds a comment with the exact command line arguments that were used to generate the
+        /// source code using the <see cref="CommandLineArgumentsProvider"/>. Default is false.
+        /// </summary>
+        public bool GenerateCommandLineArgumentsComment { get; set; }
+
+        /// <summary>
+        /// A provider to obtain the command line arguments of the tool.
+        /// </summary>
+        public CommandLineArgumentsProvider CommandLineArgumentsProvider { get; set; }
     }
 }