Merge pull request #3842 from alexrp/patch-1

Update `stylecop.json` schema to have correct default for `headerDecoration`.
DotNetAnalyzers · May 22, 2024 · 5bdaf0a · 5bdaf0a
2 parents 17b613d + 9827fb3
commit 5bdaf0a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/DocumentationSettings.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/DocumentationSettings.cs
@@ -116,7 +116,7 @@ protected internal DocumentationSettings()
         {
             this.companyName = DefaultCompanyName;
             this.copyrightText = DefaultCopyrightText;
-            this.headerDecoration = null;
+            this.headerDecoration = string.Empty;
             this.variables = ImmutableDictionary<string, string>.Empty;
             this.xmlHeader = true;
 
@@ -267,7 +267,7 @@ protected internal DocumentationSettings(JsonObject documentationSettingsObject,
             this.documentPrivateFields = documentPrivateFields.GetValueOrDefault(false);
             this.companyName = companyName ?? DefaultCompanyName;
             this.copyrightText = copyrightText ?? DefaultCopyrightText;
-            this.headerDecoration = headerDecoration;
+            this.headerDecoration = headerDecoration ?? string.Empty;
             this.variables = variables?.ToImmutable() ?? ImmutableDictionary<string, string>.Empty;
             this.xmlHeader = xmlHeader.GetValueOrDefault(true);
             this.fileNamingConvention = fileNamingConvention.GetValueOrDefault(FileNamingConvention.StyleCop);

diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json
@@ -263,7 +263,7 @@
             "headerDecoration": {
               "type": "string",
               "description": "The text used as decoration for the copyright header comment.",
-              "default": null
+              "default": ""
             },
             "fileNamingConvention": {
               "type": "string",