Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/Microsoft.Unity.Analyzers

Roslyn analyzers for Unity game developers
https://github.com/microsoft/Microsoft.Unity.Analyzers

analyzers csharp unity3d

Last synced: 10 days ago
JSON representation

Roslyn analyzers for Unity game developers

Host: GitHub
URL: https://github.com/microsoft/Microsoft.Unity.Analyzers
Owner: microsoft
License: mit
Created: 2019-12-03T21:14:29.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-05-06T15:19:34.000Z (6 months ago)
Last Synced: 2024-05-09T17:49:47.927Z (6 months ago)
Topics: analyzers, csharp, unity3d
Language: C#
Size: 696 KB
Stars: 641
Watchers: 17
Forks: 67
Open Issues: 14
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Analyzers for Unity

[![Build status](https://github.com/microsoft/Microsoft.Unity.Analyzers/workflows/CI/badge.svg)](https://github.com/microsoft/Microsoft.Unity.Analyzers/actions?query=workflow%3ACI)

[![NuGet](https://img.shields.io/nuget/v/Microsoft.Unity.Analyzers.svg)](https://nuget.org/packages/Microsoft.Unity.Analyzers)

This project provides Visual Studio with a better understanding of Unity projects by adding Unity-specific diagnostics or by removing general C# diagnostics that do not apply to Unity projects.

Check out the [list of analyzers and suppressors](doc/index.md) defined in this project.

# Releases

We are focusing our efforts on the experience brought by our IDEs (Visual Studio, and Visual Studio for Mac) with Unity where these analyzers **ship in the box**. For Visual Studio Code, please use our official Unity extension [here](https://marketplace.visualstudio.com/items?itemName=VisualStudioToolsForUnity.vstuc).

We also ship them on [NuGet](https://nuget.org/packages/Microsoft.Unity.Analyzers) as for people building class librairies for Unity and for other advanced usages.

# Suggesting a new Analyzer

If you have an idea for a best practice for Unity developers to follow, please open an [issue](https://github.com/microsoft/Microsoft.Unity.Analyzers/issues/new?template=Feature_request.md) with the description.

# Prerequisites

For building and testing, you'll need **.NET 7 and Visual Studio 2022 17.4+, Visual Studio 2022 for Mac 17.4+ or Visual Studio Code 1.76+**.

This project binaries are targeting **Visual Studio 2019 16.4+**, **Visual Studio for Mac 8.4+** and **Visual Studio Code 1.76+**.

This project is using the `DiagnosticSuppressor` API to conditionally suppress reported compiler/analyzer diagnostics.

On Windows, you'll need the _Visual Studio extension development_ workload installed to build a VSIX to use and debug the project in Visual Studio.

For unit-testing, we require Unity to be installed. We recommend using the latest LTS version for that.

# Building and testing

Compiling the solution:

`dotnet build .\src\Microsoft.Unity.Analyzers.sln`

Running the unit tests:

`dotnet test .\src\Microsoft.Unity.Analyzers.sln`

You can open `.\src\Microsoft.Unity.Analyzers.sln` in your favorite IDE to work on the analyzers and run/debug the tests.

# Debugging the analyzers on a Unity project

Running and debugging the tests is the easiest way to get started but sometimes you want to work on a real-life Unity project.

## On Visual Studio

- Open the `Microsoft.Unity.Analyzers.Vsix.sln` solution.

- Make sure `Microsoft.Unity.Analyzers.Vsix` is set as the startup project.

- Hit play (Current Instance) to start debugging an experimental instance of Visual Studio 2022.

- Load any Unity project in the Visual Studio experimental instance then put breakpoints in the `Microsoft.Unity.Analyzers` project.

## On Visual Studio for Mac

- Open the `Microsoft.Unity.Analyzers.Mpack.sln` solution.

- Make sure `Microsoft.Unity.Analyzers.Mpack` is set as the startup project.

- Hit play to start debugging an experimental instance of Visual Studio for Mac.

- Load any Unity project in the Visual Studio for Mac experimental instance then put breakpoints in the `Microsoft.Unity.Analyzers` project.

# Handling duplicate diagnostics 

Starting with **Visual Studio Tools for Unity 4.3.2.0 (or 2.3.2.0 on MacOS)**, we ship and automatically include this set of analyzers/suppressors in all projects generated by Unity (using `` directive).

The downside of this is when trying to debug your own solution is to find yourself with duplicated diagnostics because Visual Studio will load both:

- the project-local analyzer that we release and include automatically, through the `` directive. 

- the VSIX extension you deployed, that will apply analyzers/suppressors to all projects in the IDE.

To disable the project-local analyzer, and keeping a workflow compatible with Unity re-generating project files on all asset changes, you can add the following script in an `Editor` folder of your Unity project to disable all local analyzers loaded with `` directive.

```csharp

using UnityEditor;

using System.Text.RegularExpressions;

public class DisableLocalAnalyzersPostProcessor : AssetPostprocessor

{

	public static string OnGeneratedCSProject(string path, string content)

	{

		return Regex.Replace(content, "(\\