From f3730c78d29464531eb5c93fd891c013b7597f7e Mon Sep 17 00:00:00 2001 From: realmarv Date: Tue, 4 Apr 2023 13:39:57 +0330 Subject: [PATCH] scripts/styleChecker.fsx: add Add styleChecker.fsx script to check style of our F#, TS and YML codes. The `git respore package.json` command in the styleChecker.fsx script was failing with the following error, even when I was running the `git config --global --add safe.directory '*'` command in both the styleChecker.fsx script and in the CI. In the [1] issue, it's suggested by someone to use --system instead of --global in the mentioned command, when the git command is running in a container, which solved the problem. ``` fatal: detected dubious ownership in repository at '/__w/conventions/conventions' To add an exception for this directory, call: git config --global --add safe.directory /__w/conventions/conventions Error when running 'git restore package.json' Fsdk.Process+ProcessFailed: Exception of type 'Fsdk.Process+ProcessFailed' was thrown. at Fsdk.Process.ProcessResult.Unwrap(String errMsg) at Fsdk.Process.ProcessResult.UnwrapDefault() at FSI_0002.RunPrettier(String arguments) at .$FSI_0002.main@() Stopped due to error Error: Process completed with exit code 1. ``` [1] https://github.com/actions/checkout/issues/1048 --- .github/workflows/CI.yml | 2 +- scripts/styleChecker.fsx | 99 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 scripts/styleChecker.fsx diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 28af6800c..48b4e5413 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -112,7 +112,7 @@ jobs: fetch-depth: 0 # workaround for https://github.com/actions/runner/issues/2033 - name: ownership workaround - run: git config --global --add safe.directory '*' + run: git config --system --add safe.directory '*' - name: Print versions run: | git --version diff --git a/scripts/styleChecker.fsx b/scripts/styleChecker.fsx new file mode 100644 index 000000000..f5cd81e0b --- /dev/null +++ b/scripts/styleChecker.fsx @@ -0,0 +1,99 @@ +#!/usr/bin/env -S dotnet fsi + +#r "nuget: Fsdk, Version=0.6.0--date20230326-0544.git-5c4f55b" + +open Fsdk +open Fsdk.Process + +let StyleFSharpFiles() = + Process + .Execute( + { + Command = "dotnet" + Arguments = "new tool-manifest --force" + }, + Process.Echo.Off + ) + .UnwrapDefault() + |> ignore + + Process + .Execute( + { + Command = "dotnet" + Arguments = + "tool install fantomless-tool --version 4.7.997-prerelease" + }, + Process.Echo.Off + ) + .UnwrapDefault() + |> ignore + + Process + .Execute( + { + Command = "dotnet" + Arguments = "fantomless --recurse ." + }, + Process.Echo.Off + ) + .UnwrapDefault() + |> ignore + +let RunPrettier(arguments: string) = + let processResult = + Process + .Execute( + { + Command = "npx" + Arguments = $"prettier {arguments}" + }, + Process.Echo.All + ) + .Result + + match processResult with + | ProcessResultState.Success output -> output + | ProcessResultState.WarningsOrAmbiguous output -> output.StdErr + | ProcessResultState.Error(exitCode, output) -> + failwith( + sprintf + "Finished with an error of exitcode %i: %s" + exitCode + output.StdErr + ) + |> printfn "%A" + + // Since after installing commitlint dependencies package.json file changes, we need to + // run the following command to ignore package.json file + Process + .Execute( + { + Command = "git" + Arguments = "restore package.json" + }, + Process.Echo.Off + ) + .UnwrapDefault() + |> ignore + +let StyleTypeScriptFiles() = + RunPrettier "--quote-props=consistent --write ./**/*.ts" + +let StyleYmlFiles() = + RunPrettier "--quote-props=consistent --write ./**/*.yml" + +StyleFSharpFiles() +StyleTypeScriptFiles() +StyleYmlFiles() + +Process + .Execute( + { + Command = "git" + Arguments = "diff --exit-code" + }, + Process.Echo.Off + ) + .UnwrapDefault() +|> ignore