add cli success messages

and comment init command code a little
fsprojects · Nov 18, 2023 · 2f9de2c · 2f9de2c
1 parent 1766ced
commit 2f9de2c
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/src/fsdocs-tool/InitCommand.fs b/src/fsdocs-tool/InitCommand.fs
@@ -8,7 +8,7 @@ type InitCommand() =
 
     let dir = Path.GetDirectoryName(typeof<InitCommand>.Assembly.Location)
 
-    // get template locations for in-package and in-repo and decide which to use later
+    // get template locations for in-package and in-repo files and decide which to use later
     let inPackageLocations = Common.InPackageLocations(Path.Combine(dir, "..", "..", ".."))
     let inRepoLocations = Common.InRepoLocations(Path.Combine(dir, "..", "..", "..", "..", ".."))
 
@@ -29,6 +29,7 @@ type InitCommand() =
             |> List.iter ensureDirectory
 
         if inPackageLocations.Exist() then
+            // if the in-package locations exist, this means fsdocs is run from the nuget package.
             ensureOutputDirs ()
 
             try
@@ -37,18 +38,25 @@ type InitCommand() =
                   (inPackageLocations.template_tex, initLocations.template_tex)
                   (inPackageLocations.dockerfile, initLocations.dockerfile)
                   (inPackageLocations.nuget_config, initLocations.nuget_config)
+                  // these files must be renamed, because files prefixed with a dot are otherwise ignored by fsdocs. We want this in the source repo, but not in the output of this command.
                   (inPackageLocations.logo_template, Path.GetFullPath(Path.Combine(initLocations.docs_img, "logo.png")))
                   (inPackageLocations.index_md_template, Path.GetFullPath(Path.Combine(initLocations.docs, "index.md")))
                   (inPackageLocations.literate_sample_template,
                    Path.GetFullPath(Path.Combine(initLocations.docs, "literate_sample.fsx"))) ]
                 |> List.iter (fun (src, dst) -> File.Copy(src, dst, true))
 
+                printfn ""
+                printfn "a basic fsdocs scaffold has been created in %s." this.output
+                printfn ""
+                printfn "check it out by running 'dotnet fsdocs watch' !"
+
                 0
-            with e as exn ->
+            with _ as exn ->
                 printfn "Error: %s" exn.Message
                 1
 
         elif inRepoLocations.Exist() then
+            // if the in-repo locations exist, this means fsdocs is run from inside the FSharp.Formatting repo itself.
             ensureOutputDirs ()
 
             try
@@ -57,14 +65,20 @@ type InitCommand() =
                   (inRepoLocations.template_tex, initLocations.template_tex)
                   (inRepoLocations.dockerfile, initLocations.dockerfile)
                   (inRepoLocations.nuget_config, initLocations.nuget_config)
+                  // these files must be renamed, because files prefixed with a dot are otherwise ignored by fsdocs. We want this in the source repo, but not in the output of this command.
                   (inRepoLocations.logo_template, Path.GetFullPath(Path.Combine(initLocations.docs_img, "logo.png")))
                   (inRepoLocations.index_md_template, Path.GetFullPath(Path.Combine(initLocations.docs, "index.md")))
                   (inRepoLocations.literate_sample_template,
                    Path.GetFullPath(Path.Combine(initLocations.docs, "literate_sample.fsx"))) ]
                 |> List.iter (fun (src, dst) -> File.Copy(src, dst, true))
 
+                printfn ""
+                printfn "a basic fsdocs scaffold has been created in %s." this.output
+                printfn ""
+                printfn "check it out by running 'dotnet fsdocs watch' !"
+
                 0
-            with e as exn ->
+            with _ as exn ->
                 printfn "Error: %s" exn.Message
                 1
         else