Question Support Roslyn analyzers in Unity projects

I found this entry in the 2020.2.0a17 release notes:

• Scripting: Support Roslyn analyzers in Unity projects.

Can you provide more info on that?

 

I'm interested in this as well. The setting has been in for a few versions just unsure how to use it.

I use roslyn analyzers in all my projects and created the package back in 2018.3 https://github.com/tertle/com.bovinelabs.analyzers to add support, but if it's now natively supported all the better.

 

Anyone had any luck getting the .ruleset file to work?
I managed to load a bunch of analyzers no problem onto my projects but no matter what I do it won't use the .ruleset file.

I've tried both an existing .ruleset file I had that works with my above library as well as testing the one in the documentation and nothing seems to work; whether its the Default or a custom asmdef version. It's just not added to the csproj.

If I manually edit the .csproj and add
<CodeAnalysisRuleSet>Assets\Default.ruleset</CodeAnalysisRuleSet>
Works fine, as expected. But it's never being added on project generation.

 

I couldn't make the analyzer work. Using 2020.2.0b2 ,project directory is D:\Develop\DENE, keep getting this error over and over

DirectoryNotFoundException: Could not find a part of the path 'D:\Develop\DENE\Temp\RoslynAnalysisRunner'.
System.IO.__Error.WinIOError (System.Int32 errorCode, System.String maybeFullPath) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.FileSystemEnumerableIterator`1[TSource].HandleError (System.Int32 hr, System.String path) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.FileSystemEnumerableIterator`1[TSource].CommonInit () (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.FileSystemEnumerableIterator`1[TSource]..ctor (System.String path, System.String originalUserPath, System.String searchPattern, System.IO.SearchOption searchOption, System.IO.SearchResultHandler`1[TSource] resultHandler, System.Boolean checkHost) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.FileSystemEnumerableFactory.CreateFileNameIterator (System.String path, System.String originalUserPath, System.String searchPattern, System.Boolean includeFiles, System.Boolean includeDirs, System.IO.SearchOption searchOption, System.Boolean checkHost) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.Directory.InternalGetFileDirectoryNames (System.String path, System.String userPathOriginal, System.String searchPattern, System.Boolean includeFiles, System.Boolean includeDirs, System.IO.SearchOption searchOption, System.Boolean checkHost) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.Directory.InternalGetFiles (System.String path, System.String searchPattern, System.IO.SearchOption searchOption) (at <9577ac7a62ef43179789031239ba8798>:0)
System.IO.Directory.GetFiles (System.String path) (at <9577ac7a62ef43179789031239ba8798>:0)
UnityEditor.Scripting.ScriptCompilation.RoslynAnalysisRunner+<>c__DisplayClass43_0.<CreateCompilationTask>b__1 (System.Object _) (at <3d7c86b365634083bceadac5c7f36490>:0)
UnityEditor.Scripting.ScriptCompilation.CompilationTask.HandleOnCompilationTaskFinished () (at <3d7c86b365634083bceadac5c7f36490>:0)
UnityEditor.Scripting.ScriptCompilation.CompilationTask.Poll () (at <3d7c86b365634083bceadac5c7f36490>:0)
UnityEditor.Scripting.ScriptCompilation.RoslynAnalysisRunner.Poll () (at <3d7c86b365634083bceadac5c7f36490>:0)
UnityEditor.EditorApplication.Internal_CallUpdateFunctions () (at <3d7c86b365634083bceadac5c7f36490>:0)

 

Also another question, how will the codefixes are going to work in the editor? In Visual Studio, we press Alt+Enter to make it work.

 

I just followed the instructions in the documentation on an empty project. I only tried ErrorProne.NET dlls. And yes,I started to recieve this error after labeling them.

I tried it two times, both failed with the same message.

 

Windows 10

 

I was already using ErrorProne with a local OmniSharp config. I'm so glad that Unity actually added Roslyn Analyzer support so that I can finally carry the analyzer around with the project.

Edit: I got excited too soon. I got the same repeating error as @sapsari . My OS is macOS 10.15.6.

 

Is there any way for us to include analyzers in a project as .cs files with an assembly definition? Or are we currently only able to include precompiled assemblies? The documentation doesn't really touch on this currently.

 

@MiaoYuGoh Any updates? I have avoided trying things out in the subsequent beta versions.

 

Cool. Please let us know when this fix will land.

 

