FileConventions: use BetterAssert() & update Fsdk

We updated fsdk to the latest version becuase the old version of fsdk does not have `Misc.BetterAssert` and we use `Misc.BetterAssert()` becuase assert is for debug mode.
tehraninasab · Aug 21, 2023 · 81bfb57 · 81bfb57
1 parent 21f3749
commit 81bfb57
Show file tree

Hide file tree

Showing 18 changed files with 36 additions and 15 deletions.
diff --git a/scripts/checkCommits1by1.fsx b/scripts/checkCommits1by1.fsx
@@ -9,7 +9,7 @@ open System.Net.Http.Headers
 #r "nuget: FSharp.Data, Version=5.0.2"
 open FSharp.Data
 
-#r "nuget: Fsdk, Version=0.6.0--date20230214-0422.git-1ea6f62"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 open Fsdk
 open Fsdk.Process

diff --git a/scripts/compileFSharpScripts.fsx b/scripts/compileFSharpScripts.fsx
@@ -3,7 +3,7 @@
 open System
 open System.IO
 
-#r "nuget: Fsdk, Version=0.6.0--date20230214-0422.git-1ea6f62"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 #load "../src/FileConventions/Helpers.fs"
 
 Fsdk

diff --git a/scripts/eofConvention.fsx b/scripts/eofConvention.fsx
@@ -4,6 +4,7 @@ open System.IO
 open System
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Helpers.fs"
 #load "../src/FileConventions/Library.fs"

diff --git a/scripts/executableConvention.fsx b/scripts/executableConvention.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"
 

diff --git a/scripts/gitPush1by1.fsx b/scripts/gitPush1by1.fsx
@@ -8,7 +8,7 @@ open System.Threading
 #r "System.Configuration"
 open System.Configuration
 
-#r "nuget: Fsdk, Version=0.6.0--date20230214-0422.git-1ea6f62"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 open Fsdk
 open Fsdk.Process

diff --git a/scripts/inconsistentVersionsInFSharpScripts.fsx b/scripts/inconsistentVersionsInFSharpScripts.fsx
@@ -4,6 +4,7 @@ open System.IO
 open System.Linq
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/inconsistentVersionsInGitHubCI.fsx b/scripts/inconsistentVersionsInGitHubCI.fsx
@@ -3,6 +3,7 @@
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/mixedLineEndings.fsx b/scripts/mixedLineEndings.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx b/scripts/nonVerboseFlagsInGitHubCIAndScripts.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/shebangConvention.fsx b/scripts/shebangConvention.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/unpinnedDotnetPackageVersions.fsx b/scripts/unpinnedDotnetPackageVersions.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/unpinnedDotnetToolInstallVersions.fsx b/scripts/unpinnedDotnetToolInstallVersions.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/unpinnedGitHubActionsImageVersions.fsx b/scripts/unpinnedGitHubActionsImageVersions.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/unpinnedNugetPackageReferenceVersions.fsx b/scripts/unpinnedNugetPackageReferenceVersions.fsx
@@ -4,6 +4,7 @@ open System
 open System.IO
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 #load "../src/FileConventions/Helpers.fs"

diff --git a/scripts/wrapLatestCommitMsg.fsx b/scripts/wrapLatestCommitMsg.fsx
@@ -5,11 +5,10 @@ open System
 open System.Text.RegularExpressions
 
 #r "nuget: Mono.Unix, Version=7.1.0-final.1.21458.1"
+#r "nuget: Fsdk, Version=0.6.0--date20230821-0702.git-5488853"
 
 #load "../src/FileConventions/Library.fs"
 
-#r "nuget: Fsdk, Version=0.6.0--date20230214-0422.git-1ea6f62"
-
 open Fsdk
 open Fsdk.Process
 

diff --git a/src/FileConventions.Test/FileConventions.Test.fsproj b/src/FileConventions.Test/FileConventions.Test.fsproj
@@ -19,7 +19,7 @@
     <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
     <PackageReference Include="NUnit.Analyzers" Version="3.3.0" />
     <PackageReference Include="coverlet.collector" Version="3.1.2" />
-    <PackageReference Include="Fsdk" Version="0.6.0--date20230214-0422.git-1ea6f62" />
+		<PackageReference Include="Fsdk" Version="0.6.0--date20230821-0702.git-5488853" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/FileConventions/FileConventions.fsproj b/src/FileConventions/FileConventions.fsproj
@@ -13,6 +13,7 @@
   <ItemGroup>
     <PackageReference Include="Mono.Posix" Version="7.1.0-final.1.21458.1" />
     <PackageReference Include="Mono.Unix" Version="7.1.0-final.1.21458.1" />
+		<PackageReference Include="Fsdk" Version="0.6.0--date20230821-0702.git-5488853" />
   </ItemGroup>
 
 </Project>
