add attempt to make in-repo and in-package locations reusable across commands

Author: kMutagene

src/fsdocs-tool/BuildCommand.fs

@@ -1451,11 +1451,13 @@ type CoreBuildOptions(watch) =
         //   to .nuget\packages\fsdocs-tool\7.1.7\templates
         let dir = Path.GetDirectoryName(typeof<CoreBuildOptions>.Assembly.Location)
 
-        let defaultTemplateAttempt1 =
-            Path.GetFullPath(Path.Combine(dir, "..", "..", "..", "templates", "_template.html"))
+        // get template locations for in-package and in-repo and decide which to use later
+        let inPackageLocations = Common.InPackageLocations(Path.Combine(dir, "..", "..", ".."))
+        let inRepoLocations = Common.InRepoLocations(Path.Combine(dir, "..", "..", "..", "..", ".."))
+
+        let defaultTemplateAttempt1 = inPackageLocations.template_html
         // This is in-repo only
-        let defaultTemplateAttempt2 =
-            Path.GetFullPath(Path.Combine(dir, "..", "..", "..", "..", "..", "docs", "_template.html"))
+        let defaultTemplateAttempt2 = inRepoLocations.template_html
 
         let defaultTemplate =
             if this.nodefaultcontent then
@@ -1482,7 +1484,7 @@ type CoreBuildOptions(watch) =
                   // The "extras" content goes in "."
                   //   From .nuget\packages\fsdocs-tool\7.1.7\tools\net6.0\any
                   //   to .nuget\packages\fsdocs-tool\7.1.7\extras
-                  let attempt1 = Path.GetFullPath(Path.Combine(dir, "..", "..", "..", "extras"))
+                  let attempt1 = inPackageLocations.extras
 
                   if
                       (try
@@ -1496,8 +1498,7 @@ type CoreBuildOptions(watch) =
                       // This is for in-repo use only, assuming we are executing directly from
                       //   src\fsdocs-tool\bin\Debug\net6.0\fsdocs.exe
                       //   src\fsdocs-tool\bin\Release\net6.0\fsdocs.exe
-                      let attempt2 =
-                          Path.GetFullPath(Path.Combine(dir, "..", "..", "..", "..", "..", "docs", "content"))
+                      let attempt2 = inRepoLocations.docs_content
 
                       if
                           (try

src/fsdocs-tool/InitCommand.fs

@@ -0,0 +1,9 @@
+namespace fsdocs
+
+open System.IO
+open CommandLine
+
+[<Verb("init", HelpText = "initialize the necessary folder structure and files for creating documentation with fsdocs.")>]
+type InitCommand() =
+    class
+    end

src/fsdocs-tool/Options.fs

@@ -38,3 +38,61 @@ module Common =
         if b then
             printf "\nPress any key to continue ..."
             System.Console.ReadKey() |> ignore
+
+    open System.IO
+
+    /// <summary>
+    /// a set of default locations in this repo.
+    /// these files are to be used in 2 scenarios assuming we are executing directly from
+    ///
+    ///   src\fsdocs-tool\bin\Debug\net6.0\fsdocs.exe
+    ///
+    ///   src\fsdocs-tool\bin\Release\net6.0\fsdocs.exe:
+    ///
+    /// - as default styles when running watch or build when there are no user equivalents present and `nodefaultcontent` is not set to true
+    ///
+    /// - as content of the output of the `init` command to initialize a default docs folder structure.
+    ///
+    /// Note that the path of these files will always be combined with the given `assemblyPath` because the cli tool will query it's own path on runtime via reflection.
+    /// </summary>
+    type InRepoLocations(relAssemblyPath) =
+
+        // relAssemblyPath : relative path from assemly to repo root path
+
+        // default folder locations relative to the assembly path
+        member _.docs = Path.Combine(relAssemblyPath, "docs") |> Path.GetFullPath
+        member this.docs_content = Path.Combine(this.docs, "content") |> Path.GetFullPath
+        member this.docs_content_image = Path.Combine(this.docs_content, "img") |> Path.GetFullPath
+
+        // specific files in this folder structure that might need special treatment instead of just copy pasting
+        member this.template_html = Path.Combine(this.docs, "_template.html") |> Path.GetFullPath
+        member this.template_ipynb = Path.Combine(this.docs, "_template.ipynb") |> Path.GetFullPath
+        member this.template_tex = Path.Combine(this.docs, "_template.tex") |> Path.GetFullPath
+
+    /// <summary>
+    /// a set of default locations in the nuget package created for fsdocs-tool.
+    /// these files are to be used in 2 scenarios assuming the tool is invoked via cli:
+    ///
+    /// - as default styles when running watch or build when there are no user equivalents present and `nodefaultcontent` is not set to true
+    ///
+    /// - as content of the output of the `init` command to initialize a default docs folder structure.
+    ///
+    /// Note that the path of these files will always be combined with the given `assemblyPath` because the cli tool will query it's own path on runtime via reflection.
+    /// </summary>
+    type InPackageLocations(relAssemblyPath) =
+
+        // relAssemblyPath : relative path from assemly to package root path
+
+        //   From .nuget\packages\fsdocs-tool\7.1.7\tools\net6.0\any
+        //   to .nuget\packages\fsdocs-tool\7.1.7\*
+
+        // default folder locations relative to the assembly path
+        member _.templates = Path.Combine(relAssemblyPath, "templates") |> Path.GetFullPath
+        member _.extras = Path.Combine(relAssemblyPath, "extras") |> Path.GetFullPath
+        member this.extras_content = Path.Combine(this.extras, "content") |> Path.GetFullPath
+        member this.extras_content_img = Path.Combine(this.extras_content, "img") |> Path.GetFullPath
+
+        // specific files in this folder structure that might need special treatment instead of just copy pasting
+        member this.template_html = Path.Combine(this.templates, "_template.html") |> Path.GetFullPath
+        member this.template_ipynb = Path.Combine(this.templates, "_template.ipynb") |> Path.GetFullPath
+        member this.template_tex = Path.Combine(this.templates, "_template.tex") |> Path.GetFullPath

src/fsdocs-tool/fsdocs-tool.fsproj

@@ -22,6 +22,7 @@
     <Compile Include="Options.fs" />
     <Compile Include="ProjectCracker.fs" />
     <Compile Include="BuildCommand.fs" />
+    <Compile Include="InitCommand.fs" />
     <Compile Include="Program.fs" />
   </ItemGroup>