Merge pull request #17 from pietroppeter/move-bookcfg

[rfc] refactor bookcfg

book/basics/data_manipulation.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """## Data Manipulation
 
 I like less data manipulation

book/basics/index.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """# Basics
 
 Better Basic than Acid.

book/basics/models.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """## Models
 
 I can fake understanding models

book/basics/plotting.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """## Plotting
 
 I like data visualization

book/index.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """# Introduction
 
 I should say something very wise about this book.

book/misc/but/very/far/contributors.nim

@@ -1,6 +1,4 @@
-import nimib, bookcfg
-nbInit
-nbDoc.applyCfg
+include nimibook / prelude
 nbText: """# Contributors
 
 Clonkk with 2 k, pietroppeter with 3 p, HugoGranstrom with 2 r.

nimibook.nimble

@@ -34,3 +34,9 @@ task cleanbook, "cleanbook":
       echo "removed ", file
 
 
+task srcpretty, "run nimpretty on nim files in src folder":
+  for file in walkDirRec("src"):
+    if file.endsWith(".nim"):
+      let cmd = "nimpretty --maxLineLen:160 " & file
+      echo "[executing] ", cmd
+      exec(cmd)

src/nimibook.nim

@@ -1,2 +1,2 @@
-import nimibook / [types, render, tocs, pubs]
-export types, render, tocs, pubs
+import nimibook / [types, render, tocs, publishers, defaults]
+export types, render, tocs, publishers, defaults

book/bookcfg.nim → src/nimibook/defaults.nim

@@ -1,14 +1,15 @@
-import nimib, strutils, os, nimib / paths
+import std / [strutils, os]
+import nimib, nimib / paths
 import nimibook / [types, tocs, render, entries]
 
-proc applyCfg*(nbDoc: var NbDoc) =
+proc useNimibook*(nbDoc: var NbDoc) =
   let
     nbThisFile = changeFileExt(nbDoc.filename.AbsoluteFile, ".nim")
     thisTuple = nbThisFile.splitFile
     nbThisDir: AbsoluteDir = thisTuple.dir
     nbHomeDir: AbsoluteDir = findNimbleDir(nbThisDir) / "docs".RelativeDir
     nbSrcDir = nbHomeDir / RelativeDir(".." / "book")
-  
+
   nbDoc.filename = relativeTo(changeFileExt(nbThisFile, ".html"), nbSrcDir).string
   nbDoc.context["here_path"] = (nbThisFile.relativeTo nbSrcDir).string
   nbDoc.context["home_path"] = (nbSrcDir.relativeTo nbThisDir).string
@@ -34,4 +35,4 @@ proc applyCfg*(nbDoc: var NbDoc) =
   for entry in toc.entries.mitems:
     if entry.url == nbDoc.filename.replace('\\', '/'): # replace needed for windows
       entry.isActive = true
-  nbDoc.partials["toc"] = render toc
+  nbDoc.partials["toc"] = render toc

src/nimibook/entries.nim

@@ -1,5 +1,5 @@
-import nimibook / types
 import std / [os, strutils, strformat]
+import nimibook / types
 
 proc url*(e: Entry): string =
   var path = changeFileExt(e.path, "html").tailDir()

src/nimibook/prelude.nim

@@ -0,0 +1,3 @@
+import nimib, nimibook / defaults
+nbInit
+nbDoc.useNimibook

src/nimibook/pubs.nim → src/nimibook/publishers.nim

@@ -1,7 +1,6 @@
-
 import std / [os, strutils]
-import nimibook / [types, tocs]
-import nimib, ../../book/bookcfg
+import nimibook / [types, tocs, defaults]
+import nimib
 
 proc nimPublish*(entry: Entry) =
   let
@@ -14,11 +13,11 @@ proc nimPublish*(entry: Entry) =
 proc mdPublish*(entry: Entry) =
   nbInit
   nbDoc.filename = (nbThisDir / ("../../" & entry.path).RelativeDir).string
-  nbDoc.applyCfg
+  nbDoc.useNimibook
   withDir(nbHomeDir / "..".RelativeDir):
     nbText entry.path.readFile
   nbSave
-  setCurrentDir nbInitDir  # reset current directory
+  setCurrentDir nbInitDir # reset current directory
 
 proc publish*(entry: Entry) =
   let splitted = entry.path.splitFile()

src/nimibook/render.nim

@@ -1,4 +1,4 @@
-import std/strformat
+import std / strformat
 import nimibook / [types, entries]
 
 const path_to_root = "{{path_to_root}}"

src/nimibook/sort.nim

@@ -1,6 +1,6 @@
 # in case you need to sort entries (it can be useful for automatically generated entries)
+import std / algorithm
 import nimibook / types
-import std/algorithm
 
 proc intcmp(x, y: int): int =
   if x < y:

src/nimibook/tocs.nim

@@ -1,6 +1,6 @@
-import nimibook / [types, entries]
 import std / [os, strutils, strformat]
 import jsony
+import nimibook / [types, entries]
 
 proc inc(levels: var seq[int]) =
   levels[levels.high] = levels[levels.high] + 1
@@ -11,12 +11,12 @@ proc add(toc: var Toc, entry: Entry) =
     raise newException(IOError, fmt"Error entry {fullpath} doesn't exist.")
   toc.entries.add entry
 
-proc joinPath(parts: seq[string], tail: string) : string =
+proc joinPath(parts: seq[string], tail: string): string =
   var parts = parts
   parts.add tail
   normalizedPath(joinPath(parts))
 
-proc formatFileName(inputs: tuple[dir: string, name: string, ext: string]) : string =
+proc formatFileName(inputs: tuple[dir: string, name: string, ext: string]): string =
   result = inputs.name
   if inputs.ext.isEmptyOrWhitespace():
     result &= ".nim"
@@ -26,7 +26,7 @@ proc formatFileName(inputs: tuple[dir: string, name: string, ext: string]) : str
 template newToc*(booklabel: string, rootfolder: string, body: untyped): Toc =
   var toc = Toc(title: booklabel, path: rootfolder)
   var levels: seq[int] = @[1]
-  var folders : seq[string] = @[rootfolder]
+  var folders: seq[string] = @[rootfolder]
 
   template entry(label, rfile: string) =
     # debugEcho "==> entry <=="

src/nimibook/types.nim

@@ -8,4 +8,4 @@ type
   Toc* = object
     title*: string
     path*: string
-    entries*: seq[Entry]
+    entries*: seq[Entry]