Home / .NET / Miscellaneous

.NET Roslyn Analyzer for VRChat Udon and UdonSharp.

.NET Roslyn Analyzer for VRChat Udon and UdonSharp.

UdonRabbit.Analyzer

Experimental .NET Roslyn Analyzer for VRChat Udon and UdonSharp.
This analyzer accelerates your Udon development with UdonSharp.
Check out the list of analyzers defined in this project.
Not enough types of analyzers in UdonRabbit.Analyzer?
You can check out the list of missing analyzers or create a new issues.

Features

  • It reports the part of the behaviour that doesn't work well on VRChat as an error in editor
  • It reports an error in the editor that about the syntax that cannot be compiled by the UdonSharp
  • etc

Getting Started

Requirements

  • Microsoft Visual Studio 2019 or IDE that supports Roslyn Analyzer
  • VRCSDK3 that supports Udon
  • UdonSharp

Development

Requirements

  • .NET 5
  • Visual Studio Version 16.8+ or Visual Studio for Mac 8.8+
  • Unity Project that containing VRCSDK3 and UdonSharp

How to develop

  1. Open Source/UdonRabbit.Analyzer.sln in your Visual Studio
  2. Start UdonRabbit.Analyzer.VSIX as debug profile
  3. After the Visual Studio Experimental Instance starts, open the Unity project that has VRCSDK3 and UdonSharp installed
  4. Open any source file that inherits from UdonSharp.UdonSharpBehaviour

Create a new analyzer

  1. Open Source/UdonRabbit.Analyzer.sln in your Visual Studio or other IDE
  2. Build UdonRabbit.Analyzer.CodeGen
  3. Run dotnet ./UdonRabbit.Analyzer.CodeGen.dll -i IDENTIFIER -l "CLASS_NAME" -t "TITLE" -d "DESCRIPTION" -m "MESSAGE_FORMAT" -c CATEGORY -s SEVERITY -w ../ in ROOT/bin
  4. Rebuild ResX in Visual Studio or run ResGen.exe
  5. Start Coding!

Testing

Requirements

  • .NET 5
  • Visual Studio Version 16.8+
  • Unity Project that containing VRCSDK3 and UdonSharp

How to test

  1. Configure the following environment variables in Source/UdonRabbit.Analyzer.Test/bin/Debug/net5.0/UdonRabbit.runsettings
    • UDONRABBIT_ANALYZER_TEST_PROJECT : Unity 2018.4.20f1 Test Project Location (.csproj)
      • Default: null (Current Directory)
      • I recommended to reference to Assembly-CSharp.csproj because it has all references to DLLs.
      • If you are not want to reference to Assembly-CSharp.csproj, add the following external references:
        • TextMeshPro
        • UdonSharp.Runtime
    • UDONRABBIT_ANALYZER_TEST_UDON_SHARP : UdonSharp.Runtime.dll Location
      • Default: null (Current Directory)
  2. Run dotnet test

Analyzer Documents

See https://docs.mochizuki.moe/udon-rabbit/packages/analyzer/ (ja-JP)

ScreenShots

Troubleshooting

I found a bug on VS/VS Code/Rider/Analyzer

If you find a bug, feel free to create a new issue!

Analyzer is not worked on UdonSharpBehaviour

You cannot run multiple UdonRabbit.Analyzer instances in the same Unity workspace.
Therefore, if you are running Analyzer in multiple editors, disable one.
If that doesn't work, we recommend restarting your PC.

License

MIT by @6jz

Third Party Notices

This project contains some code from the following project.
See method comments for details.

Links

Discord Server : https://discord.gg/h42BzsFtD2
Patreon : XXX

13 Open More issues
Closed

Add Test Suites

This PR is closed #41

opened Mar 26, 2021 by mika-f 1
Closed

Automatic Release When Tagging

opened Mar 30, 2021 by mika-f 1
Closed

Not Working Correctly on `Assembly-CSharp`

Describe the bug When I first open an assembly that does not directly reference some Udon, it fails to get the Udon function list and does not work properly.

To Reproduce Steps to reproduce the behavior:

  1. open project in some editor
  2. first, open a file in Assembly-CSharp

Expected behavior The Udon assembly is loaded correctly and the function list is created.

Screenshots If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

  • OS: [e.g. Windows 10]
  • Analyzer Version: [e.g. 22]
  • Unity Version: [e.g. 2018.4.20f1]
  • VRCSDK Version: [e.g. 2021.03.09.13.57]
  • UdonSharp Version: [e.g. v0.19.6]
  • Editor Version: [e.g. Rider 2020.3]

Additional context Add any other context about the problem here.

bug 
opened Mar 31, 2021 by mika-f 1
Closed

Category: `Udon` Analyzers are not working correctly in JetBrains Rider

Describe the bug Mark methods and fields exposed to Udon as errors

To Reproduce Steps to reproduce the behavior:

  1. Typing the methods/field that not exposed to Udon

Expected behavior No mark as errors

Screenshots キャプチャ

Environment (please complete the following information):

  • OS: Windows 10
  • Analyzer Version: v0.2.0
  • Unity Version: 2018.4.20f1
  • VRCSDK Version: Udon Networking Beta 4
  • UdonSharp Version: v0.19.7
  • Editor Version: Rider 2020.3.4

Additional context Add any other context about the problem here.

bug 
opened Mar 27, 2021 by mika-f 1
Closed

URA0023: Only one class declaration per file is currently supported by UdonSharp

enhancement 
opened Mar 26, 2021 by mika-f 1
Closed

