Enforce style rules during build

[jgonz120]

Bug

Fixes:

Regression? Last working version:

Description

Updated two projects to include style rules enforcement during build, fixing the build errors for those two projects.

PR Checklist

• PR has a meaningful title

• PR has a linked issue.

• Described changes

• Tests

  • Automated tests added
  • OR
  • Test exception
  • OR
  • N/A

• Documentation

  • Documentation PR or issue filled
  • OR
  • N/A

[nkolev92]

We've historically added our suppressions in a GlobalSuppressions file, since this makes the file really busy.

[jgonz120]

It didn't give me the option to in the "Quick actions" even after creating a global suppression file. Lemme see just force the value in there and see if it works

[zivkan]

I 100% disagree with putting all the suppressions in a GlobalSuppressions file. It being busy in the code is a feature, because when I'm reviewing a future PR and I see they're modifying a line within a #pragma disable block, or a line right next to it, I can comment on the PR saying please remove this tech debt. If the suppression is in the GlobalSuppresions file, it becomes much more difficult to know that there's an analyzer warning that's being suppressed and that improvements could be made.

If this is specifically about VS1591 or other XML comment warnings, then maybe we should disable this analyzer for proejcts that don't ship to nuget.org as packages.

I just don't see GlobalSuppressions.cs as a positive thing, with the possible exception of WPF code and the "keep the object heirarchy lower than X" warning.

[nkolev92]

Wouldn't this cause it to only fail in the official build?

[jgonz120]

I think the opposite, right now the documents are only generated if the project has "PackProject" is set to true, and there's nothing set in "GenerateDocumentationFile".

I wanted to make sure that nothing changes for the official builds. Without the Generated documentation files, some of the rules don't get enforced.

[nkolev92]

I might be missing some other motivation here, but I tend to be of the opinion that build rules should remain the same for simplicity.

There's no harm in getting xml files for projects we don't ship as packages, as we have other logic (such as VSIX), to ensure we only ship dlls.

[dotnet-policy-service]

This PR has been automatically marked as stale because it has no activity for 7 days. It will be closed if no further activity occurs within another 7 days of this comment. If it is closed, you may reopen it anytime when you're ready again, as long as you don't delete the branch.