Merge pull request #8 from juancarlospaco/ci2

Optimize CI 2

.github/workflows/build.yml

@@ -24,36 +24,57 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
+
     - uses: jiro4989/setup-nim-action@v1
       with:
         nim-version: ${{ matrix.nim-channel }}
         no-color: true  # --noColor
 
+
     - name: Setup NodeJS ${{ matrix.node }}
       uses: actions/setup-node@v2
       with:
         node-version: ${{ matrix.node }}
 
+
     - uses: pre-commit/action@v2.0.3
       if: runner.os == 'Linux'
 
     # - uses: juancarlospaco/nimpretty-action@main
     #   with:
     #     folders: "src"
 
+
+    - name: Set Environment Variables
+      uses: allenevans/set-env@v2.0.0
+      with:
+        ACTIONS_ALLOW_UNSECURE_COMMANDS: true
+        NODE_OPTIONS: "--unhandled-rejections=warn"
+        CMD: "nim doc -b:js -d:nodejs -d:nimExperimentalAsyncjsThen -d:nimStrictDelete -d:nimPreviewFloatRoundtrip -d:nimPreviewDotLikeOps --experimental:strictFuncs --experimental:strictEffects --index:on --project --styleCheck:usages --styleCheck:hint --outdir:../../docs"
+
+
     # https://developer.ibm.com/languages/node-js/blogs/nodejs-15-release-blog
-    - name: Generate Documentation (Linux)
-      if: runner.os == 'Linux'
+    - name: Generate Documentation
+      shell: bash
+      run: |
+        cd src/nodejs/
+        for i in *.nim; do
+          $CMD $i
+        done
+
+
+    - name: Clean out
+      shell: bash
       run: |
