Merge PR #756 from webwarrior-ws/wip/RunOnItself

Enable more rules for SelfCheck, not just the ones enabled
by default.

Author: knocte

.git-blame-ignore-revs

@@ -3,4 +3,10 @@
 # that they are unlikely to be what you are interested in when blaming.
 # Like formatting with Fantomas
 # https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view
-# Add formatting commits here
+
+# Console,Core,Tests: fix FSharpLint warning (Fixing the warning for AvoidTooShortNames rule.)
+e9410e83af1de4d76230b0e8d44ae6a99fac6d7b
+
+# Core: rename some funcs and params
+628b1786e7f913ecd87e42a45ab7f195c536a6cb
+

build.fsx

@@ -39,6 +39,7 @@ open Fake.Api
 
 open System
 open System.IO
+open System.Text.Json.Nodes
 
 Target.initEnvironment()
 
@@ -249,12 +250,64 @@ Target.create "Push" (fun _ ->
 
 
 Target.create "SelfCheck" (fun _ ->
-    let srcDir = Path.Combine(rootDir.FullName, "src") |> DirectoryInfo
-
-    let consoleProj = Path.Combine(srcDir.FullName, "FSharpLint.Console", "FSharpLint.Console.fsproj") |> FileInfo
-    let sol = Path.Combine(rootDir.FullName, solutionFileName) |> FileInfo
-    exec "dotnet" $"run --framework net9.0 lint %s{sol.FullName}" consoleProj.Directory.FullName
-)
+    let runLinter () =
+        let srcDir = Path.Combine(rootDir.FullName, "src") |> DirectoryInfo
+
+        let consoleProj = Path.Combine(srcDir.FullName, "FSharpLint.Console", "FSharpLint.Console.fsproj") |> FileInfo
+        let sol = Path.Combine(rootDir.FullName, solutionFileName) |> FileInfo
+
+        exec "dotnet" $"run --framework net9.0 lint %s{sol.FullName}" consoleProj.Directory.FullName
+
+    printfn "Running self-check with default rules..."
+    runLinter ()
+
+    let fsharplintJsonDir = Path.Combine("src", "FSharpLint.Core", "fsharplint.json")
+    let fsharplintJsonText = File.ReadAllText fsharplintJsonDir
+
+    let excludedRules =
+        [
+            // Formatting rules (maybe mark them as DEPRECATED soon, recommending the use of `fantomas` instead)
+            "typedItemSpacing"
+            "unionDefinitionIndentation"
+            "moduleDeclSpacing"
+            "classMemberSpacing"
+            "tupleCommaSpacing"
+            "tupleIndentation"
+            "patternMatchClausesOnNewLine"
+            "patternMatchOrClausesOnNewLine"
+            "patternMatchClauseIndentation"
+            "patternMatchExpressionIndentation"
+            "indentation"
+            "maxCharactersOnLine"
+            "trailingNewLineInFile"
+            "trailingWhitespaceOnLine"
+
+            // TODO: we should enable at some point
+            "typePrefixing"
+            "unnestedFunctionNames"
+            "nestedFunctionNames"
+            "nestedStatements"
+
+            // Running NoPartialFunctions on this file causes a bug in FSharp.Compiler, so skip it for now
+            "noPartialFunctions"
+
+            // rule is too complex, we can enable it later
+            "cyclomaticComplexity"
+        ]
+
+    let jsonObj = JsonObject.Parse fsharplintJsonText
+
+    for pair in jsonObj.AsObject() do
+        if pair.Value.GetValueKind() = Text.Json.JsonValueKind.Object then
+            match pair.Value.AsObject().TryGetPropertyValue("enabled") with
+            | true, isRule when not (List.contains pair.Key excludedRules) ->
+                isRule.AsValue().ReplaceWith true
+            | _ -> ()
+
+    File.WriteAllText(fsharplintJsonDir, jsonObj.ToJsonString())
+
+    printfn "Now re-running self-check with more rules enabled..."
+    runLinter ())
 
 // --------------------------------------------------------------------------------------
 // Build order

src/FSharpLint.Console/Output.fs

@@ -23,7 +23,7 @@ type StandardOutput () =
             if String.length errorLine = 0 then "^"
             else
                 errorLine
-                |> Seq.mapi (fun i _ -> if i = range.StartColumn then "^" else " ")
+                |> Seq.mapi (fun index _ -> if index = range.StartColumn then "^" else " ")
                 |> Seq.reduce (+)
         $"{getErrorMessage range}{Environment.NewLine}{errorLine}{Environment.NewLine}{highlightColumnLine}"
 
@@ -59,5 +59,4 @@ type MSBuildOutput () =
                 <| warning.RuleIdentifier
                 <| warning.Details.Message
         member _.WriteError (error:string) =
-            $"FSharpLint error: {error}"
-            |> Console.Error.WriteLine
+            Console.Error.WriteLine $"FSharpLint error: {error}"

src/FSharpLint.Console/Program.fs

@@ -56,8 +56,8 @@ let private parserProgress (output:Output.IOutput) = function
         String.Format(Resources.GetString("ConsoleFinishedFile"), List.length warnings) |> output.WriteInfo
     | Failed (file, parseException) ->
         String.Format(Resources.GetString("ConsoleFailedToParseFile"), file) |> output.WriteError
-        $"Exception Message:{Environment.NewLine}{parseException.Message}{Environment.NewLine}Exception Stack Trace:{Environment.NewLine}{parseException.StackTrace}{Environment.NewLine}"
-        |> output.WriteError
+        output.WriteError
+            $"Exception Message:{Environment.NewLine}{parseException.Message}{Environment.NewLine}Exception Stack Trace:{Environment.NewLine}{parseException.StackTrace}{Environment.NewLine}"
 
 /// Infers the file type of the target based on its file extension.
 let internal inferFileType (target:string) =
@@ -84,7 +84,7 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
         let version =
             Assembly.GetExecutingAssembly().GetCustomAttributes false
             |> Seq.pick (function | :? AssemblyInformationalVersionAttribute as aiva -> Some aiva.InformationalVersion | _ -> None)
-        $"Current version: {version}" |> output.WriteInfo
+        output.WriteInfo $"Current version: {version}"
         Environment.Exit 0
 
     let handleError (str:string) =
@@ -129,10 +129,10 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
                 | _ -> Lint.lintProject lintParams target toolsPath
             handleLintResult lintResult
         with
-        | e ->
+        | exn ->
             let target = if fileType = FileType.Source then "source" else target
-            $"Lint failed while analysing %s{target}.{Environment.NewLine}Failed with: %s{e.Message}{Environment.NewLine}Stack trace: {e.StackTrace}"
-            |> handleError
+            handleError
+                $"Lint failed while analysing %s{target}.{Environment.NewLine}Failed with: %s{exn.Message}{Environment.NewLine}Stack trace: {exn.StackTrace}"
     | _ -> ()
 
     exitCode