From ea6b8ecb6fb535004e7a3e8ce6ac7673665144b8 Mon Sep 17 00:00:00 2001 From: Raul Santos Date: Sat, 27 Aug 2022 03:14:27 +0200 Subject: [PATCH] Add `dotnet format` to CI to check C# style --- .github/workflows/static_checks.yml | 4 ++++ misc/scripts/dotnet_format.sh | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100755 misc/scripts/dotnet_format.sh diff --git a/.github/workflows/static_checks.yml b/.github/workflows/static_checks.yml index 557b67c9701..388c1ca9fd3 100644 --- a/.github/workflows/static_checks.yml +++ b/.github/workflows/static_checks.yml @@ -63,3 +63,7 @@ jobs: - name: Style checks via clang-format (clang_format.sh) run: | bash ./misc/scripts/clang_format.sh + + - name: Style checks via dotnet format (dotnet_format.sh) + run: | + bash ./misc/scripts/dotnet_format.sh diff --git a/misc/scripts/dotnet_format.sh b/misc/scripts/dotnet_format.sh new file mode 100755 index 00000000000..645737f4197 --- /dev/null +++ b/misc/scripts/dotnet_format.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash + +# This script runs dotnet format on all relevant files in the repo. +# This is the primary script responsible for fixing style violations in C# files. + +set -uo pipefail + +# Loops through all C# projects tracked by Git. +git ls-files -- '*.csproj' \ + ':!:.git/*' ':!:thirdparty/*' ':!:platform/android/java/lib/src/com/google/*' ':!:*-so_wrap.*' | +while read -r f; do + # Run dotnet format. + dotnet format "$f" +done + +diff=$(git diff --color) + +# If no diff has been generated all is OK, clean up, and exit. +if [ -z "$diff" ] ; then + printf "Files in this commit comply with the dotnet format style rules.\n" + exit 0 +fi + +# A diff has been created, notify the user, clean up, and exit. +printf "\n*** The following changes have been made to comply with the formatting rules:\n\n" +echo "$diff" +printf "\n*** Please fix your commit(s) with 'git commit --amend' or 'git rebase -i '\n" +exit 1