Always process folder recursive. (#2775)

* Always process folder recursive.

* Remove last traces of recurse.
Add UpgradeGuide.md entry.

Author: nojaf

docs/docs/end-users/UpgradeGuide.md

@@ -70,6 +70,7 @@ fsharp_experimental_stroustrup_style = true
 ### console application
 - `-v` is now short for `--verbosity` instead of `--version`
 - The console output was revamped.
+- `--recurse` was removed. Please use [.fantomasignore](./IgnoreFiles.html) file if you wish to ignore certain files.
 
 ### Miscellaneous
 - The public API of CodeFormatter no longer uses `FSharpOption<'T>`, instead overloads are now used.

src/Fantomas.Tests/Integration/IgnoreFilesTests.fs

@@ -53,7 +53,7 @@ let ``ignore specific file in subfolder`` () =
     use ignoreFixture = new FantomasIgnoreFile(sprintf "%s/%s/A.fs" sub1 sub2)
 
     let { ExitCode = exitCode } =
-        runFantomasTool (sprintf "--recurse --check .%c%s" Path.DirectorySeparatorChar sub1)
+        runFantomasTool (sprintf "--check .%c%s" Path.DirectorySeparatorChar sub1)
 
     exitCode |> should equal 0
 

src/Fantomas.Tests/Integration/MultiplePathsTests.fs

@@ -38,7 +38,7 @@ let ``format multiple paths`` () =
     fileContentMatches FormattedCode fileFixtureTwo.Filename
 
 [<Test>]
-let ``format multiple paths with recursive flag`` () =
+let ``format multiple paths recursively`` () =
     use config = new ConfigurationFile("[*]\nend_of_line = lf")
 
     use fileFixtureOne = new TemporaryFileCodeSample(UserCode)
@@ -48,7 +48,7 @@ let ``format multiple paths with recursive flag`` () =
     use fileFixtureThree = new TemporaryFileCodeSample(UserCode, subFolder = "sub")
 
     let arguments =
-        sprintf "%s \"%s\" \"%s\" \"sub\" -r" Verbosity fileFixtureOne.Filename fileFixtureTwo.Filename
+        sprintf "%s \"%s\" \"%s\" \"sub\"" Verbosity fileFixtureOne.Filename fileFixtureTwo.Filename
 
     let { ExitCode = exitCode; Output = output } = runFantomasTool arguments
 

src/Fantomas/Program.fs

@@ -11,7 +11,6 @@ open Spectre.Console
 let extensions = set [| ".fs"; ".fsx"; ".fsi"; ".ml"; ".mli" |]
 
 type Arguments =
-    | [<Unique; AltCommandLine("-r")>] Recurse
     | [<Unique>] Force
     | [<Unique>] Profile
     | [<Unique>] Out of string
@@ -24,7 +23,6 @@ type Arguments =
     interface IArgParserTemplate with
         member s.Usage =
             match s with
-            | Recurse -> "Process the input folder recursively."
             | Force -> "Print the output even if it is not valid F# code. For debugging purposes only."
             | Out _ ->
                 "Give a valid path for files/folders. Files should have .fs, .fsx, .fsi, .ml or .mli extension only. Multiple files/folders are not supported."
@@ -83,13 +81,9 @@ let isInExcludedDir (fullPath: string) =
 let isFSharpFile (s: string) =
     Set.contains (Path.GetExtension s) extensions
 
-/// Get all appropriate files, either recursively or non-recursively
-let allFiles isRec path =
-    let searchOption =
-        (if isRec then
-             SearchOption.AllDirectories
-         else
-             SearchOption.TopDirectoryOnly)
+/// Get all appropriate files, recursively.
+let findAllFilesRecursively path =
+    let searchOption = SearchOption.AllDirectories
 
     Directory.GetFiles(path, "*.*", searchOption)
     |> Seq.filter (fun f -> isFSharpFile f && not (isInExcludedDir f))
@@ -182,7 +176,7 @@ let private reportCheckResults (checkResult: Format.CheckResult) =
     |> List.map (fun filename -> $"%s{filename} needs formatting")
     |> Seq.iter stdlog
 
-let runCheckCommand (recurse: bool) (inputPath: InputPath) : int =
+let runCheckCommand (inputPath: InputPath) : int =
     let check files =
         Async.RunSynchronously(Format.checkCode files)
 
@@ -208,12 +202,12 @@ let runCheckCommand (recurse: bool) (inputPath: InputPath) : int =
         logGrEqDetailed $"'%s{f}' was ignored"
         0
     | InputPath.File path -> path |> Seq.singleton |> check |> processCheckResult
-    | InputPath.Folder path -> path |> allFiles recurse |> check |> processCheckResult
+    | InputPath.Folder path -> path |> findAllFilesRecursively |> check |> processCheckResult
     | InputPath.Multiple(files, folders) ->
         let allFilesToCheck =
             seq {
                 yield! files
-                yield! (Seq.collect (allFiles recurse) folders)
+                yield! (Seq.collect findAllFilesRecursively folders)
             }
 
         allFilesToCheck |> check |> processCheckResult
@@ -274,8 +268,6 @@ let main argv =
 
     let force = results.Contains <@ Arguments.Force @>
     let profile = results.Contains <@ Arguments.Profile @>
-    let recurse = results.Contains <@ Arguments.Recurse @>
-
     let version = results.TryGetResult <@ Arguments.Version @>
 
     let maybeVerbosity =
@@ -351,7 +343,7 @@ let main argv =
         if not <| Directory.Exists(outputFolder) then
             Directory.CreateDirectory(outputFolder) |> ignore
 
-        allFiles recurse inputFolder
+        findAllFilesRecursively inputFolder
         |> Seq.toList
         |> List.map (fun i ->
             // s supposes to have form s1/suffix
@@ -461,7 +453,7 @@ let main argv =
         daemon.WaitForClose.GetAwaiter().GetResult()
         exit 0
     elif check then
-        inputPath |> runCheckCommand recurse |> exit
+        inputPath |> runCheckCommand |> exit
     else
         try
             match inputPath, outputPath with

tests/regressions.fsx

@@ -43,7 +43,7 @@ let git (workingDirectory: string) (arguments: string) = wrap workingDirectory "
 
 let format (workingDirectory: string) (input: string list) =
     let input = String.concat " " input
-    wrap workingDirectory "dotnet" $"{fantomasBinary} {input} --recurse"
+    wrap workingDirectory "dotnet" $"{fantomasBinary} {input}"
 
 let runCommands (workingDirectory: string) (commands: Command list) =
     task {