@MiaoYuGoh
BTW, do you guys have any interest in pushing Microsoft implementing DiagnosticSuppressor for OmniSharp, so that Unity Roslyn Analyzers could properly suppress warnings related to Unity quirks? It should be fair to assume that people would pick up that particular analyzer DLL when 2020.2 is made public with this feature in one of the highlights.

Github Issue: https://github.com/OmniSharp/omnisharp-roslyn/issues/1711

Edit: also tagging @John_MSFT

 

So FYI I was running into the same issue here (Win 10). Restarting the project made it go away but it would randomly appear again sometimes. I also found that just putting the three DLLs with the "RoslynAnalyzer" tag on them didn't work with the RethrowError script from the docs. Instead I had to put an .asmdef file in the same directory as the analyzer DLLs and the script for them to start working. Haven't tried with the ruleset yet.

I expect this is because an "empy" project still has a lot of .asmdef files in it via Packages, and somehow those .asmdef files are breaking the compilation chain in Assets/ required for analyzers to work.

 

Same error here as @sapsari and @Neonlyte (missing the folder "RoslynAnalysisRunner" in the Temp folder). Even after restarting the project like @massivebacon suggested, still got the error.

After some tests, it clearly is triggered when the .dll files are tagged with "RoslynAnalyzer". I'm on an empty project, and I also strictly followed the instructions of the manual page. I'm on Windows 10, Unity 2020.2.0b11.

 

The bug is still exist. Surely restarting Unity will make it gone, but that's not a solution, just a temporary workaround

 

I too tried to get it to work following the Documentation, but am hit with same errors as previous devs above (missing the folder "RoslynAnalysisRunner" in the Temp folder). Restarting doesn't help anyhow, the moment scripts are recompiled I start getting same errors again.

Edit: After deleting everything and redoing it all using Rider (vs Visual Studio), it worked. But doesn't sound like a valid solution, still feels like errors may come up again any moment.

 

I've found out that if you create a folder in [YourProject]/Temp called 'RoslynAnalysisRunner', Unity will immediately detect it, run the analysis then delete it, stopping the error. I've worked for another thirty minutes now and analysis continues to run without issue. Weird. I'm running 2020.2.0f1 with Visual Studio. My Visual Studio seems to still be doing analysis for every asmdef project, rather than just the one I've put the analyzer dlls under, but I can work with this.

 

@MiaoYuGoh I'm also facing this issue. Even after I restart the editor, the error sometimes appears on recompilation.

 

I would like to add that the error appears even if there are no RoslynAnalyzer-labeled assemblies in the project. I'm using Roslyn Analyzers through Directory.Build.props until the error is fixed. It is so annoying I created a small workaround so that I don't have to create the directory manually: https://gist.github.com/SolidAlloy/68b02da3c774c6691da7dab2eba190cc

I updated to 2020.2.1f1 today, and the error is still there. Please prioritize the issue because it disrupts the workflow of users who don't even use the feature.

 

I'm having the same issue with a super simple, brand new Unity project!
Every time I try to run my app I start getting thousand of errors, only way to get rid of them is to manually create the `RoslynAnalysisRunner` folder. Extremely disuptive!
Please Unity staff do something!

EDIT:

PS
Thanks for the temp fix SolidAlloy !

 

Haya, just letting you know (incase it helps) that this occured to me after moving multiple folders from a folder named "Main Assets" to the base "Assets" folder

Unity Version: 2020.2.1f1
OS: Windows 10

 

I also just started seeing this error about missing folder today after moving the package SimpleInput from it's default folder to a different folder as it was impossible to use in the default folder
I never added any Roslyn analyzer to my project. I have no idea what it is and why it's there. But it keeps deleting the missing folder and then complains that the folder is not there

 

