From 1d801bf19b94246937246272cb528f206c18f64a 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 issue [1], 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 | 27 +--- scripts/styleChecker.fsx | 263 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 266 insertions(+), 24 deletions(-) create mode 100644 scripts/styleChecker.fsx diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index efd23b7f3..f51da3ab5 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 @@ -144,26 +144,5 @@ jobs: - name: Check if gitPush1by1 was used if: github.event_name == 'pull_request' run: dotnet fsi scripts/detectNotUsingGitPush1by1.fsx - - name: Install prettier - run: npm install prettier@2.8.3 - - name: Change file permissions - # We need this step so we can change the files using `npx prettier --write` in the next step. - # Otherwise we get permission denied error in the CI. - run: sudo chmod 777 -R . - - name: Run "prettier" to check the style of our TypeScript and YML code - run: | - sudo npx prettier --quote-props=consistent --write './**/*.ts' - sudo npx prettier --quote-props=consistent --write './**/*.yml' - # Since we changed file modes in the previous step we need the following command to - # make git ignore mode changes in files and doesn't include them in the git diff command. - git config core.fileMode false - # Since after installing commitlint dependencies package.json file changes, we need to - # run the following command to ignore package.json file - git restore package.json - git diff --exit-code - - name: fantomless - run: | - dotnet new tool-manifest - dotnet tool install fantomless-tool --version 4.7.997-prerelease - dotnet fantomless --recurse . - git diff --exit-code + - name: Check style of our F#, TypeScript and YML code + run: sudo dotnet fsi scripts/styleChecker.fsx diff --git a/scripts/styleChecker.fsx b/scripts/styleChecker.fsx new file mode 100644 index 000000000..f233f81ef --- /dev/null +++ b/scripts/styleChecker.fsx @@ -0,0 +1,263 @@ +#!/usr/bin/env -S dotnet fsi + +#r "nuget: Fsdk, Version=0.6.0--date20230326-0544.git-5c4f55b" +#load "../src/FileConventions/Helpers.fs" + +open System +open System.IO + +open Fsdk +open Fsdk.Process + +open Helpers + +let fantomlessToolVersion = "4.7.997-prerelease" +let prettierVersion = "2.8.3" + +let StyleFSharpFiles() = + Process + .Execute( + { + Command = "dotnet" + Arguments = "new tool-manifest --force" + }, + Echo.Off + ) + .UnwrapDefault() + |> ignore + + Process + .Execute( + { + Command = "dotnet" + Arguments = + $"tool install fantomless-tool --version {fantomlessToolVersion}" + }, + Echo.Off + ) + .UnwrapDefault() + |> ignore + + Process + .Execute( + { + Command = "dotnet" + Arguments = "fantomless --recurse ." + }, + Echo.Off + ) + .UnwrapDefault() + |> ignore + +let RunPrettier(arguments: string) = + + // We need this step so we can change the files using `npx prettier --write` in the next step. + // Otherwise we get permission denied error in the CI. + Process.Execute( + { + Command = "chmod" + Arguments = "777 -R ." + }, + Echo.Off + ) + |> ignore + + let processResult = + Process.Execute( + { + Command = "npx" + Arguments = $"prettier {arguments}" + }, + Echo.Off + ) + + let errMsg = + sprintf + "Error when running '%s %s'" + processResult.Details.Command + processResult.Details.Args + + match processResult.Result with + | Success output -> Console.WriteLine output + | Error(_, output) -> + if processResult.Details.Echo = Echo.Off then + output.PrintToConsole() + Console.WriteLine() + Console.Out.Flush() + + Console.Error.WriteLine errMsg + raise <| ProcessFailed errMsg + | WarningsOrAmbiguous output -> + if processResult.Details.Echo = Echo.Off then + output.PrintToConsole() + Console.WriteLine() + Console.Out.Flush() + + let fullErrMsg = sprintf "%s (with warnings?)" errMsg + Console.Error.WriteLine fullErrMsg + + // 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" + }, + Echo.Off + ) + .UnwrapDefault() + |> ignore + +let StyleTypeScriptFiles() = + RunPrettier "--quote-props=consistent --write ./**/*.ts" + +let StyleYmlFiles() = + RunPrettier "--quote-props=consistent --write ./**/*.yml" + +let ContainsFiles (rootDir: DirectoryInfo) (searchPattern: string) = + Helpers.GetFiles rootDir searchPattern |> Seq.length > 0 + +let GitDiff() : ProcessResult = + + // Since we changed file modes in the prettier step we need the following command to + // make git ignore mode changes in files and doesn't include them in the git diff command. + Process.Execute( + { + Command = "git" + Arguments = "config core.fileMode false" + }, + Echo.Off + ) + |> ignore + + let processResult = + Process.Execute( + { + Command = "git" + Arguments = "diff --exit-code" + }, + Echo.Off + ) + + processResult + +let GitRestore() = + Process.Execute( + { + Command = "git" + Arguments = "restore ." + }, + Echo.Off + ) + |> ignore + +let InstallPrettier(version: string) = + Process.Execute( + { + Command = "npm" + Arguments = $"install prettier@{version}" + }, + Echo.Off + ) + |> ignore + +let PrintProcessResult (processResult: ProcessResult) (suggestion: string) = + let errMsg = + sprintf + "Error when running '%s %s'" + processResult.Details.Command + processResult.Details.Args + + match processResult.Result with + | Success output -> Console.WriteLine output + | Error(_, output) -> + if processResult.Details.Echo = Echo.Off then + output.PrintToConsole() + Console.WriteLine() + Console.Out.Flush() + + let fullErrMsg = errMsg + Environment.NewLine + suggestion + Console.Error.WriteLine fullErrMsg + + | WarningsOrAmbiguous output -> + if processResult.Details.Echo = Echo.Off then + output.PrintToConsole() + Console.WriteLine() + Console.Out.Flush() + + let fullErrMsg = sprintf "%s (with warnings?)" errMsg + Console.Error.WriteLine fullErrMsg + +let GetProcessExitCode(processResult: ProcessResult) : int = + match processResult.Result with + | Success output -> 0 + | _ -> 1 + +let CheckStyleOfFSharpFiles(rootDir: DirectoryInfo) : int = + let suggestion = + "Please style your F# code using: `dotnet fantomless --recurse .`" + + GitRestore() + + let exitCode = + if ContainsFiles rootDir "*.fs" || ContainsFiles rootDir ".fsx" then + StyleFSharpFiles() + let processResult = GitDiff() + PrintProcessResult processResult suggestion + GetProcessExitCode processResult + + else + 0 + + exitCode + +let CheckStyleOfTypeScriptFiles(rootDir: DirectoryInfo) : int = + let suggestion = + "Please style your TypeScript code using: `npx prettier --quote-props=consistent --write ./**/*.ts`" + + GitRestore() + + let exitCode = + if ContainsFiles rootDir "*.ts" then + InstallPrettier(prettierVersion) + StyleTypeScriptFiles() + let processResult = GitDiff() + PrintProcessResult processResult suggestion + GetProcessExitCode processResult + + else + 0 + + exitCode + +let CheckStyleOfYmlFiles(rootDir: DirectoryInfo) : int = + let suggestion = + "Please style your YML code using: `npx prettier --quote-props=consistent --write ./**/*.yml`" + + GitRestore() + + let exitCode = + if ContainsFiles rootDir "*.yml" then + InstallPrettier(prettierVersion) + StyleYmlFiles() + let processResult = GitDiff() + PrintProcessResult processResult suggestion + GetProcessExitCode processResult + else + 0 + + exitCode + + +let rootDir = Path.Combine(__SOURCE_DIRECTORY__, "..") |> DirectoryInfo + +let exitCodes = + [| + CheckStyleOfFSharpFiles rootDir + CheckStyleOfTypeScriptFiles rootDir + CheckStyleOfYmlFiles rootDir + |] + +if exitCodes |> Seq.contains 1 then + Environment.Exit 1