esnya/udonrabbit.analyzer

DEPRECATED (U#1.0 not supported) .NET Roslyn Analyzer for VRChat Udon and UdonSharp.

udonrabbit.analyzer's Issues

URA0028: UdonSharp does not yet support user defined enums

URA0009: Base type calling is not yet supported by UdonSharp

False Positive for Inner Classes

Describe the bug
Inner classes such as VRCPlayerApi.TrackingData could not detected by UdonSymbols.

To Reproduce
Steps to reproduce the behavior:

1. See TrackingDataFollower in UdonSharp Samples

Expected behavior
No marked as error

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.

URA0046: Udon does not support smooth interpolation of the synced type '{0}'

Analyzer Declaration

Key	Value
Category	Udon
Severity	Error

Example

using UdonSharp;

using VRC.SDK.SDKBase;

namespace UdonRabbit
{
    public class TestBehaviour : UdonSharpBehaviour
    {
        [UdonSynced(UdonSyncMode.Smooth)]
        private VRCUrl _url; // URA0046
    }
}

URA0008: User property declarations are not yet supported by UdonSharp

URA0016: Udon does not support the 'Awake' event, use 'Start' instead

URA0007: UdonSharp does not currently support constructors on UdonSharpBehaviours, use the Start()

URA0012: UdonSharp does not support throwing exceptions since Udon does not have support for exception throwing at the moment

URA0037: UdonSharp does not yet support goto

Report malicious reports to RequestSerialization and other UdonBehaviour Methods

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.

URA0038: UdonSharp does not yet support labeled statements

URA0025: Static fields are not yet supported by UdonSharp

URA0022: UdonSharp does not currently support type checking with the `is` keyword since Udon does not yet expose the proper functionality for type checking

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

URA0015: UdonSharp does not currently support null conditional operators

URA0010: Default expressions are not yet supported by UdonSharp

URA0017: UdonSharp does not yet support 'out' parameters on user-defined methods.

Report malicious reports to int.TryParse(str, out int)

Describe the bug
Report malicious reports to int.TryParse(str, out int)

To Reproduce
Steps to reproduce the behavior:
Type int.TryParse.

Expected behavior
This function is exposed to Udon. No diagnostic report.

Screenshots

URA0021: The `as` keyword is not yet supported by UdonSharp since Udon does not expose what is necessary

URA0030: UdonSharp does not yet support static using directives

URA0014: UdonSharp does not support multidimensional array accesses yet

URA0001: Method `GetComponent<T>` is not exposed to Udon

Describe the bug
GetComponent<T> is already exposed to Udon

To Reproduce

class TestBehaviour : UdonSharpBehaviour
{
	[SerializeField]
	private GameObject _go;

    private void Start()
	{
		var t1 = GetComponent<Transform>();
        var t2 = _go.GetComponent<Transform>();
	}
}

Expected behavior
No mark as error

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.

URA0036: Syncing of array type '{0}[]' is only supported in manual sync mode

`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.

Analyzer is broken on latest VRCSDK3

Describe the bug
The analyzer is could not be started when the user using the latest VRCSDK3.

To Reproduce
Steps to reproduce the behavior:

1. Import VRCSDK3-WORLD-2021.03.22.18.27 to Unity
2. Start the Analyzer

Expected behavior
The analyzer has been started.

Screenshots
No

Environment (please complete the following information):

• OS: Windows 10
• Analyzer Version: v0.6.0
• Unity Version: 2018.4.20f1
• VRCSDK Version: 2021.03.22.18.27
• UdonSharp Version: v0.19.8
• Editor Version: All

Additional context
Add any other context about the problem here.

URA0027: Udon does not support method parameters of type '{0}' yet

URA0039: Object initializers are not yet supported by UdonSharp

URA0034: Udon does not support linear interpolation of the synced type '{0}'

URA0040: Nullable types are not currently supported by UdonSharp

URA0029: UdonSharp does not currently support using `typeof` on user defined types

URA0011: Try/Catch/Finally is not supported by UdonSharp since Udon does not have a way to handle exceptions

URA0005: UdonSharp does not yet support inheriting from interfaces

URA0024: UdonSharp custom methods currently do not support default arguments or params arguments

URA0026: Udon does not support return values of type '{0}' yet

URA0032: Udon does not support variables of type '{0}' yet

Automatic Release When Tagging

URA0033: Udon does not currently support syncing of the type '{0}'

URA0013: UdonSharp does not support multidimensional arrays at the moment, use jagged arrays instead for now

Add Tests

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.

URA0019: UdonSharp does not yet support 'ref' parameters on user-defined methods.

URA0035: Udon does not support variable tweening when the behaviour is in Manual sync mode

Report malicious reports to NetworkEventTarget.All

URA0041: The method called by SendCustomNetworkEvent must be public

Analyzer Declaration

Key	Value
Category	Udon
Severity	Warning

Examples

using UdonSharp;

using VRC.Udon.Common.Interfaces;

namespace UdonRabbit
{
    public class TestBehaviour : UdonSharpBehaviour
	{
		public override void Interact()
		{
			SendCustomNetworkEvent(NetworkEventTarget.All, nameof(OnInteract));
		}

        private void OnInteract() // URA0041
		{
		}
	}
}

URA0006: UdonSharp does not yet support inheriting from classes other than 'UdonSharpBehaviour'

URA0018: UdonSharp does not yet support 'in' parameters on user-defined methods.

URA0031: UdonSharp does not yet support namespace alias directives

URA0020: The `is` keyword is not yet supported by UdonSharp since Udon does not expose what is necessary

Installation Guide for JetBrains Rider

I published the NuGet package to GitHub Package Registry.
But I don't know how to use GitHub Package Registry in JetBrains Rider.
I want Rider users to help.