Dnn.platform: Treat Warnings as Build Errors - DotNetNuke.Abstractions

[ahoefling]

Description of problem

DNN has many build warnings riddled throughout the entire solution which are usually indicators of issues with the code. Be it legacy code that has not been cleaned up or wasted memory footprints when allocating data that is never used. We should be treating all build warnings as errors to ensure a high level of code quality.

This is a massive undertaking with the size of DNN, I recommend we do this for the DotNetNuke.Abstractions project as it is the newest project and smallest project.

Description of solution

• Update .csproj to treat build warnings as erros
• Update code to remove all build errors

Description of alternatives considered

N/A

Screenshots

N/A

Additional context

Code Quality Enhancement

Affected browser

N/A

[bdukes]

We could also do this for DotNetNuke.DependencyInjection

[ahoefling]

Should I create an epic level issue and start creating tasks like this?

[bdukes]

I expect it'll be a while before we're ready to turn this on for any other projects, so I'm not sure how helpful that top-level task would be (it'll probably just get closed after getting stale)

[ahoefling]

I think there is something going on with stylecop for DotNetNuke.DependencyInjection. After turning build warnings as errors on for that project I get an interesting error

1>------ Rebuild All started: Project: DotNetNuke.DependencyInjection, Configuration: Debug Any CPU ------
1>CSC : error SA0001: XML comment analysis is disabled due to project configuration
1>Done building project "DotNetNuke.DependencyInjection.csproj" -- FAILED.
========== Rebuild All: 0 succeeded, 1 failed, 0 skipped ==========

[bdukes]

See the SA0001 documentation. We need to turn on generation of the XML doc file for the project for StyleCop to check the validity of the comments.

[ahoefling]

That helped, now I Just need to remove the warnings 👍

[valadas]

I agree on turning that on on small new projects like this, but yeah we still have a lot of work to do before even thinking about turning that on elsewhere 😬