fix: compiler-version (and other) warnings #69
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Note: this commit is a partial fix and still throws warnings at build * Rolled back Microsoft.CodeAnalysis.* refs to 4.11 to fix warning in dependent projects CS9057, "analyzer assembly references version 4.12.0.0 of the compiler, which is newer than the currently running version" * Added property "EnforceExtendedAnalyzerRules" to analyzer projects to satisfy RS1036
Note: This commit still throws warnings during compilation. * Resolve RS1038 (compiler extensions in an assembly referencing Microsoft.CodeAnalysis.Workspaces) by moving code fixes into a separate analyzer project and removing the reference to Workspaces from LogicBlocks.Analyzers. * Reference the CodeFixes assembly from Example. * Direct the LogicBlocks project to pack in the CodeFixes assembly during compilation.
Note: This commit still throws warnings on compilation. Resolve RS1039 (SemanticModel.GetDeclaredSymbol will always return null for certain subclasses of SyntaxNode) by removing unused parsing code in GeneratorTester
The diagram generator is deliberately doing file i/o in an analyzer, which causes the compiler to emit RS1035. Since the violation is deliberate and doesn't admit a workaround, suppressed the warning at the project level.
jolexxa
approved these changes
Sep 4, 2024
jolexxa
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just as a heads-up, this change moves the code fix into a separate package (explanation below), which may warrant some additional scrutiny before merging.
Analyzers/generators in LogicBlocks depend on v4.12.0-final of Microsoft.CodeAnalysis packages. That causes the resulting DLLs to reference v4.12.0 of the compiler, which is newer than v4.11.0 currently shipped. That in turn causes a
CS9057warning both when compiling LogicBlocks projects that depend on the analyzers, and in user projects referencing LogicBlocks:To fix this, I've rolled back those Microsoft.CodeAnalysis references to v4.11. This causes the compiler to warn that analyzers and generators should now have the project property
EnforceExtendedAnalyzerRulesturned on:After enabling that property, other warnings are generated, notably
RS1038in LogicBlocks.Analyzers andRS1035in LogicBlocks.DiagramGenerator:RS1038
A (new?) rule provides that analyzers and code fixes shouldn't exist in the same assembly, since code fixes rely on the Workspaces package, which is not available for command-line builds. To rectify this, I've moved the code fix into a separate assembly, LogicBlocks.CodeFixes. Additionally, I've put a reference to the code-fix assembly in the Example project, and I've also included it into the main LogicBlocks package.
I've used
ProjectReferences in one of my own local projects to verify that IntelliSense and the compiler still pick up the error about the missing[LogicBlock]attribute with the split-out code-fix package:RS1035
This warns that analyzers should not do file I/O. Since that's the whole purpose of the DiagramGenerator project, I don't see a fix or a workaround for this. Therefore I've just suppressed it in the project settings. (There's also an instance of the same warning code enforcing that analyzers should not access
Environmentproperties, referring to the use ofEnvironment.NewLine. However, issue 6467 at the dotnet/roslyn-analyzers project contains an open discussion about whetherNewLineshould be an exception, so I haven't changed anything there.)RS1039
This was warning that the
Tester.GetSymbolmethod, in GeneratorTester, invokedSemanticModel.GetDeclaredSymbolon aSyntaxNode, which always returns null for certain subclasses ofSyntaxNode. However, that code was unused, so I've removed it rather than address nullability or anything.