com.unity.multiplayer.mlapi/dotnet-tools
Fatih Mar 5de83b38fd
chore: `.gitattributes` line endings config & renormalize (#2457)
2023-03-16 12:17:53 +03:00
..
netcode.standards chore: `.gitattributes` line endings config & renormalize (#2457) 2023-03-16 12:17:53 +03:00
.gitignore chore: `.gitattributes` line endings config & renormalize (#2457) 2023-03-16 12:17:53 +03:00
README.md ci: dotnet-based `netcode.standards` to replace python-based `./standards.py` (backport) (#1753) 2022-02-25 15:34:12 +00:00

README.md

.NET Tools for Unity Netcode

Netcode.Standards

C# coding standards tool for Netcode that relies on .editorconfig ruleset and dotnet format tool

How to Install & Uninstall

Build (Pack)

dotnet pack dotnet-tools/netcode.standards

Install

dotnet tool install --global --add-source ./dotnet-tools/netcode.standards netcode.standards

Check

netcode.standards --help

Uninstall

dotnet tool uninstall --global netcode.standards

How to Use

Commands

Check

# check for standards issues without touching files
netcode.standards --check

Fix

# try to fix standards issues and save file changes
netcode.standards --fix

Options

Specifying at least one of --check or --fix is required.

However, you can also specify other options to configure the tool.

Option Description
--project <project> Target project folder [default: testproject]
--pattern <pattern> Search pattern string [default: *.sln]
--verbosity <verbosity> Logs verbosity level [default: normal]
-?, -h, --help Show help and usage information