Rubberduck Internal Codebase Analyzers

[bclothier]

For a while we've had RubberduckCodeAnalysis project which is referenced by all other Rubberduck.*** projects to manage code quality. Due to the complexity of the codebase and the COM interactions, code analyzers are good tools to aid in code review and maintaining the code quality of the project.

With PR #4238 we will now have 4 analyzers. There are other areas where we might want to see analyzers. Feel free to add what you think might be beneficial. Each should be its own PR.

• Issue a warning for use of SCW classes within certain projects. For example, ideally, an inspection from Rubberduck.CodeAnalysis project should not need any COM access. However, it might be necessary for some certain inspections. The warning would provide an alert for closer scrutiny of the inspection being introduced.
• Issue error for any direct COM access; all access must be meditated via SCWs exclusively. Namespaces that needs direct COM access must be annotated. This is to drive a clean separation at the seams.
• Issue error for missing using or .Dispose of SCW that are owned by the classes. Note that this requires further thought regarding those provided by ProjectsProvider/ProjectRepository which actually requires the opposite inspection since those manage the lifetime of the SCWs.
• ???

[rubberduck203]

I thought Visual Studio provided a warning for Disposable objects that aren’t disposed. I might be imaging things or remembering something that’s only in the pro version.

[bclothier]

Hmm. Curious. I think you're thinking of this CA2000. I think that comes from running code analysis. Or at least the ruleset that has that isn't enabled by default? The custom analyzers run without having to run the code analysis as a separate step.

[rubberduck203]

Your right. I am thinking of that CA. Guess I’m surprised it isn’t also an analyzer.

[bclothier]

FWIW: The IDisposable analyzer now has a open PR that will allow us to decorate the classes. This may need testing.