Add: function to add line numbers to block

docsrc/allblocks.nim

@@ -17,7 +17,7 @@ template nbCodeBlock(name:string) =
   nbToc.output.add "1. <a href=\"#" & anchorName & "\">" & name & "</a>\n"
 
 nbText: """
-> This nimib document provides a brief description and example for 
+> This nimib document provides a brief description and example for
 > all blocks in nimib.
 """.emojize
 
@@ -32,7 +32,7 @@ The markdown syntax is explained in the [Markdown Cheatsheet](https://pietroppet
 nimibCode:
   nbText: """
   #### Markdown Example
-  My **text** is *formatted* with the 
+  My **text** is *formatted* with the
   [Markdown](https://pietroppeter.github.io/nimib/cheatsheet.html) syntax.
   """
 
@@ -46,10 +46,18 @@ nimibCode:
   nbCode:
     echo "Hello World!"
 
+nbText: """
+You can also display the line numbers on the left thanks to the global document switch:
+"""
+
+nimibCode:
+  enableLineNumbersDoc()
+  nbCode:
+    echo "Hello World!"
 
 nbCodeBlock: "nbCodeSkip"
 nbText: """
-Similar to `nbCode`, `nbCodeSkip` is a block that displays 
+Similar to `nbCode`, `nbCodeSkip` is a block that displays
 highlighted code but does not run it.
 It is useful to show erroneous code or code that takes too long to run.
 > :warning: `nbCodeSkip` does not guarantee that the code you show will compile nor run.

nimib.nimble

@@ -19,13 +19,13 @@ task docsdeps, "install dependendencies required for doc building":
   exec "nimble -y install [email protected] [email protected] nimoji nimpy [email protected]"
 
 task test, "General tests":
-  for file in ["tsources.nim", "tblocks.nim", "tnimib.nim", "trenders.nim"]:
+  for file in ["tsources.nim", "tblocks.nim", "tnimib.nim", "trenders.nim", "tcodeLines.nim"]:
     exec "nim r --hints:off tests/" & file
   for file in ["tblocks.nim", "tnimib.nim", "trenders.nim"]:
     exec "nim r --hints:off -d:nimibCodeFromAst tests/" & file
 
 task readme, "update readme":
-  exec "nim -d:mdOutput r docsrc/index.nim"  
+  exec "nim -d:mdOutput r docsrc/index.nim"
 
 task docs, "Build documentation":
   for file in ["allblocks", "hello", "mostaccio", "numerical", "nolan",
@@ -34,4 +34,4 @@ task docs, "Build documentation":
     exec "nim r --hints:off docsrc/" & file & ".nim"
   when not defined(nimibDocsSkipPenguins):
     exec "nim r --hints:off docsrc/penguins.nim"
-  exec "nimble readme"  
+  exec "nimble readme"

src/nimib.nim

@@ -58,7 +58,7 @@ template nbInit*(theme = themes.useDefault, backend = renders.useHtmlBackend, th
   # apply theme
   theme nb
 
-template nbInitMd*(thisFileRel = "") = 
+template nbInitMd*(thisFileRel = "") =
   var tfr = if thisFileRel == "":
       instantiationInfo(-1).filename
     else:
@@ -69,6 +69,12 @@ template nbInitMd*(thisFileRel = "") =
   if nb.options.filename == "":
     nb.filename = nb.filename.splitFile.name & ".md"
 
+template enableLineNumbersDoc* =
+  nb.context["enableLineNumbers"] = true
+
+template enableLineNumbersBlock* =
+  nb.blk.context["enableLineNumbers"] = true
+
 # block generation templates
 template newNbCodeBlock*(cmd: string, body, blockImpl: untyped) =
   newNbBlock(cmd, true, nb, nb.blk, body, blockImpl)
@@ -87,6 +93,11 @@ template nbCodeSkip*(body: untyped) =
   newNbCodeBlock("nbCodeSkip", body):
     discard
 
+template nbCodeWithNumbers*(body: untyped) =
+  newNbCodeBlock("nbCode", body):
+    captureStdout(nb.blk.output):
+      body
+
 template nbCapture*(body: untyped) =
   newNbCodeBlock("nbCapture", body):
     captureStdout(nb.blk.output):
@@ -117,13 +128,13 @@ template nbImage*(url: string, caption = "", alt = "") =
         url
       else:
         nb.context["path_to_root"].vString / url
-        
-    nb.blk.context["alt_text"] = 
+
+    nb.blk.context["alt_text"] =
       if alt == "":
         caption
       else:
         alt
-        
+
     nb.blk.context["caption"] = caption
 
 template nbFile*(name: string, content: string) =
@@ -155,7 +166,7 @@ when moduleAvailable(nimpy):
 template nbShow*(obj: untyped) =
   nbRawHtml(obj.toHtml())
 
-template nbRawOutput*(content: string) {.deprecated: "Use nbRawHtml instead".} = 
+template nbRawOutput*(content: string) {.deprecated: "Use nbRawHtml instead".} =
   nbRawHtml(content)
 
 template nbRawHtml*(content: string) =

src/nimib/renders.nim

@@ -1,4 +1,4 @@
-import std / [strutils, tables, sugar, os, strformat, sequtils]
+import std / [strutils, tables, sugar, sequtils]
 import ./types, ./jsutils, markdown, mustache
 
 import highlight
@@ -10,6 +10,23 @@ proc mdOutputToHtml(doc: var NbDoc, blk: var NbBlock) =
 proc highlightCode(doc: var NbDoc, blk: var NbBlock) =
   blk.context["codeHighlighted"] = highlightNim(blk.code)
 
+proc addLineNumbersToHighlightedCode(code: string): string =
+  let nlines = code.splitLines().len
+  # var lineNumbers: seq[string] = @[] # newSeqOfCap(nlines)
+  for i in 1..nlines:
+    ## We have line numbers in the same line than code
+    result.add("""<span class="hljs-comment"> """ & $i & "</span> " & code.splitlines()[i-1] & "\n")
+    ## but we can not copy-paste code without the numbers
+  # The following separates line numbers from code, but display is wrong
+  # result = """ <div>
+  #                 <code>""" & lineNumbers.join("") & """</code>
+  #                 <code>""" & code & """</code>
+  #              </div>
+  #          """
+
+proc addLineNumbers(doc: var NbDoc, blk: var NbBlock) =
+  if blk.context["enableLineNumbers"].castBool or doc.context["enableLineNumbers"].castBool:
+    blk.context["codeHighlighted"] = addLineNumbersToHighlightedCode(blk.context["codeHighlighted"].castStr)
 
 proc useHtmlBackend*(doc: var NbDoc) =
   doc.partials["nbText"] = "{{&outputToHtml}}"
@@ -45,14 +62,15 @@ proc useHtmlBackend*(doc: var NbDoc) =
   # I prefer to initialize here instead of in nimib (each backend should re-initialize)
   doc.renderPlans = initTable[string, seq[string]]()
   doc.renderPlans["nbText"] = @["mdOutputToHtml"]
-  doc.renderPlans["nbCode"] = @["highlightCode"] # default partial automatically escapes output (code is escaped when highlighting)
-  doc.renderPlans["nbCodeSkip"] = @["highlightCode"]
+  doc.renderPlans["nbCode"] = @["highlightCode", "addLineNumbers"] # default partial automatically escapes output (code is escaped when highlighting)
+  doc.renderPlans["nbCodeSkip"] = @["highlightCode", "addLineNumbers"]
   doc.renderPlans["nbJsFromCodeOwnFile"] = @["compileNimToJs", "highlightCode"]
   doc.renderPlans["nbJsFromCode"] = @["highlightCode"]
   doc.renderPlans["nimibCode"] = doc.renderPlans["nbCode"]
 
   doc.renderProcs = initTable[string, NbRenderProc]()
   doc.renderProcs["mdOutputToHtml"] = mdOutputToHtml
+  doc.renderProcs["addLineNumbers"] = addLineNumbers
   doc.renderProcs["highlightCode"] = highlightCode
   doc.renderProcs["compileNimToJs"] = compileNimToJs
 

tests/tcodeLines.nim

@@ -0,0 +1,11 @@
+import nimib
+import unittest
+
+suite "test sources":
+  nbInit()
+  enableLineNumbersDoc()
+  nbCode:
+    # a comment
+    let
+      x = 1
+  nbSave()