VRChat.UdonSharp.Linter 1.1.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet tool install --global VRChat.UdonSharp.Linter --version 1.1.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local VRChat.UdonSharp.Linter --version 1.1.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=VRChat.UdonSharp.Linter&version=1.1.2
                    


                    

                
nuke :add-package VRChat.UdonSharp.Linter --version 1.1.2

VRChat UdonSharp Linter

A static analyzer and linter for VRChat UdonSharp scripts that detects common errors and unsupported features at build time.

Installation

Install as a global .NET tool:

dotnet tool install -g VRChat.UdonSharp.Linter

Usage

# Lint all UdonSharp scripts in a directory
udonsharp-lint ./Assets/UdonSharp

# Exclude test scripts
udonsharp-lint ./Assets/UdonSharp --exclude-test-scripts

Features

Detects 20+ UdonSharp restrictions including:

  • Try/Catch/Finally statements
  • Throw statements
  • Local functions
  • Object/Collection initializers
  • Multidimensional arrays
  • Constructors
  • Generic methods/classes
  • Static fields (except const)
  • Nested types
  • Properties (except with FieldChangeCallback)
  • Method overloads
  • Interface implementations
  • Cross-file field access on custom serializable classes
  • Cross-file method invocations on custom serializable classes
  • TextMeshPro unexposed APIs (warnings)
  • Reflection, Threading, File I/O, and Network APIs
  • And more...

Error Codes

The linter uses error codes in the format UDONXXX:

  • UDON001: Try/Catch/Finally statements
  • UDON002: Throw statements
  • UDON003: Local functions
  • UDON005: Constructors
  • UDON006: Generic methods
  • UDON007: Object initializers
  • UDON008: Collection initializers
  • UDON009: Multidimensional arrays
  • UDON011: Static fields
  • UDON012: Nested types
  • UDON013: NetworkCallable method restrictions
  • UDON014: TextMeshPro API (warning)
  • UDON015: Properties
  • UDON016: Method overloads
  • UDON017: Interface implementation
  • UDON018: Generic classes
  • UDON019: Unexposed APIs
  • UDON020: Cross-file field access
  • UDON021: Static method field access
  • UDON022: Cross-file method invocation
  • UDON025: System.Serializable class usage

Exit Codes

  • 0: No errors found
  • 1: Errors detected or invalid usage

CI/CD Integration

GitHub Actions

- name: Install UdonSharp Linter
  run: dotnet tool install -g VRChat.UdonSharp.Linter

- name: Run Linter
  run: udonsharp-lint ./Assets/Scripts

License

MIT

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated