Use module or namespace as FsAstType. Fixes fsprojects#2141. (fsproje…

…cts#2142)

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [4.7.2] - 2022-03-11
+
+### Fixed
+*  Reordering comments on modules. [#2141](https://github.com/fsprojects/fantomas/issues/2141)
+
 ## [4.7.1] - 2022-03-08
 
 ### Fixed

src/Fantomas.Tests/ModuleTests.fs

@@ -779,3 +779,128 @@ namespace Meh
 module Foo = // comment
     val bar: int
 """
+
+[<Test>]
+let ``comment above named module with xml doc, 2141`` () =
+    formatSourceString
+        false
+        """
+// Boring copyright notice
+
+(* Some other preamble *)
+
+/// This module is amazing it's full of helpful lookup queries
+module Queries
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// Boring copyright notice
+
+(* Some other preamble *)
+
+/// This module is amazing it's full of helpful lookup queries
+module Queries
+"""
+
+[<Test>]
+let ``comment before declared namespace`` () =
+    formatSourceString
+        false
+        """
+// some comment
+namespace Blah
+let a = 0
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// some comment
+namespace Blah
+
+let a = 0
+"""
+
+[<Test>]
+let ``comment before global namespace`` () =
+    formatSourceString
+        false
+        """
+// some comment
+namespace global
+let a = 0
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// some comment
+namespace global
+
+let a = 0
+"""
+
+[<Test>]
+let ``comment before declared namespace in signature file`` () =
+    formatSourceString
+        true
+        """
+// some comment
+namespace Blah
+val a : int
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// some comment
+namespace Blah
+
+val a: int
+"""
+
+[<Test>]
+let ``comment before global namespace in signature file`` () =
+    formatSourceString
+        true
+        """
+// some comment
+namespace global
+val a : int
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// some comment
+namespace global
+
+val a: int
+"""
+
+[<Test>]
+let ``comment before named module in signature file`` () =
+    formatSourceString
+        true
+        """
+// some comment
+module Meh
+val a : int
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+// some comment
+module Meh
+
+val a: int
+"""

src/Fantomas.Tests/TriviaTests.fs

@@ -344,7 +344,7 @@ type ExtensibleDumper = A | B
     let trivias = Map.find [ "DEBUG" ] triviaNodes
 
     match trivias with
-    | [ { Type = LongIdent_
+    | [ { Type = SynModuleOrNamespace_DeclaredNamespace
           ContentAfter = [ Directive "#if EXTENSIBLE_DUMPER\n#if DEBUG\n\n#endif\n#endif" ] } ] -> pass ()
     | _ -> Assert.Fail(sprintf "Unexpected trivia %A" trivias)
 

src/Fantomas/AstTransformer.fs

@@ -48,13 +48,21 @@ module private Ast =
 
     let rec visitSynModuleOrNamespace (modOrNs: SynModuleOrNamespace) : TriviaNodeAssigner list =
         match modOrNs with
-        | SynModuleOrNamespace (longIdent, _, kind, decls, _, attrs, _, _range) ->
+        | SynModuleOrNamespace (longIdent, _, kind, decls, _, attrs, _, range) ->
+            let moduleOrNamespace =
+                match kind with
+                | SynModuleOrNamespaceKind.DeclaredNamespace -> [ mkNode SynModuleOrNamespace_DeclaredNamespace range ]
+                | SynModuleOrNamespaceKind.GlobalNamespace -> [ mkNode SynModuleOrNamespace_GlobalNamespace range ]
+                | SynModuleOrNamespaceKind.NamedModule -> [ mkNode SynModuleOrNamespace_NamedModule range ]
+                | SynModuleOrNamespaceKind.AnonModule -> []
+
             let longIdentNodes =
                 match kind, decls with
                 | SynModuleOrNamespaceKind.AnonModule, _ :: _ -> []
                 | _ -> visitLongIdentIncludingFullRange longIdent
 
-            [ yield! longIdentNodes
+            [ yield! moduleOrNamespace
+              yield! longIdentNodes
               yield! (visitSynAttributeLists attrs)
               yield! (decls |> List.collect visitSynModuleDecl) ]
 
@@ -1403,6 +1411,9 @@ module private Ast =
 
             let moduleOrNamespaceSig =
                 match kind with
+                | SynModuleOrNamespaceKind.DeclaredNamespace ->
+                    [ mkNode SynModuleOrNamespaceSig_DeclaredNamespace range ]
+                | SynModuleOrNamespaceKind.GlobalNamespace -> [ mkNode SynModuleOrNamespaceSig_GlobalNamespace range ]
                 | SynModuleOrNamespaceKind.NamedModule -> [ mkNode SynModuleOrNamespaceSig_NamedModule range ]
                 | _ -> []
 

src/Fantomas/CodePrinter.fs

@@ -119,7 +119,7 @@ and genModuleOrNamespaceKind (kind: SynModuleOrNamespaceKind) =
     | SynModuleOrNamespaceKind.GlobalNamespace -> !- "namespace global"
     | SynModuleOrNamespaceKind.AnonModule -> sepNone
 
-and genModuleOrNamespace astContext (ModuleOrNamespace (ats, px, ao, lids, mds, isRecursive, moduleKind)) =
+and genModuleOrNamespace astContext (ModuleOrNamespace (ats, px, ao, lids, mds, isRecursive, moduleKind, range)) =
     let sepModuleAndFirstDecl =
         let firstDecl = List.tryHead mds
 
@@ -131,7 +131,7 @@ and genModuleOrNamespace astContext (ModuleOrNamespace (ats, px, ao, lids, mds,
 
     let lidsFullRange =
         match lids with
-        | [] -> range.Zero
+        | [] -> FSharp.Compiler.Text.range.Zero
         | (_, r) :: _ -> Range.unionRanges r (List.last lids |> snd)
 
     let moduleOrNamespace =
@@ -154,6 +154,11 @@ and genModuleOrNamespace astContext (ModuleOrNamespace (ats, px, ao, lids, mds,
     +> ifElse (moduleKind = SynModuleOrNamespaceKind.AnonModule) genTriviaForAnonModuleIdent moduleOrNamespace
     +> sepModuleAndFirstDecl
     +> genModuleDeclList astContext mds
+    |> (match moduleKind with
+        | SynModuleOrNamespaceKind.AnonModule -> id
+        | SynModuleOrNamespaceKind.DeclaredNamespace -> genTriviaFor SynModuleOrNamespace_DeclaredNamespace range
+        | SynModuleOrNamespaceKind.GlobalNamespace -> genTriviaFor SynModuleOrNamespace_GlobalNamespace range
+        | SynModuleOrNamespaceKind.NamedModule -> genTriviaFor SynModuleOrNamespace_NamedModule range)
 
 and genSigModuleOrNamespace astContext (SigModuleOrNamespace (ats, px, ao, lids, mds, isRecursive, moduleKind, range)) =
     let sepModuleAndFirstDecl =
@@ -187,6 +192,8 @@ and genSigModuleOrNamespace astContext (SigModuleOrNamespace (ats, px, ao, lids,
     +> sepModuleAndFirstDecl
     +> genSigModuleDeclList astContext mds
     |> (match moduleKind with
+        | SynModuleOrNamespaceKind.DeclaredNamespace -> genTriviaFor SynModuleOrNamespaceSig_DeclaredNamespace range
+        | SynModuleOrNamespaceKind.GlobalNamespace -> genTriviaFor SynModuleOrNamespaceSig_GlobalNamespace range
         | SynModuleOrNamespaceKind.NamedModule -> genTriviaFor SynModuleOrNamespaceSig_NamedModule range
         | _ -> id)
 

src/Fantomas/SourceParser.fs

@@ -240,9 +240,9 @@ let (|ParsedImplFileInput|) (ParsedImplFileInput.ParsedImplFileInput (_, _, _, _
 let (|ParsedSigFileInput|) (ParsedSigFileInput.ParsedSigFileInput (_, _, _, hs, mns)) = (hs, mns)
 
 let (|ModuleOrNamespace|)
-    (SynModuleOrNamespace.SynModuleOrNamespace (LongIdentPieces lids, isRecursive, kind, mds, px, ats, ao, _))
+    (SynModuleOrNamespace.SynModuleOrNamespace (LongIdentPieces lids, isRecursive, kind, mds, px, ats, ao, range))
     =
-    (ats, px, ao, lids, mds, isRecursive, kind)
+    (ats, px, ao, lids, mds, isRecursive, kind, range)
 
 let (|SigModuleOrNamespace|)
     (SynModuleOrNamespaceSig.SynModuleOrNamespaceSig (LongIdentPieces lids, isRecursive, kind, mds, px, ats, ao, range))
@@ -251,7 +251,8 @@ let (|SigModuleOrNamespace|)
 
 let (|EmptyFile|_|) (input: ParsedInput) =
     match input with
-    | ImplFile (ParsedImplFileInput (_, [ ModuleOrNamespace (_, _, _, _, [], _, SynModuleOrNamespaceKind.AnonModule) ])) ->
+    | ImplFile (ParsedImplFileInput (_,
+                                     [ ModuleOrNamespace (_, _, _, _, [], _, SynModuleOrNamespaceKind.AnonModule, _) ])) ->
         Some input
     | SigFile (ParsedSigFileInput (_,
                                    [ SigModuleOrNamespace (_, _, _, _, [], _, SynModuleOrNamespaceKind.AnonModule, _) ])) ->

src/Fantomas/TriviaTypes.fs

@@ -47,12 +47,10 @@ type TriviaIndex = TriviaIndex of int * int
 type FsAstType =
     | Ident_
     | LongIdent_ // namespace or module identifier
-    // Modules and namespaces cannot really be trusted
-    // Their range can be influenced by non code constructs (like comments)
-    //    | SynModuleOrNamespace_AnonModule
-    //    | SynModuleOrNamespace_DeclaredNamespace
-    //    | SynModuleOrNamespace_GlobalNamespace
-    //    | SynModuleOrNamespace_NamedModule
+    //    | SynModuleOrNamespace_AnonModule, pick first child node instead
+    | SynModuleOrNamespace_DeclaredNamespace
+    | SynModuleOrNamespace_GlobalNamespace
+    | SynModuleOrNamespace_NamedModule
     | SynModuleDecl_ModuleAbbrev
     | SynModuleDecl_NestedModule
     | SynModuleDecl_NestedModule_Module
@@ -361,13 +359,9 @@ type FsAstType =
     | ParsedHashDirective_
     | ParsedHashDirectiveArgument_String
     | ParsedHashDirectiveArgument_SourceIdentifier
-    // Modules and namespaces cannot really be trusted
-    // Update 2022: this is not entirely true anymore.
-    // TODO: investigate what the status of this is.
-    // Their range can be influenced by non code constructs (like comments)
-//    | SynModuleOrNamespaceSig_AnonModule
-//    | SynModuleOrNamespaceSig_DeclaredNamespace
-//    | SynModuleOrNamespaceSig_GlobalNamespace
+    //    | SynModuleOrNamespaceSig_AnonModule, pick first child node
+    | SynModuleOrNamespaceSig_DeclaredNamespace
+    | SynModuleOrNamespaceSig_GlobalNamespace
     | SynModuleOrNamespaceSig_NamedModule
     | SynModuleSigDecl_ModuleAbbrev
     | SynModuleSigDecl_NestedModule