`Vector3.one` is exposed, but reported as error

Describe the bug Vector3.one is exposed, but reported as error

To Reproduce Type Vector3.one

Expected behavior No report.

Screenshots If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

  • OS: [e.g. Windows 10]
  • Analyzer Version: [e.g. 22]
  • Unity Version: [e.g. 2018.4.20f1]
  • VRCSDK Version: [e.g. 2021.03.09.13.57]
  • UdonSharp Version: [e.g. v0.19.6]
  • Editor Version: [e.g. Rider 2020.3]

Additional context Add any other context about the problem here.

bug 
opened Mar 30, 2021 by mika-f 1
Open

Fix an issue that unable to build player when analyzer is enabled

This PR closes #121

opened May 4, 2021 by mika-f 0
Open

Player Build Error when Analyzer is Enabled

If the user has Analyzer enabled in an editor such as VS Code, you will get a player build error in Unity.

bug 
opened Apr 28, 2021 by mika-f 0
Open

URA9999: Method is currently broken in Udon for SDK3 Components

Analyzer Declaration

| Key | Value | | -------- | ------------------------------ | | Category | Udon | | Severity | Error |

Example

using UdonSharp;

namespace UdonRabbit
{
    public class TestBehaviour : UdonSharpBehaviour
    {

    }
}
enhancement 
opened Apr 6, 2021 by mika-f 0
Open

OmniSharp reports that Analyzer has timed out in a large Unity workspace (150+ U# files)

キャプチャ
bug 
opened Apr 6, 2021 by mika-f 0
Open

feat: support constructor validation

opened Apr 6, 2021 by mika-f 0
Open

UdonBehaviuor.gameObject is allowed from Udon

キャプチャ
bug 
opened Apr 6, 2021 by mika-f 0
Information
Category: .NET / Miscellaneous
Watchers: 1
Star: 16
Fork: 0
Last update: Apr 30, 2021

Contents
    Resource links
    https://github.com/mika-f/UdonRabbit.Analyzer
    Share this repo
    Most popular
    PowerShell PowerShell for every system!
    CodeHubApp CodeHub is an iOS application written using Xamarin
    CodeHubApp CodeHub is an iOS application written using Xamarin
    dotnet CoreFX is the foundational class libraries for .NET Core. It includes types for collections, file systems, console, JSON, XML, async and many others.
    dotnet-architecture Cross-platform .NET sample microservices and container based application that runs on Linux Windows and macOS. Powered by .NET Core 3.0, Docker Containers and Azure Kubernetes Services. Supports Visual Studio, VS for Mac and CLI based environments with Docker CLI, dotnet CLI, VS Code or any other code editor.
    quozd A collection of awesome .NET libraries, tools, frameworks and software
    Microsoft This repo is the official home of .NET on GitHub. It's a great starting point to find many .NET OSS projects from Microsoft and the community, including many that are part of the .NET Foundation.
    mono Mono open source ECMA CLI, C# and .NET implementation.
    App-vNext Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner. From version 6.0.1, Polly targets .NET Standard 1.1 and 2.0+.
    dotnet Documentation for ASP.NET Core

    Related Repos


    Miscellaneous
    104
    Provides the basic zk operation, but also additionally encapsulates the commonly used func...
    RabbitTeam Rabbit ZooKeeper Extensions The project uses the Apache ZooKeeper .NET async Client component, in addition to providing the basic zk operation, but also additional encapsulation of the commonly used functions in order to allow. N
     
    Miscellaneous
    502
    Jot is a library for persisting and applying .NET application state.
    anakic Jot - a .NET library for state persistence Introduction Almost every application needs to keep track of its own state, regardless of what it otherwise does. This typically includes: Sizes and locations of movable
     
    Miscellaneous
    1.2k
    Reduces eye strain by adjusting gamma based on the current time
    Tyrrrz LightBulb 💡 LightBulb is an application that reduces eyestrain produced by staring at a computer screen when working late hours. As the day goes on, it continuously adjusts gamma, transitioning the display color temp
     
    Miscellaneous
    281
    Grants the ability to set the Windows Taskbar to any opacity and colour desired.
    Elestriel TaskbarTools Grants the ability to set the Windows Taskbars to any opacity and colour desired. This will affect the Taskbars on every monitor/desktop, not only the primary. Feel free to branch and add features as you like!
     
    Popular
    Miscellaneous
    3.6k
    C# functional language extensions - a base class library for functional programming
    louthy C# Functional Programming Language Extensions This library uses and abuses the features of C# to provide a functional-programming 'base class library' that, if you squint, can look like extensions to the language itself. The
     
    Miscellaneous
    48
    Automated builds of .NET Core for Ubuntu on ARM
    stevedesmond-ca dotnet-arm Automated builds of .NET Core for Ubuntu 16.04 on ARM Notice There are official nightly builds of the .NET Core Runtime for ARM Linux available at https://github.com/dotnet/core-setup These scrip
     
    Miscellaneous
    397
    A service for automated crash-dump analysis
    Dynatrace SuperDump SuperDump is a service for automated Windows crash-dump analysis. SuperDump was made with these goals in mind: Make crash-dump analysis easy for people who are unexperienced with it, or don't have the necessary to
     
    Miscellaneous
    245
    Cosine gradient generator for Unity
    keijiro CosineGradient CosineGradient is a small package for generating cosine-based gradients in Unity. The idea of cosine-based gradients is based onan article written by Íñigo Quílez. See the original article for further deta