add OOP class usage + test | fix typo in comments

georgelemon · georgelemon · commit 739e532829b4 · 2026-04-15T23:37:13.000+03:00
Signed-off-by: George Lemon &lt;georgelemon@protonmail.com&gt;
diff --git a/src/denim.nim b/src/denim.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 when defined napibuild:
   # Denim as a library exporting NAPI bindings
diff --git a/src/denim.nims b/src/denim.nims
@@ -1,4 +1,6 @@
---passC:"-I/usr/include/node -I/usr/local/include/node"
+when not defined(windows):
+  --passC:"-I/usr/include/node -I/usr/local/include/node"
+
 --gc:arc
 --define:danger
 --opt:size
diff --git a/src/denimpkg/commands/build.nim b/src/denimpkg/commands/build.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import std/[os, osproc, json, strutils]
 import kapsis/runtime
@@ -67,14 +67,14 @@ proc buildCommand*(v: Values) =
   if not isEmptyDir(addonPathDirectory):
     if not v.has("-y"):
       displayInfo("Directory is not empty: " & os.splitPath(addonPathDirectory).tail)
-      if promptConfirm("👉 Do you want to remove current contents? (y/N)"):
+      if promptConfirm("Do you want to remove current contents? (y/N)"):
         os.removeDir(addonPathDirectory)
       else:
         display("Canceled", indent=2, br="after")
         QuitFailure.quit
     else:
       os.removeDir(addonPathDirectory)
-  displayInfo("🔥 Running Nim Compiler")
+  displayInfo("Running Nim Compiler")
     
   var args = @[
     "--nimcache:$1",
@@ -109,7 +109,7 @@ proc buildCommand*(v: Values) =
   ], options={poStdErrToStdOut, poUsePath})
   
   if v.has("--cmake"):
-    displayInfo("✨ Building with CMake.js")
+    displayInfo("Building with CMake.js")
 
     # cmake - add target libs, if any
     var denimLinkLibs: seq[string]
@@ -128,25 +128,36 @@ proc buildCommand*(v: Values) =
         )
       )
     )
+    # Build the native addon using CMake.js
     let cmakeCmd = execCmdEx("cmake-js compile --runtime node --out " & "denim_build" / "build")
     if cmakeCmd.exitCode != 0:
       display(cmakeCmd.output)
       QuitFailure.quit
     elif v.has("--verbose"):
       display(cmakeCmd.output)
   else:
-    displayInfo("✨ Building with node-gyp")
-    var
-      gyp = %* {"targets": [getNodeGypConfig(getNimPath.output.strip, v.has("-r"))]}
-      jsonConfigPath = cachePathDirectory / entryFile.replace(".nim", ".json")
-    var
-      jarr = newJArray()
-      jsonConfigContents = parseJson(readFile(jsonConfigPath))
+    # When using `node-gyp`, we need to generate a `binding.gyp` file with
+    # the correct configuration
+    displayInfo("Building with node-gyp")
+    var gyp = %* {"targets": [getNodeGypConfig(getNimPath.output.strip, v.has("-r"))]}
+    let jsonConfigPath = cachePathDirectory / entryFile.replace(".nim", ".json")
+    
+    var jarr = newJArray()
+    let jsonConfigContents = parseJson(readFile(jsonConfigPath))
+    
     for elem in items(jsonConfigContents["compile"].elems):
       jarr.add(newJString(elem[0].getStr().replace(addonPathDirectory / "", "")))
+    
+    # Set the source files in the `binding.gyp` configuration
     gyp["targets"][0]["sources"] = %* jarr
+    
+    # Write `binding.gyp` file for node-gyp
     writeFile(addonPathDirectory / "binding.gyp", pretty(gyp, 2))
+    
+    # Build the native addon using node-gyp
     let gypCmd = execCmdEx("node-gyp rebuild --directory=" & addonPathDirectory)
+    
+    # Check if the build was successful
     if gypCmd.exitCode != 0:
       display(gypCmd.output)
       QuitFailure.quit
@@ -163,10 +174,10 @@ proc buildCommand*(v: Values) =
     binaryTargetPath = binDirectory / binName
 
   if fileExists(binaryNodePath) == false:
-    displayError("👉 Oups! $1 not found. Try build again" % [binName])
+    displayError("Oups! $1 not found. Try build again" % [binName])
     QuitFailure.quit
   else:
     discard existsOrCreateDir(binDirectory)              # ensure bin directory exists
     moveFile(binaryNodePath, binaryTargetPath)           # move .node addon
-    displaySuccess("👌 Done! Check your `bin` directory")
+    displaySuccess("Done! Check your `bin` directory")
     displayInfo(binDirectory)
diff --git a/src/denimpkg/commands/new.nim b/src/denimpkg/commands/new.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import kapsis/runtime
 import kapsis/interactive/prompts