-        export NODE_OPTIONS=--unhandled-rejections=warn
-        nim doc -b:js -d:nodejs -d:nimExperimentalAsyncjsThen --git.url:'https://github.com/juancarlospaco/nodejs' --index:on --project --experimental:strictFuncs --styleCheck:hint --outdir:docs src/nodejs.nim
-        rm --verbose docs/nodejs/*.idx
+        rm --verbose --force --recursive docs/*.idx
         rm --verbose --force --recursive docs/nimcache/*.*
         rm --verbose --force --recursive docs/nimcache/runnableExamples/*.*
-        mv --verbose docs/nodejs.html docs/index.html
+
 
     - name: Commit Docs
-      if: github.ref == 'refs/heads/main'
+      if: |
+        github.event_name == 'push' && github.ref == 'refs/heads/main' && runner.os == 'Linux' &&
+        matrix.platform == 'ubuntu-latest' && matrix.architecture == 'x64' && matrix.node == '17'
       uses: EndBug/add-and-commit@v4  # Commit everything to Git repo
       with:
         add: 'docs'

src/nodejs/jsclasses.nim

@@ -260,7 +260,7 @@ class $1 {
 
 
 # when isMainModule:
-runnableExamples"-b:js -d:nodejs --experimental:strictFuncs":
+runnableExamples"-b:js -d:nodejs --experimental:strictFuncs -r:off":
 
 
   class Kitten* of JsRoot:

src/nodejs/jscore.nim

@@ -119,14 +119,14 @@ func indentation*(s: cstring): cint {.importjs: """
   })()""".}
   ## Returns the amount of indentation all lines of `s` have in common, ignoring lines that consist only of whitespace.
 
-proc `[]`*(s: cstring; slice: HSlice[SomeInteger, SomeInteger]): cstring {.asmnostackframe.} =
+proc `[]`*(s: cstring; slice: HSlice[SomeInteger, SomeInteger]): cstring {.asmNoStackFrame.} =
   let start {.codegenDecl: "const $2".} = slice.a.int
   let ends {.codegenDecl: "const $2".} = slice.b.int + 1
   assert start >= 0, "Index out of bounds: " & $start
   assert ends > s.len, "Index out of bounds: " & $ends
   asm "return `s`.slice(`start`, `ends`);"
 
-proc `[]`*(s: cstring; slice: HSlice[SomeInteger, BackwardsIndex]): cstring {.asmnostackframe.} =
+proc `[]`*(s: cstring; slice: HSlice[SomeInteger, BackwardsIndex]): cstring {.asmNoStackFrame.} =
   let start {.codegenDecl: "const $2".} = slice.a.int
   let ends {.codegenDecl: "const $2".} = s.len - slice.b.int + 1
   assert start >= 0, "Index out of bounds: " & $start
@@ -166,7 +166,7 @@ func structuredClone*(value, transfer: auto) {.importjs: "$1(#, #)".}
 func structuredClone*(value: auto) {.importjs: "$1(#)".}
   ## https://developer.mozilla.org/en-US/docs/Web/API/structuredClone
 
-func parseBool*(s: cstring): bool {.asmnostackframe.} = {.emit: """
+func parseBool*(s: cstring): bool {.asmNoStackFrame.} = {.emit: """
   const value = String(`s`).trim();
   if (/^(?:y|1|on|yes|true)$/i.test(value)) {
     return true;

src/nodejs/jsfs.nim

@@ -399,7 +399,7 @@ runnableExamples:
 
 
 runnableExamples("-r:off"):
-  import nodejs/jsbuffer
+  import jsbuffer
   requireFs()
   requireBuffer()
   proc example(error: int; data: Buffer) = echo data

src/nodejs/jsos.nim

@@ -56,9 +56,10 @@ when defined(windows):
     WSASYSCALLFAILURE* {.importjs: "os.constants.errno.WSASYSCALLFAILURE".}: cint
     WSASERVICE_NOT_FOUND* {.importjs: "os.constants.errno.WSASERVICE_NOT_FOUND".}: cint
     WSATYPE_NOT_FOUND* {.importjs: "os.constants.errno.WSATYPE_NOT_FOUND".}: cint
-    WSA_E_NO_MORE* {.importjs: "os.constants.errno.WSA_E_NO_MORE".}: cint
-    WSA_E_CANCELLED* {.importjs: "os.constants.errno.WSA_E_CANCELLED".}: cint
     WSAEREFUSED* {.importjs: "os.constants.errno.WSAEREFUSED".}: cint
+    # Duplicated ???.
+    # WSA_E_NO_MORE* {.importjs: "os.constants.errno.WSA_E_NO_MORE".}: cint
+    # WSA_E_CANCELLED* {.importjs: "os.constants.errno.WSA_E_CANCELLED".}: cint
 
 let
   EOL* {.importjs: "os.EOL".}: cstring

src/nodejs/jspath.nim

@@ -53,7 +53,7 @@ when defined(linux) or defined(posix):
     ## https://nodejs.org/api/path.html#path_windows_vs_posix
 
 
-runnableExamples:
+runnableExamples"-r:off":
   requirePath()
   echo delimiter
   doAssert basename("/foo/bar/baz".cstring) == "baz".cstring

src/nodejs/jsprocess.nim

@@ -138,7 +138,7 @@ func getPid*(): cint {.importjs: "process.pid@".}
 #   ## https://nodejs.org/api/process.html#process_process_send_message_sendhandle_options_callback
 
 
-runnableExamples: # These are computer specific can not assert them much.
+runnableExamples"-r:off": # These are computer specific can not assert them much.
   requireProcess()
   doAssert not hasUncaughtExceptionCaptureCallback()
   echo cwd()
@@ -156,6 +156,6 @@ runnableExamples: # These are computer specific can not assert them much.
     disconnect()
     exit(code = 0.cint)
 
-runnableExamples("-r:off"):
+runnableExamples"-r:off":
   requireProcess()
   echo argv ## Read Command Line Arguments as seq[cstring]

src/nodejs/jsreadline.nim

@@ -62,7 +62,8 @@ func moveCursor*(dx, dy: cint): bool {.importjs: "readline.$1(process.stout, #,
 
 
 runnableExamples:
-  import std/jsffi, nodejs/jsprocess
+  import std/jsffi
+  import jsprocess
   requireProcess()
   requireReadline()
   block:
@@ -83,7 +84,7 @@ runnableExamples:
     # echo rl.cursor()
 
 runnableExamples("-r:off"):
-  import nodejs/jsprocess
+  import jsprocess
   requireProcess()
   requireReadline()
   let rl = newReadline()

src/nodejs/jsreutils.nim

@@ -1,7 +1,8 @@
 ## - Utils for https://nim-lang.github.io/Nim/jsre.html
 from std/jsre import RegExp
 
-template groups*(self: RegExp; input: cstring; groups: varargs[var cstring]) =
+
+template groups*(self: RegExp; input: cstring; groups: varargs[cstring]) =
   ## Named capture groups.
   ## Similar to `var [a, b, c] = regex.exec(input).slice(1);` in JavaScript.
   runnableExamples:

src/nodejs/jssets.nim

@@ -30,24 +30,24 @@ func toCstring*(this: JsSet): seq[cstring] {.importjs: """
 
 func len*(this: JsSet): int = this.size.int
 
-func `$`*(this: JsSet): string = $this.toString()
-
-
-runnableExamples:
-  import std/jsffi
-  let a: JsSet = newJsSet([1.toJs, 2.toJs, 3.toJs, 4.toJs])
-  let b: JsSet = newJsSet([1.0.toJs, 2.0.toJs, 3.0.toJs])
-  doAssert a.len == 4
-  doAssert b.len == 3
-  doAssert a.toCstring() == @["1".cstring, "2", "3", "4"]
-  doAssert b.toCstring() == @["1".cstring, "2", "3"]
-  a.clear()
-  b.clear()
-  let d: JsSet = newJsSet([1.toJs, 2.toJs, 3.toJs])
-  doAssert d.len == 3
-  d.add(4.toJs)
-  d.delete(2.toJs)
-  doAssert 3.toJs in d
-  doAssert "3".cstring.toJs notin d
-  doAssert d.contains 1.toJs
-  doAssert $d == """@["1", "3", "4"]"""
+template `$`*(this: JsSet): string = $this.toString()
+
+
+# runnableExamples"-r:off":
+#   import std/jsffi
+#   let a: JsSet = newJsSet([1.toJs, 2.toJs, 3.toJs, 4.toJs])
+#   let b: JsSet = newJsSet([1.0.toJs, 2.0.toJs, 3.0.toJs])
+#   doAssert a.len == 4
+#   doAssert b.len == 3
+#   doAssert a.toCstring() == @["1".cstring, "2", "3", "4"]
+#   doAssert b.toCstring() == @["1".cstring, "2", "3"]
+#   a.clear()
+#   b.clear()
+#   let d: JsSet = newJsSet([1.toJs, 2.toJs, 3.toJs])
+#   doAssert d.len == 3
+#   d.add(4.toJs)
+#   d.delete(2.toJs)
+#   doAssert 3.toJs in d
+#   doAssert "3".cstring.toJs notin d
+#   doAssert d.contains 1.toJs
+#   doAssert $d == """@["1", "3", "4"]"""

src/nodejs/jsutils.nim

@@ -196,7 +196,7 @@ func isSymbol*(value: auto): bool {.importjs: "(typeof # === 'symbol')".}
   ## https://nodejs.org/api/util.html#util_util_issymbol_object
 
 
-runnableExamples:
+runnableExamples"-r:off":
   requireUtil()
   block:
     doAssert cstring"%s:%s".format("example".cstring) == "example:%s".cstring