Merge pull request #221 from davkean/NoCopyright

Turned copyright header off by default

Author: Priya91

src/CodeFormatter/CommandLineParser.cs

@@ -117,31 +117,34 @@ public static class CommandLineParser
     {
         private const string FileSwitch = "/file:";
         private const string ConfigSwitch = "/c:";
-        private const string CopyrightSwitch = "/copyright:";
+        private const string CopyrightWithFileSwitch = "/copyright:";
         private const string LanguageSwitch = "/lang:";
         private const string RuleEnabledSwitch1 = "/rule+:";
         private const string RuleEnabledSwitch2 = "/rule:";
         private const string RuleDisabledSwitch = "/rule-:";
-        private const string Usage = 
+        private const string Usage =
 @"CodeFormatter [/file:<filename>] [/lang:<language>] [/c:<config>[,<config>...]>]
-    [/copyright:<file> | /nocopyright] [/tables] [/nounicode] 
+    [/copyright(+|-):[<file>]] [/tables] [/nounicode] 
     [/rule(+|-):rule1,rule2,...]  [/verbose]
     <project, solution or response file>
 
-    /file        - Only apply changes to files with specified name
-    /lang        - Specifies the language to use when a responsefile is
-                   specified. i.e. 'C#', 'Visual Basic', ... (default: 'C#')
-    /c           - Additional preprocessor configurations the formatter
-                   should run under.
-    /copyright   - Specifies file containing copyright header.
-                   Use ConvertTests to convert MSTest tests to xUnit.
-    /nocopyright - Do not update the copyright message.
-    /tables      - Let tables opt out of formatting by defining
-                   DOTNET_FORMATTER
-    /nounicode   - Do not convert unicode strings to escape sequences
-    /rule(+|-)   - Enable (default) or disable the specified rule
-    /rules       - List the available rules
-    /verbose     - Verbose output
+    /file           - Only apply changes to files with specified name
+    /lang           - Specifies the language to use when a responsefile is
+                      specified. i.e. 'C#', 'Visual Basic', ... (default: 'C#')
+    /c              - Additional preprocessor configurations the formatter
+                      should run under.
+    /copyright(+|-) - Enables or disables (default) updating the copyright 
+                      header in files, optionally specifying a file 
+                      containing a custom copyright header.                   
+    /nocopyright    - Do not update the copyright message.
+    /tables         - Let tables opt out of formatting by defining
+                      DOTNET_FORMATTER
+    /nounicode      - Do not convert unicode strings to escape sequences
+    /rule(+|-)      - Enable (default) or disable the specified rule
+    /rules          - List the available rules
+    /verbose        - Verbose output
+
+Use ConvertTests to convert MSTest tests to xUnit.
 ";
 
         public static void PrintUsage()
@@ -163,7 +166,7 @@ public static CommandLineParseResult Parse(string[] args)
             var formatTargets = new List<string>();
             var fileNames = new List<string>();
             var configBuilder = ImmutableArray.CreateBuilder<string[]>();
-            var copyrightHeader = FormattingDefaults.DefaultCopyrightHeader;
+            var copyrightHeader = ImmutableArray<string>.Empty;
             var ruleMap = ImmutableDictionary<string, bool>.Empty;
             var language = LanguageNames.CSharp;
             var allowTables = false;
@@ -172,15 +175,22 @@ public static CommandLineParseResult Parse(string[] args)
             for (int i = 0; i < args.Length; i++)
             {
                 string arg = args[i];
-                if (arg.StartsWith(ConfigSwitch, StringComparison.OrdinalIgnoreCase))
+                if (arg.StartsWith(ConfigSwitch, comparison))
                 {
                     var all = arg.Substring(ConfigSwitch.Length);
                     var configs = all.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
                     configBuilder.Add(configs);
                 }
-                else if (arg.StartsWith(CopyrightSwitch, StringComparison.OrdinalIgnoreCase))
+                else if (comparer.Equals(arg, "/copyright+") || comparer.Equals(arg, "/copyright"))
+                {
+                    ruleMap = ruleMap.SetItem(FormattingDefaults.CopyrightRuleName, true);
+                    copyrightHeader = FormattingDefaults.DefaultCopyrightHeader;
+                }
+                else if (arg.StartsWith(CopyrightWithFileSwitch, comparison))
                 {
-                    var fileName = arg.Substring(CopyrightSwitch.Length);
+                    ruleMap = ruleMap.SetItem(FormattingDefaults.CopyrightRuleName, true);
+
+                    var fileName = arg.Substring(CopyrightWithFileSwitch.Length);
                     try
                     {
                         copyrightHeader = ImmutableArray.CreateRange(File.ReadAllLines(fileName));
@@ -194,13 +204,14 @@ public static CommandLineParseResult Parse(string[] args)
                         return CommandLineParseResult.CreateError(error);
                     }
                 }
-                else if (arg.StartsWith(LanguageSwitch, StringComparison.OrdinalIgnoreCase))
-                {
-                    language = arg.Substring(LanguageSwitch.Length);
+                else if (comparer.Equals(arg, "/copyright-") || comparer.Equals(arg, "/nocopyright")) 
+                {   // We still check /nocopyright for backwards compat
+
+                    ruleMap = ruleMap.SetItem(FormattingDefaults.CopyrightRuleName, false);
                 }
-                else if (comparer.Equals(arg, "/nocopyright"))
+                else if (arg.StartsWith(LanguageSwitch, comparison))
                 {
-                    ruleMap = ruleMap.SetItem(FormattingDefaults.CopyrightRuleName, false);
+                    language = arg.Substring(LanguageSwitch.Length);
                 }
                 else if (comparer.Equals(arg, "/nounicode"))
                 {

src/Microsoft.DotNet.CodeFormatting.Tests/CommandLineParserTests.cs

@@ -83,12 +83,36 @@ public void NoUnicode()
             Assert.Equal(new[] { "test.csproj" }, options.FormatTargets);
         }
 
+        [Fact]
+        public void CopyrightDisable()
+        {
+            var options = Parse("/copyright-", "test.csproj");
+            Assert.False(options.RuleMap[FormattingDefaults.CopyrightRuleName]);
+            Assert.Equal(new[] { "test.csproj" }, options.FormatTargets);
+        }
+
         [Fact]
         public void NoCopyright()
         {
             var options = Parse("/nocopyright", "test.csproj");
             Assert.False(options.RuleMap[FormattingDefaults.CopyrightRuleName]);
             Assert.Equal(new[] { "test.csproj" }, options.FormatTargets);
         }
+
+        [Fact]
+        public void CopyrightEnable1()
+        {
+            var options = Parse("/copyright+", "test.csproj");
+            Assert.True(options.RuleMap[FormattingDefaults.CopyrightRuleName]);
+            Assert.Equal(new[] { "test.csproj" }, options.FormatTargets);
+        }
+
+        [Fact]
+        public void CopyrightEnable2()
+        {
+            var options = Parse("/copyright", "test.csproj");
+            Assert.True(options.RuleMap[FormattingDefaults.CopyrightRuleName]);
+            Assert.Equal(new[] { "test.csproj" }, options.FormatTargets);
+        }
     }
 }

src/Microsoft.DotNet.CodeFormatting.Tests/Rules/CombinationTest.cs

@@ -66,8 +66,7 @@ void M() {
     }
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
     private int _field;
@@ -123,8 +122,7 @@ void M() {
     }
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
     private int field;
@@ -151,8 +149,7 @@ void M() {
     }
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
     private int _field;
@@ -177,8 +174,7 @@ void M() { }
 #endif 
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
 #if DOG
@@ -201,8 +197,7 @@ internal void M() {
 #endif 
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
 #if DOG
@@ -232,8 +227,7 @@ void M() {
 #endif 
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
     private void G()
@@ -270,8 +264,7 @@ void M() {
 #endif 
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
 #if TEST
@@ -310,8 +303,7 @@ private void M()
     }
 }";
 
-            var expected = @"// header
-
+            var expected = @"
 internal class C
 {
     private void M()
@@ -348,8 +340,7 @@ public void RequiredRuntimeAttribute()
        {}
     }
 }";
-            var expected = @"// header
-
+            var expected = @"
 using System;
 using System.Reflection;
 

src/Microsoft.DotNet.CodeFormatting/Rules/CopyrightHeaderRule.cs

@@ -13,7 +13,7 @@
 
 namespace Microsoft.DotNet.CodeFormatting.Rules
 {
-    [SyntaxRule(CopyrightHeaderRule.Name, CopyrightHeaderRule.Description, SyntaxRuleOrder.CopyrightHeaderRule)]
+    [SyntaxRule(CopyrightHeaderRule.Name, CopyrightHeaderRule.Description, SyntaxRuleOrder.CopyrightHeaderRule, DefaultRule=false)]
     internal sealed partial class CopyrightHeaderRule : SyntaxFormattingRule, ISyntaxFormattingRule
     {
         internal const string Name = FormattingDefaults.CopyrightRuleName;