libdragon 12.0.0 → 12.0.2

package/README.md

@@ -6,7 +6,7 @@ This is a wrapper for a docker container to make managing the libdragon toolchai
 
 ## Prerequisites
 
-You should have [docker](https://www.docker.com/products/docker-desktop) (`>= 27.2.0`) && [git](https://git-scm.com/downloads) installed on your system.
+You should have [docker](https://www.docker.com/products/docker-desktop) (`>= 27.2.0`) and [git](https://git-scm.com/downloads) installed on your system.
 
 ## Installation
 
@@ -289,6 +289,17 @@ To create your own dev container backed project, you can use the contents of the
   - It will prepare the container and open it in the editor.
 </details>
 
+## As an NPM dependency
+
+You can install libdragon as an NPM dependency by `npm install libdragon --save` in order to use docker in your N64 projects. A `libdragon` command similar to global installation is provided that can be used in your NPM scripts as follows;
+```json
+"scripts": {
+    "prepare": "libdragon init"
+    "build": "libdragon make",
+    "clean": "libdragon make clean"
+}
+```
+
 ## Funding
 
 If this tool helped you, consider supporting its development by sponsoring it!

package/modules/actions/exec.js

@@ -66,22 +66,24 @@ const exec = async (info) => {
   const stdin = new PassThrough();
 
   /** @type {string[]} */
-  const paramsWithConvertedPaths = await Promise.all(
-    parameters.map(async (item) => {
-      if (item.startsWith('-')) {
+  const paramsWithConvertedPaths = (
+    await Promise.all(
+      parameters.map(async (item) => {
+        if (item.startsWith('-')) {
+          return item;
+        }
+        if (
+          item.includes(path.sep) &&
+          ((await fileExists(item)) || (await dirExists(item)))
+        ) {
+          return toPosixPath(
+            path.isAbsolute(item) ? path.relative(process.cwd(), item) : item
+          );
+        }
         return item;
-      }
-      if (
-        item.includes(path.sep) &&
-        ((await fileExists(item)) || (await dirExists(item)))
-      ) {
-        return toPosixPath(
-          path.isAbsolute(item) ? path.relative(process.cwd(), item) : item
-        );
-      }
-      return item;
-    })
-  );
+      })
+    )
+  ).map((param) => `"${param}"`);
 
   /**
    *

package/modules/actions/start.js

@@ -34,12 +34,13 @@ const initContainer = async (libdragonInfo) => {
         'run',
         '-d', // Detached
         '--mount',
-        'type=bind,source=' +
+        '"type=bind,source=' +
           libdragonInfo.root +
           ',target=' +
-          CONTAINER_TARGET_PATH, // Mount files
-        '-w=' + CONTAINER_TARGET_PATH, // Set working directory
-        libdragonInfo.imageName,
+          CONTAINER_TARGET_PATH +
+          '"', // Mount files
+        '"-w=' + CONTAINER_TARGET_PATH + '"', // Set working directory
+        '"' + libdragonInfo.imageName + '"',
         'tail',
         '-f',
         '/dev/null',

package/modules/helpers.js

@@ -188,6 +188,11 @@ function spawnProcess(
         // Prevent the annoying docker "What's next?" message. It messes up everything.
         DOCKER_CLI_HINTS: 'false',
       },
+      // On macos, we need to run the command in a shell for some docker commands
+      // to work properly. The ones with paths in them probably not working on
+      // macOS. No need to do this on Windows, as it'd now require additional
+      // escaping for the paths.
+      // shell: process.platform === 'darwin',
       shell: true,
       ...spawnOptions,
     });

package/modules/project-info.js

@@ -91,7 +91,7 @@ async function findContainerId(libdragonInfo) {
       '--format',
       '{{.}}{{.ID}}',
       '-f',
-      'volume=' + CONTAINER_TARGET_PATH,
+      '"volume=' + CONTAINER_TARGET_PATH + '"',
     ])
   )
     .split('\n')

package/modules/utils.js

@@ -133,7 +133,7 @@ async function runGit(libdragonInfo, params, options = {}) {
 
   return await spawnProcess(
     'git',
-    ['-C', libdragonInfo.root, ...params],
+    ['-C', '"' + libdragonInfo.root + '"', ...params],
     // Windows git is breaking the TTY somehow - disable TTY for now
     // We are not able to display progress for the initial clone b/c of this
     // Enable progress otherwise.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libdragon",
-  "version": "12.0.0",
+  "version": "12.0.2",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {