Warnings as Errors for test projects

[bdukes]

This turns off the documentation rules for StyleCop and turns on Warnings as Errors for all test projects

[valadas]

Providing it builds after the rebase, this looks good to me.

[daguiler]

Hi @bdukes
the solution doesn't build anymore in Visual Studio bacause of this. Am I missing something?

[bdukes]

@daguiler it builds fine for me. What errors are you getting? Are you on the latest develop?

[daguiler]

I am on latest develop, and I'm getting errors because of all the broken rules in the test projects.
Are you not getting the same?

[bdukes]

No, those should be suggestions rather than warnings because of the configuration in

Dnn.Platform/DNN Platform/Tests/.editorconfig

Lines 153 to 226 in 7c3d891

	# SA1600: Elements should be documented
	dotnet_diagnostic.SA1600.severity = none
	# SA1309: Field names should not begin with underscore
	dotnet_diagnostic.SA1309.severity = suggestion
	# SA1117: Parameters should be on same line or separate lines
	dotnet_diagnostic.SA1117.severity = suggestion
	# SA1402: File may only contain a single type
	dotnet_diagnostic.SA1402.severity = suggestion
	# SA1616: Element return value documentation should have text
	dotnet_diagnostic.SA1616.severity = suggestion
	# Default severity for analyzer diagnostics with category 'StyleCop.CSharp.DocumentationRules'
	dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity = suggestion
	# CA2100: Review SQL queries for security vulnerabilities
	dotnet_diagnostic.CA2100.severity = suggestion
	# SA1401: Fields should be private
	dotnet_diagnostic.SA1401.severity = suggestion
	# SA1512: Single-line comments should not be followed by blank line
	dotnet_diagnostic.SA1512.severity = suggestion
	# Default severity for analyzer diagnostics with category 'StyleCop.CSharp.ReadabilityRules'
	dotnet_analyzer_diagnostic.category-StyleCop.CSharp.ReadabilityRules.severity = suggestion
	# SA0001: XML comment analysis is disabled due to project configuration
	dotnet_diagnostic.SA0001.severity = silent
	# SA1303: Const field names should begin with upper-case letter
	dotnet_diagnostic.SA1303.severity = suggestion
	# SA1300: Element should begin with upper-case letter
	dotnet_diagnostic.SA1300.severity = suggestion
	# SA1306: Field names should begin with lower-case letter
	dotnet_diagnostic.SA1306.severity = suggestion
	# IDE1006: Naming Styles
	dotnet_diagnostic.IDE1006.severity = suggestion
	# SA1311: Static readonly fields should begin with upper-case letter
	dotnet_diagnostic.SA1311.severity = suggestion
	# Default severity for analyzer diagnostics with category 'StyleCop.CSharp.LayoutRules'
	dotnet_analyzer_diagnostic.category-StyleCop.CSharp.LayoutRules.severity = suggestion
	# CS0618: Type or member is obsolete
	dotnet_diagnostic.CS0618.severity = none
	# SA1312: Variable names should begin with lower-case letter
	dotnet_diagnostic.SA1312.severity = suggestion
	# SA1210: Using directives should be ordered alphabetically by namespace
	dotnet_diagnostic.SA1210.severity = suggestion
	# CS0114: Member hides inherited member; missing override keyword
	dotnet_diagnostic.CS0114.severity = suggestion
	# SA1202: Elements should be ordered by access
	dotnet_diagnostic.SA1202.severity = suggestion
	# SA1310: Field names should not contain underscore
	dotnet_diagnostic.SA1310.severity = suggestion
	# SA1313: Parameter names should begin with lower-case letter
	dotnet_diagnostic.SA1313.severity = suggestion
	# SA1314: Type parameter names should begin with T
	dotnet_diagnostic.SA1314.severity = suggestion

[bdukes]

What version of Visual Studio are you using? I bet it's a fairly new feature to read severity for those rules through .editorconfig.

[daguiler]

mm.. I'm still on 2017 Enterprise

[daguiler]

According to this article, VS 2017 supports .editorconfig files. I'll dig a bit more.

[bdukes]

The Analyzer configuration documentation says

Starting in Visual Studio 2019 version 16.3, you can configure the severity of analyzer rules, or diagnostics, in an EditorConfig file, from the light bulb menu, and from the error list.

[daguiler]

I had an update available for my 2017 version (from 15.9.23 to 15.9.30), but unfortunately it didn't help with this issue.
So I guess I will have to undo this change in my local environment from now on every time I want to build the solution :-(

[bdukes]

If you'd like to submit a change which would work for VS 2017, we'd happily accept it. The best option would be, of course, to resolve the warnings, but that's rather time consuming, which is why we haven't done it 😄

A partial option would be to add a new stylecop.json file for tests which loosens the strictness of the rules (specifically, you can disable the documentation rules), but fix the other issues which can't be controlled via stylecop.json.

The other option is to introduce a .ruleset file which disables the rules and reference that from the test projects.