diff --git a/src/denimpkg/commands/publish.nim b/src/denimpkg/commands/publish.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import kapsis/runtime
 import kapsis/interactive/prompts
diff --git a/src/denimpkg/napi/jsnative_api.nim b/src/denimpkg/napi/jsnative_api.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 type
   napi_env* {.header:"<node_api.h>".} = pointer
diff --git a/src/denimpkg/napi/node_bindings.nim b/src/denimpkg/napi/node_bindings.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import std/macros
 
diff --git a/src/denimpkg/napi/utils.nim b/src/denimpkg/napi/utils.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 iterator enumerate*[T](open: openarray[T]): (int, T) =
   var ct = 0
diff --git a/src/denimpkg/nodeapi.nim b/src/denimpkg/nodeapi.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import std/[macros, strutils, sequtils, tables]
 import std/json except `%*`
diff --git a/src/denimpkg/utils.nim b/src/denimpkg/utils.nim
@@ -8,7 +8,7 @@
 #
 # (c) 2026 George Lemon | MIT License
 #          Made by Humans from OpenPeeps
-#          https://github.com/openpeeps/tim
+#          https://github.com/openpeeps/denim
 
 import std/[os, sequtils]
 
diff --git a/tests/example_class.nim b/tests/example_class.nim
@@ -0,0 +1,36 @@
+import denim
+import std/json except `%*`
+
+proc userHello(environment: napi_env, info: napi_callback_info): napi_value {.cdecl.} =
+  Env = environment
+  result = %* "Hello from User.hello()"
+
+proc userCtor(environment: napi_env, info: napi_callback_info): napi_value {.cdecl.} =
+  Env = environment
+  var
+    argc: csize_t = 0
+    thisObj: napi_value
+
+  # get `this` created by `new User()`
+  assert environment.napi_get_cb_info(info, addr argc, nil, cast[napi_value](addr thisObj), nil)
+  result = thisObj
+
+init proc(module: Module) =
+  var userClass: napi_value
+  let classIdent = "User"
+  var props = [
+    NapiPropertyDescriptor(
+      utf8name: "hello",
+      `method`: userHello,
+      attributes: napi_default
+    )
+  ]
+
+  assert module.env.napi_define_class(classIdent,
+    len(classIdent).csize_t, userCtor, nil,
+    props.len.csize_t,
+    cast[ptr NapiPropertyDescriptor](unsafeAddr props[0]),
+    userClass.addr
+  )
+
+  module.register(classIdent, userClass)
diff --git a/tests/js/example_class.js b/tests/js/example_class.js
@@ -0,0 +1,4 @@
+const { User } = require('../../bin/example_class.node')
+
+const x = new User()
+console.log(x.hello()) // Hello from User.hello()
diff --git a/tests/test1.nim b/tests/test1.nim
@@ -9,7 +9,7 @@ when not defined skipbuild:
   #       echo status.output
   #     else:
   #       echo "[OK] " & addonName & ".nim"
-  #     assert status.exitCode == 0
+  #     check status.exitCode == 0
 
   test "can build addons with CMake":
     for addonName in addons:
@@ -20,25 +20,30 @@ when not defined skipbuild:
         echo status.output
       else:
         echo "[OK] " & addonName & ".nim"
-      assert status.exitCode == 0
+      check status.exitCode == 0
 
 test "can run myaddon (NodeJS)":
   let status = execCmdEx("node " & "tests" / "js" / "myaddon.js")
   let hello = status.output.strip()
   echo hello
-  assert hello == "Hello, World! from Nim. This is awesome!"
-  assert status.exitCode == 0
+  check hello == "Hello, World! from Nim. This is awesome!"
+  check status.exitCode == 0
 
 test "can run mypromise (NodeJS)":
   let status = execCmdEx("node " & "tests" / "js" / "mypromise.js")
   echo status.output.strip()
-  assert status.exitCode == 0
+  check status.exitCode == 0
 
 test "can run myobject (NodeJS)":
   let status = execCmdEx("node " & "tests" / "js" / "myobject.js")
   echo status.output.strip()
-  assert status.exitCode == 0
+  check status.exitCode == 0
 
 test "can run myexceptions (NodeJS)":
   let status = execCmdEx("node " & "tests" / "js" / "myexceptions.js")
-  assert status.exitCode == 1
+  check status.exitCode == 1
+
+test "can run OOP class example (NodeJS)":
+  let status = execCmdEx("node " & "tests" / "js" / "example_class.js")
+  check status.output.strip() == "Hello from User.hello()"
+  check status.exitCode == 0

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`#`
`9`	`9`	`# (c) 2026 George Lemon \| MIT License`
`10`	`10`	`# Made by Humans from OpenPeeps`
`11`		`-# https://github.com/openpeeps/tim`
	`11`	`+# https://github.com/openpeeps/denim`
`12`	`12`
`13`	`13`	`when defined napibuild:`
`14`	`14`	`# Denim as a library exporting NAPI bindings`