make markdown code block formatter work on markdown files as well

Author: zth

tests/tools_tests/src/docstrings-format/FormatDocstringsTest1.res

@@ -30,7 +30,7 @@ module Nested = {
     let getName = user=>user.name
   }
   ```  
-*/
+  */
   let testFunction2 = () => "test2"
 }
 

tests/tools_tests/src/docstrings-format/FormatRescriptBlocks.md

@@ -0,0 +1,20 @@
+# Format ReScript code blocks
+
+This markdown file should be formatted.
+
+This is the first docstring with unformatted ReScript code.
+
+```rescript
+let badly_formatted=(x,y)=>{
+let result=x+y
+if result>0{Console.log("positive")}else{Console.log("negative")}
+result
+}
+```
+
+And another code block in the same docstring:
+
+```res
+type user={name:string,age:int,active:bool}
+let createUser=(name,age)=>{name:name,age:age,active:true}
+```

tests/tools_tests/src/expected/FormatDocstringsTest1.res.expected

@@ -34,7 +34,7 @@ module Nested = {
     let getName = user => user.name
   }
   ```
-*/
+  */
   let testFunction2 = () => "test2"
 }
 

tests/tools_tests/src/expected/FormatRescriptBlocks.md.expected

@@ -0,0 +1,25 @@
+# Format ReScript code blocks
+
+This markdown file should be formatted.
+
+This is the first docstring with unformatted ReScript code.
+
+```rescript
+let badly_formatted = (x, y) => {
+  let result = x + y
+  if result > 0 {
+    Console.log("positive")
+  } else {
+    Console.log("negative")
+  }
+  result
+}
+```
+
+And another code block in the same docstring:
+
+```res
+type user = {name: string, age: int, active: bool}
+let createUser = (name, age) => {name, age, active: true}
+```
+

tests/tools_tests/test.sh

@@ -17,9 +17,9 @@ for file in ppx/*.res; do
 done
 
 # Test format-docstrings command
-for file in src/docstrings-format/*.{res,resi}; do
+for file in src/docstrings-format/*.{res,resi,md}; do
   output="src/expected/$(basename $file).expected"
-  ../../_build/install/default/bin/rescript-tools format-docstrings "$file" --stdout > $output
+  ../../_build/install/default/bin/rescript-tools format-codeblocks "$file" --stdout > $output
   # # CI. We use LF, and the CI OCaml fork prints CRLF. Convert.
   if [ "$RUNNER_OS" == "Windows" ]; then
     perl -pi -e 's/\r\n/\n/g' -- $output

tools/bin/main.ml

@@ -24,7 +24,7 @@ Usage: rescript-tools [command]
 Commands:
 
 doc <file>                              Generate documentation
-format-docstrings <file> [--stdout]     Format ReScript code blocks in docstrings
+format-codeblocks <file> [--stdout]     Format ReScript code blocks
 reanalyze                               Reanalyze
 -v, --version                           Print version
 -h, --help                              Print help|}
@@ -53,19 +53,19 @@ let main () =
       in
       logAndExit (Tools.extractDocs ~entryPointFile:path ~debug:false)
     | _ -> logAndExit (Error docHelp))
-  | "format-docstrings" :: rest -> (
+  | "format-codeblocks" :: rest -> (
     match rest with
     | ["-h"] | ["--help"] -> logAndExit (Ok formatDocstringsHelp)
     | [path; "--stdout"] -> (
       Clflags.color := Some Misc.Color.Never;
       match
-        Tools.FormatDocstrings.formatDocstrings ~outputMode:`Stdout
+        Tools.FormatCodeblocks.formatCodeBlocksInFile ~outputMode:`Stdout
           ~entryPointFile:path
       with
       | Ok content -> print_endline content
       | Error e -> logAndExit (Error e))
     | [path] ->
-      Tools.FormatDocstrings.formatDocstrings ~outputMode:`File
+      Tools.FormatCodeblocks.formatCodeBlocksInFile ~outputMode:`File
         ~entryPointFile:path
       |> logAndExit
     | _ -> logAndExit (Error formatDocstringsHelp))

tools/src/tools.ml

@@ -677,9 +677,9 @@ let extractEmbedded ~extensionPoints ~filename =
            ])
   |> List.rev |> array
 
-module FormatDocstrings = struct
+module FormatCodeblocks = struct
   let formatRescriptCodeBlocks content ~displayFilename ~addError
-      ~(payloadLoc : Location.t) =
+      ~markdownBlockStartLine =
     let open Cmarkit in
     (* Detect ReScript code blocks. *)
     let hadCodeBlocks = ref false in
@@ -700,7 +700,7 @@ module FormatDocstrings = struct
 
           let n = List.length code in
           let newlinesNeeded =
-            max 0 (payloadLoc.loc_start.pos_lnum + currentLine - n)
+            max 0 (markdownBlockStartLine + currentLine - n)
           in
           let codeWithOffset = String.make newlinesNeeded '\n' ^ codeText in
 
@@ -737,7 +737,7 @@ module FormatDocstrings = struct
     in
     (newContent, !hadCodeBlocks)
 
-  let formatDocstrings ~outputMode ~entryPointFile =
+  let formatCodeBlocksInFile ~outputMode ~entryPointFile =
     let path =
       match Filename.is_relative entryPointFile with
       | true -> Unix.realpath entryPointFile
@@ -757,7 +757,7 @@ module FormatDocstrings = struct
                 PStr [{pstr_desc = Pstr_eval ({pexp_loc}, _)}] ) ->
               let formattedContents, hadCodeBlocks =
                 formatRescriptCodeBlocks ~addError ~displayFilename
-                  ~payloadLoc:pexp_loc contents
+                  ~markdownBlockStartLine:pexp_loc.loc_start.pos_lnum contents
               in
               if hadCodeBlocks && formattedContents <> contents then
                 ( name,
@@ -772,7 +772,24 @@ module FormatDocstrings = struct
       }
     in
     let formatted_content, source =
-      if Filename.check_suffix path ".res" then
+      if Filename.check_suffix path ".md" then
+        let content =
+          let ic = open_in path in
+          let n = in_channel_length ic in
+          let s = Bytes.create n in
+          really_input ic s 0 n;
+          close_in ic;
+          Bytes.to_string s
+        in
+        let displayFilename = Filename.basename path in
+        let formattedContents, hadCodeBlocks =
+          formatRescriptCodeBlocks ~addError ~displayFilename
+            ~markdownBlockStartLine:1 content
+        in
+        if hadCodeBlocks && formattedContents <> content then
+          (formattedContents, content)
+        else (content, content)
+      else if Filename.check_suffix path ".res" then
         let parser =
           Res_driver.parsing_engine.parse_implementation ~for_printer:true
         in