Support file_header_template

[RedX2501]

It seems to have problems with multi-line headers.

When you have something like:

file_header_template = this\nspans\nmultiple\nlines

the warning will be that it expects it to be all in one line.

[bjornhellander]

Which warning do you see?
And which StyleCop Analyzers version are you using?

[RedX2501]

StyleCop.Analyzers 1.2.0-beta.354.

Based on your question I checked and there is the new 435. I updated to this version and still get that both differ.

stylecop.json contents:

{
  // ACTION REQUIRED: This file was automatically added to your project, but it
  // will not take effect until additional steps are taken to enable it. See the
  // following page for additional information:
  //
  // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md

  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
  "settings": {
  }
}

editorconfig

# All files
[*]
indent_style = space

# Xml files
[*.xml]
indent_size = 2

[*.cs]
file_header_template =  <copyright file="{fileName}" company="My company">multiple\nlines\nwith {fileName}\n</copyright>

Warning:

Warning	SA1636	The file header copyright text should match the copyright text from the settings.	The file header at the top of a C# code file does not contain the appropriate copyright text.

Header in source file:

// <copyright file="ModelKitModel.cs" company="My company">multiple
// lines
// with ModelKitModel.cs
// </copyright>

[sharwell]

It looks like we don't do any processing of \n or \r\n here:

StyleCopAnalyzers/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/DocumentationSettings.cs

Lines 248 to 249 in feea263

	copyrightText ??= AnalyzerConfigHelper.TryGetStringValue(analyzerConfigOptions, "stylecop.documentation.copyrightText")
	?? AnalyzerConfigHelper.TryGetStringValue(analyzerConfigOptions, "file_header_template");

[RedX2501]

@sharwell I've had a quick look at the code and I didn't find also any handling for the string that comes from the JSON. Is it safe to assume that it's because the JSON deserializer is actually handing the line wrapping?

If that's the case would it be enough at that line to handle the wrapping for the value coming from the editorconfig or do I need to investigate more?

[bjornhellander]

@RedX2501 JSON already interprets \n as a line feed character, so only the code that handles the .editorconfig setting needs to handle escape sequences.