Here is a version of your script that works on Linux and Mac (it only worked on Windows because slashes in paths are "\" on Windows, while they are "/" on any Unix based system).
https://gist.github.com/melonmouse/ef4c892ef7d5dd36b77360c622eb7b57

FYI on 2020.2.2f1 the issue persists. In addition, newly added DLLs don't run for me, regardless of the "RoslynAnalyzer" tag, rebuilds of my scripts or the DLL location. However, if I move non-functioning DLLs from one directory to another and back to their original location, they start working on the next rebuild of my scripts.

 

@usewits Thanks, I updated the gist.

 

To add to this; whenever I restart Unity, none of the Roslyn analyzers run when my scripts get built. As before, re-importing the DLLs doesn't help, but moving the DLLs back and forth once to any (temporary) directory fixes it for the rest of the session.

P.S. many thanks to the Unity people who implemented Roslyn analyzer support - its a great addition!

 

If it's useful to anyone, here is a dirty workaround to activate Roslyn analyzers:
https://gist.github.com/melonmouse/4e40827362e0c62dc0c1ae71dd83a18a

After adding that code to a project, right click on a selection of Roslyn Analyzer dlls and click "Activate Roslyn Analyzers".

 

I just grabbed Unity 2020 LTS under the assumption that it was stable.
Immediately I get hit with 100000 errors from Roslyn about part of a path being missing without any info about which path it is talking about.

How can I disable Rosyln? I don't need this, especially with such aggressive and useless error messages.

 

I noticed the "Enable Roslyn Analyzers" checkbox in Project Settings/Player, in 2020.2.4. It was enabled by default for me. Does disabling it turn off RoslynAnalysisRunner, and as a result, Temp folder errors?

 

Can confirm that after turning off 'Enable Roslyn Analyzers' and 'Use Roslyn Reference Assemblies' (for good measure), Temp folder errors stopped appearing. Of course, that also disables code analysis.

Currently using 2020.3.0f1 LTS.

Users of 2021.1, is the fix mentioned by @MiaoYuGoh working?

 

Hello. Does anybody know, is it possible to install Roslyn code-analyzer into Unity project & make it work (for Unity below version 2020)? I've tried - when Unity regenerates .csproj file, it erases lines about added analyzers & analyzers stop working =( //more info here
#UPD: I've found a solution

 

@MiaoYuGoh is it possible to create a Default.ruleset without having custom roslyn analyzers?

I want for certain assemblies that are not mine (third party assets) to remove warnings but without putting it in the folder structure of that asset. Both with the csc.rsp and *.ruleset files they have to be next to the *.asmdef.

In order to be in Assets folder it must be Default.ruleset, Assembly-CSharp.ruleset and two or three other types only. It cannot be any other assemblies *.ruleset. I don't understand why I can't override this behaviour from my project for other different Assembly.

My first problem I have is that it does not include the Default.ruleset file inside the *.csproj.

The second problem is that I would not know how to add the rules since I do not have a custom analyzer, I do not know which is the default "AnalyzerId" of Roslyn because I understand that the warnings that appear in the console are rules that could be created and warnings be excluded.

https://docs.unity3d.com/2020.2/Documentation/Manual/roslyn-analyzers.html

 

What about 2020.3.x LTS? I still see this behaviour on 2020.3.0.

 

@MiaoYuGoh I also see that despite of adding analyzers it doesn't get included in *.csproj files. I see no <Analyzer> tag regarding the Analyzers I added.

The same goes with *.ruleset files.

 

@HaraldNielsen Visual Studio package.

I use sonar to analyze code (with msbuild) but it needs to have analyzers and rulesets reference in csproj to be as close as possible to unity compilation output console result.

 

@HaraldNielsen what about this user's problem? I'm experiencing the same:

https://forum.unity.com/threads/rsp-files-settings-not-propagated-to-csproj.1051115/

What I thought is that all Unity settings are propagated in *.csproj files:

- Flags from csc.rsp files.
- Rulesets
- Analyzers

In our organization we run static code analysis with Sonarqube for which it is necessary to build the solution with dotnet/msbuild "outside Unity", that is, without Unity compiling the code.

Right now the results are different because the *.csproj files do not include the elements I mentioned above.

 

@HaraldNielsen I attach the project so that you can reproduce it as is.

 

I just tried to put the .dll files for Stylecops and to follow the instructions, and it seems to work!

Just one last problem: the warnings are only shown in Unity, Visual Studio don't seem to use the analyzers...

Also, is it possible to completely ignore some specific assemblies for the analysis? We got some external packages that are included in our project directly as source code, and we don't want the analysis to check these files.

 

It's a bug:

https://forum.unity.com/threads/rsp-files-settings-not-propagated-to-csproj.1051115/#post-7111798

You also have a workaround on that post.

 

We would like to include the analyzer in the UPM package and distribute it.

But, an analyzer placed under the Packages folder will not work. Also, it is not possible to set the "Asset Label" in the Plugin Inspector window.
These are on Unity 2021.2.0a16.

Is there any plan to support this?