CI JS (#64)

Author: juancarlospaco

.github/workflows/ci.yml

@@ -35,6 +35,7 @@ jobs:
     name: '${{ matrix.target.os }}-${{ matrix.target.cpu }} (${{ matrix.branch }})'
     runs-on: ${{ matrix.builder }}
     steps:
+      - uses: actions/setup-node@v2
       - name: Checkout fusion
         uses: actions/checkout@v2
         with:
@@ -131,17 +132,3 @@ jobs:
           target_branch: gh-pages
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Cache choosenim
-        id: cache-choosenim
-        uses: actions/cache@v1
-        with:
-          path: ~/.choosenim
-          key: ${{ runner.os }}-choosenim-devel-latest
-
-      - name: Cache nimble
-        id: cache-nimble
-        uses: actions/cache@v1
-        with:
-          path: ~/.nimble
-          key: ${{ runner.os }}-nimble-devel-latest

fusion.nimble

@@ -11,6 +11,8 @@ srcDir        = "src"
 requires "nim >= 1.0.0"
 
 task docs, "":
-  # can customize, e.g.:
-  # exec "nim r src/fusion/docutils " & srcDir & " --outdir:htmldocs2 -d:foo"
+  # JavaScript
+  when (NimMajor, NimMinor) >= (1, 5):
+    exec "nim c -r -d:fusionDocJs src/fusion/docutils " & srcDir
+  # C
   exec "nim c -r src/fusion/docutils " & srcDir

src/fusion/docutils.nim

@@ -1,13 +1,18 @@
-import std/[os, strformat, sugar, osproc]
+import std/[os, sugar, strutils, osproc]
 import std/private/globs
 
 
-const blockList =
-  when not defined(js): ["nimcache", "htmldocs", "js"]
-  else: ["nimcache", "htmldocs"]
+const
+  blockList = ["nimcache", "htmldocs"] # Folders to explicitly ignore.
+  baseCmd = " doc --project --docroot --outdir:htmldocs --styleCheck:hint " # nim doc command part that never changes
+  jsDocOpts =  # nim doc command part that changes for JS compat.
+    when defined(fusionDocJs): "-b:js "
+    else: ""
+  docComand = baseCmd & jsDocOpts
+
 
 iterator findNimSrcFiles*(dir: string): string =
-  proc follow(a: PathEntry): bool =
+  func follow(a: PathEntry): bool =
     a.path.lastPathPart notin blockList
 
   for entry in walkDirRecFilter(dir, follow = follow):
@@ -17,18 +22,24 @@ iterator findNimSrcFiles*(dir: string): string =
 
 proc genCodeImportAll*(dir: string): string =
   result = "{.warning[UnusedImport]: off.}\n"
-  for a in findNimSrcFiles(dir):
-    let s = "".dup(addQuoted(a))
-    result.add &"import {s}\n"
+  var name, prefix: string
+  for nimfile in findNimSrcFiles(dir):
+    name = nimfile.extractFilename
+    prefix =
+      if name.startsWith "js":
+        "when defined(js): import "
+      else:
+        "when not defined(js): import "
+    result.add prefix & "".dup(addQuoted(nimfile)) & "\n"
 
 
 proc genDocs(dir: string, nim = "", args: seq[string]) =
   let code = genCodeImportAll(dir)
   let extra = quoteShellCommand(args)
   let nim = if nim.len == 0: getCurrentCompilerExe() else: nim
-  let ret = execCmdEx(fmt"{nim} doc -r --project --docroot --outdir:htmldocs {extra} -", input = code)
+  let ret = execCmdEx(nim & docComand & extra & " - ", input = code)
   if ret.exitCode != 0:
-    doAssert false, ret.output & "\n" & code
+    doAssert false, ret.output & '\n' & code
 
 
 when isMainModule:

src/fusion/js/jsheaders.nim

@@ -1,5 +1,5 @@
 ## - HTTP Headers for the JavaScript target: https://developer.mozilla.org/en-US/docs/Web/API/Headers
-when not defined(js) and not defined(nimdoc):
+when not defined(js):
   {.fatal: "Module jsheaders is designed to be used with the JavaScript backend.".}
 
 type Headers* = ref object of JsRoot ## HTTP Headers for the JavaScript target.

src/fusion/js/jssets.nim

@@ -1,6 +1,6 @@
 ## `Set` for the JavaScript target.
 ## * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
-when not defined(js) and not defined(nimdoc):
+when not defined(js):
   {.fatal: "Module jssets is designed to be used with the JavaScript backend.".}
 
 import std/jsffi

src/fusion/js/jsxmlserializer.nim

@@ -1,5 +1,5 @@
 ## - `XMLSerializer` for the JavaScript target: https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer
-when not defined(js) and not defined(nimdoc):
+when not defined(js):
   {.fatal: "Module jsxmlserializer is designed to be used with the JavaScript backend.".}
 
 from std/dom import Node

src/fusion/matching.nim

@@ -2154,7 +2154,7 @@ macro match*(n: untyped): untyped =
       # `mixinList`
       `pos`
       let expr {.inject.} = `head`
-      let pos {.inject.}: int = 0
+      let pos {.inject, used.}: int = 0
       `matchcase`
 
   # echo result.repr

tests/config.nims

@@ -1 +1,2 @@
 switch("path", "$projectDir/../src")
+switch("styleCheck", "hint")

tests/tmatching.nim

@@ -1,8 +1,11 @@
 import std/[strutils, sequtils, strformat, sugar,
-            macros, options, tables, json, algorithm]
+            macros, options, tables, json]
 
 import fusion/matching
 {.experimental: "caseStmtMacros".}
+{.push hint[XDeclaredButNotUsed]: off.}
+{.push hint[ConvFromXtoItselfNotNeeded]: off.}
+{.push hint[CondTrue]: off.}
 
 import unittest