diff --git a/src/FileConventions/Library.fs b/src/FileConventions/Library.fs
@@ -7,6 +7,11 @@ open System.Text.RegularExpressions
 
 open Mono
 open Mono.Unix.Native
+open Fsdk
+
+let ymlAssertionError = "Bug: file should be a .yml file"
+let projAssertionError = "Bug: file should be a proj file"
+let fsxAssertionError = "Bug: file was not a F#/C# source file"
 
 let HasCorrectShebang(fileInfo: FileInfo) =
     let fileText = File.ReadLines fileInfo.FullName
@@ -42,7 +47,7 @@ let MixedLineEndings(fileInfo: FileInfo) =
     numberOfLineEndings > 1
 
 let DetectUnpinnedVersionsInGitHubCI(fileInfo: FileInfo) =
-    assert (fileInfo.FullName.EndsWith(".yml"))
+    Misc.BetterAssert (fileInfo.FullName.EndsWith ".yml") ymlAssertionError
 
     let fileText = File.ReadAllText fileInfo.FullName
 
@@ -52,7 +57,7 @@ let DetectUnpinnedVersionsInGitHubCI(fileInfo: FileInfo) =
     latestTagInRunsOnRegex.IsMatch fileText
 
 let DetectUnpinnedDotnetToolInstallVersions(fileInfo: FileInfo) =
-    assert (fileInfo.FullName.EndsWith(".yml"))
+    Misc.BetterAssert (fileInfo.FullName.EndsWith ".yml") ymlAssertionError
 
     let fileLines = File.ReadLines fileInfo.FullName
 
@@ -70,7 +75,7 @@ let DetectUnpinnedDotnetToolInstallVersions(fileInfo: FileInfo) =
     unpinnedDotnetToolInstallVersions
 
 let DetectAsteriskInPackageReferenceItems(fileInfo: FileInfo) =
-    assert (fileInfo.FullName.EndsWith "proj")
+    Misc.BetterAssert (fileInfo.FullName.EndsWith "proj") projAssertionError
 
     let fileText = File.ReadAllText fileInfo.FullName
 
@@ -83,7 +88,7 @@ let DetectAsteriskInPackageReferenceItems(fileInfo: FileInfo) =
     asteriskInPackageReference.IsMatch fileText
 
 let DetectMissingVersionsInNugetPackageReferences(fileInfo: FileInfo) =
-    assert (fileInfo.FullName.EndsWith ".fsx")
+    Misc.BetterAssert (fileInfo.FullName.EndsWith ".fsx") fsxAssertionError
 
     let fileLines = File.ReadLines fileInfo.FullName
 
@@ -284,7 +289,9 @@ let private DetectInconsistentVersions
 
 let DetectInconsistentVersionsInGitHubCIWorkflow(fileInfos: seq<FileInfo>) =
     fileInfos
-    |> Seq.iter(fun fileInfo -> assert (fileInfo.FullName.EndsWith ".yml"))
+    |> Seq.iter(fun fileInfo ->
+        Misc.BetterAssert (fileInfo.FullName.EndsWith ".yml") ymlAssertionError
+    )
 
     let inconsistentVersionsType1 =
         DetectInconsistentVersions
@@ -310,7 +317,9 @@ let DetectInconsistentVersionsInNugetRefsInFSharpScripts
     (fileInfos: seq<FileInfo>)
     =
     fileInfos
-    |> Seq.iter(fun fileInfo -> assert (fileInfo.FullName.EndsWith ".fsx"))
+    |> Seq.iter(fun fileInfo ->
+        Misc.BetterAssert (fileInfo.FullName.EndsWith ".fsx") fsxAssertionError
+    )
 
     DetectInconsistentVersions
         fileInfos
@@ -397,7 +406,7 @@ let DefiningEmptyStringsWithDoubleQuotes(fileInfo: FileInfo) =
 
 let ProjFilesNamingConvention(fileInfo: FileInfo) =
     let regex = new Regex("(.*)\..*proj$")
-    assert (regex.IsMatch fileInfo.FullName)
+    Misc.BetterAssert (regex.IsMatch fileInfo.FullName) projAssertionError
     let fileName = Path.GetFileNameWithoutExtension fileInfo.FullName
 
     let parentDirectoryName =
@@ -423,8 +432,9 @@ let DoesNamespaceInclude (fileInfo: FileInfo) (word: string) =
         false
 
 let NotFollowingNamespaceConvention(fileInfo: FileInfo) =
-    assert
-        (fileInfo.FullName.EndsWith(".fs") || fileInfo.FullName.EndsWith(".cs"))
+    Misc.BetterAssert
+        (fileInfo.FullName.EndsWith ".fs" || fileInfo.FullName.EndsWith ".cs")
+        fsxAssertionError
 
     let fileName = Path.GetFileNameWithoutExtension fileInfo.FullName
     let parentDir = Path.GetDirectoryName fileInfo.FullName |> DirectoryInfo