Skip to content

Latest commit

 

History

History
48 lines (40 loc) · 2.66 KB

README.md

File metadata and controls

48 lines (40 loc) · 2.66 KB
Raw

S&box Analyzers

A collection of Roslyn analyzers for analyzing code used in S&box.

Features

  • SB9001: Code accesslist checking.
    • S&box uses a code accesslist system, the analyzer can check your code to make sure you are not using anything that would breach it. Code accesslist showcase
  • SB9002-SB9008 Networked property analyzing.
    • SB9002: Warning of LocalAttributes lack of implementation (#2169)
    • SB9003: Error for not implementing the change method callback defined in a ChangeAttribute.
    • SB9004: Error for having an incorrect number of parameters for a change method callback.
    • SB9005: Error for having an incorrect type in the parameters for a change method callback.
    • SB9006: Error for having the static keyword on a networked property.
    • SB9007: Error for having a non-networkable type on a networked property.
    • SB9008: Error for having a networked property that is not auto-implemented ({ get; set; }). Networked property showcase
  • SB9009-SB9011 Event listener analysis.
    • SB9009: Error for having an incorrect event listener parameter count.
    • SB9010: Error for having an incorrect event listener parameter type.
    • SB9011: Warning for using an event that has parameters with no MethodArgumentsAttribute.
  • SB9012: Server command parameter type is unsupported.
  • SB9013: BaseNetworkable derived type has no parameterless constructor.

Installation

You can get the analyzer on NuGet, GitHub, and Visual Studio Marketplace.

If installing through NuGet, you can add the following to your csproj file:

<PackageReference Include="SboxAnalyzers" Version="1.0.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

If installing through the DLL, you can add the following to your csproj file:

<Analyzer Include="path\to\the\analyzer.dll" />

License

Distributed under the MIT License. See the license for more information.

Contributing

Contributions are very much welcomed! When making your pull request please make sure your code is neatly formatted and passes all tests.

Known Issues

  • There are bound to be false positives that come up. If you experience one, please submit an issue so that it can be looked into!