reorder proc postfix doc comments with statement (#27)

arnetheduck · Jan 4, 2024 · 9506b29 · 9506b29
1 parent bfc7db5
commit 9506b29
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 11 deletions.
diff --git a/src/phrenderer.nim b/src/phrenderer.nim
@@ -1193,6 +1193,14 @@ proc gcase(g: var TOutput, n: PNode) =
     optNL(g)
     gsonsNL(g, n, start = 1)
 
+proc reorderPostfix(n: PNode): bool =
+  # Because we move the body to a new line, we must also reorder postfix doc
+  # comments or they end up becoming the last statement in the proc and
+  # thus breaking it
+  # TODO enable AST checking for nkCommentStmt to catch this :/
+  n.kind in procDefs and n.postfix.len > 0 and isDocComment(n.postfix[0].literal) and
+    n[bodyPos].kind != nkEmpty
+
 proc gproc(g: var TOutput, n: PNode) =
   gsub(g, n[namePos])
 
@@ -1219,9 +1227,15 @@ proc gproc(g: var TOutput, n: PNode) =
       withIndent(g):
         g.optNL()
         gmids(g, n)
+
+      if reorderPostfix(n):
+        gpostfixes(g, n)
     else:
       gmids(g, n, true)
 
+      if reorderPostfix(n):
+        gpostfixes(g, n)
+
       gstmts(g, n[bodyPos], flags)
   else:
     withIndent(g):
@@ -2186,9 +2200,8 @@ proc gsub(g: var TOutput, n: PNode, flags: SubFlags, extra: int) =
     #nkNone, nkExplicitTypeListCall:
     internalError(g.config, n.info, "renderer.gsub(" & $n.kind & ')')
 
-  if sfSkipPostfix notin flags:
+  if sfSkipPostfix notin flags and not reorderPostfix(n):
     const stickyPostfix = {nkCommand}
-
     gpostfixes(g, n, n.kind in stickyPostfix)
 
   if n.kind in blankAfterComplex and currLine < g.line:

diff --git a/tests/after/comments.nim b/tests/after/comments.nim
@@ -330,14 +330,14 @@ proc x() =
       discard
 
 proc x() =
-  discard
   ## indented doc comment for proc
   ## that is long
+  discard
 
 proc x() =
-  echo a.b
   ## indented doc comment for proc
   ## with a dotexpr and a command
+  echo a.b
 
 proc f(): bool =
   ## Comment here
@@ -372,6 +372,11 @@ proc a(
   abc: int,
 )
 
+proc a(): int =
+  ## Doc comment that needs body reordering
+  ## even two lines again
+  42
+
 command "a", "b", "c" # command eol comment
 
 command "first arg", # first arg comment

diff --git a/tests/after/comments.nim.nph.yaml b/tests/after/comments.nim.nph.yaml
@@ -1221,13 +1221,13 @@ sons:
       - kind: "nkEmpty"
       - kind: "nkStmtList"
         sons:
-          - kind: "nkDiscardStmt"
-            sons:
-              - kind: "nkEmpty"
           - kind: "nkCommentStmt"
             "comment": "## indented doc comment for proc"
           - kind: "nkCommentStmt"
             "comment": "## that is long"
+          - kind: "nkDiscardStmt"
+            sons:
+              - kind: "nkEmpty"
   - kind: "nkProcDef"
     sons:
       - kind: "nkIdent"
@@ -1241,6 +1241,10 @@ sons:
       - kind: "nkEmpty"
       - kind: "nkStmtList"
         sons:
+          - kind: "nkCommentStmt"
+            "comment": "## indented doc comment for proc"
+          - kind: "nkCommentStmt"
+            "comment": "## with a dotexpr and a command"
           - kind: "nkCommand"
             sons:
               - kind: "nkIdent"
@@ -1251,10 +1255,6 @@ sons:
                     ident: "a"
                   - kind: "nkIdent"
                     ident: "b"
-          - kind: "nkCommentStmt"
-            "comment": "## indented doc comment for proc"
-          - kind: "nkCommentStmt"
-            "comment": "## with a dotexpr and a command"
   - kind: "nkProcDef"
     sons:
       - kind: "nkIdent"
@@ -1404,6 +1404,26 @@ sons:
       - kind: "nkEmpty"
       - kind: "nkEmpty"
       - kind: "nkEmpty"
+  - kind: "nkProcDef"
+    sons:
+      - kind: "nkIdent"
+        ident: "a"
+      - kind: "nkEmpty"
+      - kind: "nkEmpty"
+      - kind: "nkFormalParams"
+        sons:
+          - kind: "nkIdent"
+            ident: "int"
+      - kind: "nkEmpty"
+      - kind: "nkEmpty"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkCommentStmt"
+            "comment": "## Doc comment that needs body reordering"
+          - kind: "nkCommentStmt"
+            "comment": "## even two lines again"
+          - kind: "nkIntLit"
+            intVal: 42
   - kind: "nkCommand"
     sons:
       - kind: "nkIdent"

diff --git a/tests/before/comments.nim b/tests/before/comments.nim
@@ -349,6 +349,10 @@ proc f =
 
 proc a(v#[block]#: int, abc: int)
 
+proc a(): int = 42
+  ## Doc comment that needs body reordering
+  ## even two lines again
+
 command "a", "b", "c" # command eol comment
 
 command "first arg", # first arg comment

diff --git a/tests/before/comments.nim.nph.yaml b/tests/before/comments.nim.nph.yaml
@@ -1401,6 +1401,25 @@ sons:
       - kind: "nkEmpty"
       - kind: "nkEmpty"
       - kind: "nkEmpty"
+  - kind: "nkProcDef"
+    sons:
+      - kind: "nkIdent"
+        ident: "a"
+      - kind: "nkEmpty"
+      - kind: "nkEmpty"
+      - kind: "nkFormalParams"
+        sons:
+          - kind: "nkIdent"
+            ident: "int"
+      - kind: "nkEmpty"
+      - kind: "nkEmpty"
+      - kind: "nkStmtList"
+        sons:
+          - kind: "nkIntLit"
+            intVal: 42
+    postfix:
+      - "## Doc comment that needs body reordering"
+      - "## even two lines again"
   - kind: "nkCommand"
     sons:
       - kind: "nkIdent"