Code quality: investigate enforcing DSL at compile-time using static code analysis

[Pressacco]

Indirectly related to

• 382

[Pressacco]

Observations

General

• Microsoft.CodeAnalysis.FxCopAnalyzers is no longer supported as of Visual Studio 2019
• Roslyn analyzers are now shiipped with the .NET SDK, and do not need to be installed separately.
• BE ASVISED: to enable static code analysis
  1. for .NET Core 5 or later, it is enabled by default
  2. for .NET Standard or older .NET Core
     1. you must manually enable code analysis using the project setting <EnableNETAnalyzers>True</EnableNETAnalyzers> or
     2. reference the Microsoft.CodeAnalysis.NetAnalyzers NuGet package
• Furthermore, it appears that the Weevil.ruleset file can be removed... it appears that *.ruleset files are no longer supported by .NET Core

Spelling

Background

• Spelling was enforced at compile-time using FxCop rule CA1704 & a CodeAnalysisDictionary
• When the Roslyn analyzers were first introduced CA1704 was not initially supported.
• Pre-release support is not available through the Text.Analyzers NuGet package
  • https://github.com/dotnet/roslyn-analyzers/tree/main/src/Text.Analyzers
• The Roslyn analyzer is still under development. As of August 2023:
• To further complicate things, Microsoft is releasing a new version of the Spell Check for visual studio.
  • As of August 2023 it does not appear to be working.

Compile-Time Spell Check

Update .editorconfig in the solution folder:

spelling_exclusion_path = spelling_whitelist.dic
dotnet_diagnostic.CA1704.severity = warning

When you add "Ignore" a word using VS2022 IDE Spell Checker, the work will be added to spelling_whitelist.dic.

BE ADVISED: the source code for the Roslyn analyzer suggests that it will read data from either CodeAnalysisDictionary OR spelling_whitelist.dic.

• not sure how this works with the new VS2022 spell checker.

Additional Reading

• Overview of .NET source code analysis
• MSDN: Source Code Analysis
  • Roslyn analyzers
    • Text.Anaylyzer
      • still under development
      • includes spell checking at compile time
• list of Roslyn code quality rules

[Pressacco]

To Do

1. [ ] Wait until the Ignore feature to work in the new VS2022 Spell Check feature.
   • Which informs VS2022 that the selected word is valid & should be added to the white list.
2. [ ] Using the latest Text.Analyzers, setup compile-time static code analysis.
3. [ ] Configured the analyzer
   • block unwanted words
   • allow DSL specific terms
4. [ ] Compile

The Weevil projects should compile as expected, and the analyzer should enforce the domain specific language.

BLOCKED waiting for Microsoft to release updated tools.