FileConventions: refactor

nblockchain · Jul 6, 2023 · be256d4 · be256d4
1 parent 61d4b00
commit be256d4
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx b/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx
@@ -22,7 +22,7 @@ let invalidFiles =
         Helpers.GetInvalidFiles
             rootDir
             ("*" + ext)
-            FileConventions.NonVerboseFlagsInGitHubCI
+            FileConventions.NonVerboseFlags
     )
     |> Seq.concat
 

diff --git a/src/FileConventions.Test/FileConventions.Test.fs b/src/FileConventions.Test/FileConventions.Test.fs
@@ -559,7 +559,7 @@ let NonVerboseFlagsInGitHubCI1() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo true)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo true)
 
 
 [<Test>]
@@ -572,7 +572,7 @@ let NonVerboseFlagsInGitHubCI2() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo false)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo false)
 
 
 [<Test>]
@@ -585,7 +585,7 @@ let NonVerboseFlagsInGitHubCI3() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo false)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo false)
 
 
 [<Test>]
@@ -598,7 +598,7 @@ let NonVerboseFlagsInGitHubCI4() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo true)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo true)
 
 
 [<Test>]
@@ -611,7 +611,7 @@ let NonVerboseFlagsInGitHubCI5() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo false)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo false)
 
 
 [<Test>]
@@ -624,4 +624,4 @@ let NonVerboseFlagsInGitHubCI6() =
             )
         ))
 
-    Assert.That(NonVerboseFlagsInGitHubCI fileInfo, Is.EqualTo false)
+    Assert.That(NonVerboseFlags fileInfo, Is.EqualTo false)
diff --git a/src/FileConventions/Library.fs b/src/FileConventions/Library.fs
@@ -339,7 +339,7 @@ let allowedNonVerboseFlags =
         "env -S"
     }
 
-let NonVerboseFlagsInGitHubCI(fileInfo: FileInfo) =
+let NonVerboseFlags(fileInfo: FileInfo) =
     let validExtensions =
         seq {
             ".yml"
@@ -348,12 +348,18 @@ let NonVerboseFlagsInGitHubCI(fileInfo: FileInfo) =
             ".sh"
         }
 
-    assert
+    let isFileExtentionValid =
         validExtensions
-        |> Seq.map(fun ext -> fileInfo.FullName.EndsWith(ext))
+        |> Seq.map(fun ext -> fileInfo.FullName.EndsWith ext)
         |> Seq.contains true
 
-    let fileLines = File.ReadLines(fileInfo.FullName)
+    if not isFileExtentionValid then
+        let sep = ","
+
+        failwith
+            $"NonVerboseFlags function only supports {String.concat sep validExtensions} files."
+
+    let fileLines = File.ReadLines fileInfo.FullName
 
     let nonVerboseFlagsRegex = Regex("\\s-[a-zA-Z]\\b", RegexOptions.Compiled)
 
@@ -367,7 +373,7 @@ let NonVerboseFlagsInGitHubCI(fileInfo: FileInfo) =
                 |> Seq.map(fun allowedFlag -> line.Contains allowedFlag)
                 |> Seq.contains true
 
-            nonVerboseFlag && not(allowedNonVerboseFlag)
+            nonVerboseFlag && not allowedNonVerboseFlag
         )
         |> Seq.length