libdragon 11.4.4 → 12.0.1

package/README.md

@@ -6,9 +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`) installed on your system.
-
-`git` is not strictly required to use the tool. Still, it is highly recommended to have git on your host machine as it will be used instead of the one in the container.
+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
 
@@ -65,7 +63,7 @@ Download the [pre-built executable](https://github.com/anacierdem/libdragon-dock
 
 ### via NPM
 
-Install [node.js](https://nodejs.org/en/download/) (`>= 18`) and install `libdragon` as a global NPM package;
+Install [node.js](https://nodejs.org/en/download/) (`>= 22`) and install `libdragon` as a global NPM package;
 
 ```bash
 npm install -g libdragon
@@ -291,15 +289,9 @@ 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>
 
-## Dependency management
-
-> [!WARNING]
-> This is an experimental feature.
-
-### 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 intallation is provided that can be used in your NPM scripts as follows;
+## 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"
@@ -308,33 +300,6 @@ You can install libdragon as an NPM dependency by `npm install libdragon --save`
 }
 ```
 
-See [here](https://github.com/anacierdem/ed64-example) for a full example.
-
-### Developing a dependency
-
-You can make an NPM package that a `libdragon` project can depend on. Just include a `Makefile` on the repository root with a default recipe and an `install` recipe. On the depending project, after installing libdragon and the dependency with `npm install <dep name> --save`, one can install libdragon dependencies on the current docker container using `package.json` scripts.
-
-For example this `package.json` in the dependent project;
-
-```json
-{
-    "name": "libdragonDependentProject",
-    "version": "1.0.0",
-    "description": "...",
-    "scripts": {
-        "build": "libdragon make",
-        "clean": "libdragon make clean",
-        "prepare": "libdragon init"
-    },
-    "dependencies": {
-        "libdragon": <version>,
-        "ed64": <version>
-    }
-}
-```
-
-will init the container for this project and run `make && make install` for `ed64` upon running `npm install`. To develop a dependency [this](https://github.com/anacierdem/libdragon-dependency) is a good starting point.
-
 ## Funding
 
 If this tool helped you, consider supporting its development by sponsoring it!

package/index.js

@@ -33,7 +33,7 @@ const { readProjectInfo, writeProjectInfo } = require('./modules/project-info');
 // This is overridden when building for SEA. When running from local or NPM,
 // the package.json version is used by the version action. esbuild will give
 // a warning for this assignment, but it works as expected.
-globalThis.VERSION = "";
+globalThis.VERSION = '';
 
 parseParameters(process.argv)
   .then(readProjectInfo)

package/modules/actions/init.js

@@ -10,7 +10,7 @@ const {
   installDependencies,
   initGitAndCacheContainerId,
   updateImage,
-  runGitMaybeHost,
+  runGit,
   destroyContainer,
   ensureGit,
 } = require('../utils');
@@ -61,15 +61,11 @@ const autoDetect = async (info) => {
 
   if (
     vendorTargetExists &&
-    (await runGitMaybeHost(
-      info,
-      ['submodule', 'status', info.vendorDirectory],
-      {
-        inheritStdin: false,
-        inheritStdout: false,
-        inheritStderr: false,
-      }
-    ).catch((e) => {
+    (await runGit(info, ['submodule', 'status', info.vendorDirectory], {
+      inheritStdin: false,
+      inheritStdout: false,
+      inheritStderr: false,
+    }).catch((e) => {
       if (!(e instanceof CommandError)) {
         throw e;
       }
@@ -80,7 +76,7 @@ const autoDetect = async (info) => {
   }
 
   if (vendorTargetExists) {
-    const gitLogs = await runGitMaybeHost(info, ['log'], {
+    const gitLogs = await runGit(info, ['log'], {
       inheritStdin: false,
       inheritStdout: false,
       inheritStderr: false,
@@ -161,7 +157,7 @@ const autoVendor = async (info) => {
 
   if (info.vendorStrategy === 'submodule') {
     try {
-      await runGitMaybeHost(info, [
+      await runGit(info, [
         'submodule',
         'add',
         '--force',
@@ -188,7 +184,7 @@ const autoVendor = async (info) => {
   if (info.vendorStrategy === 'subtree') {
     // Create a commit if it does not exist. This is required for subtree.
     try {
-      await runGitMaybeHost(info, ['rev-parse', 'HEAD']);
+      await runGit(info, ['rev-parse', 'HEAD']);
     } catch (e) {
       if (!(e instanceof CommandError)) throw e;
 
@@ -197,16 +193,16 @@ const autoVendor = async (info) => {
       // git on the host machine.
       // TODO: this is probably creating an unnecessary commit for someone who
       // just created a git repo and knows what they are doing.
-      await runGitMaybeHost(info, [
+      await runGit(info, [
         'commit',
         '--allow-empty',
         '-n',
         '-m',
-        'Initial commit.',
+        '"Initial commit."',
       ]);
     }
 
-    await runGitMaybeHost(info, [
+    await runGit(info, [
       'subtree',
       'add',
       '--prefix',
@@ -321,7 +317,7 @@ async function init(info) {
 
     if ((await autoDetect(info)) === 'submodule') {
       try {
-        const existingBranchName = await runGitMaybeHost(
+        const existingBranchName = await runGit(
           info,
           [
             '-C',

package/modules/actions/start.js

@@ -58,7 +58,16 @@ const initContainer = async (libdragonInfo) => {
         '-R',
         `${uid >= 0 ? uid : ''}:${gid >= 0 ? gid : ''}`,
         '/n64_toolchain',
-      ]
+      ],
+      {
+        userCommand: false,
+        inheritStdin: true,
+        inheritStdout: false,
+        inheritStderr: false,
+        spawnOptions: {
+          shell: true,
+        },
+      }
     );
   } catch (e) {
     // Dispose the invalid container, clean and exit

package/modules/actions/update.js

@@ -1,7 +1,7 @@
 const { log, assert } = require('../helpers');
 const { LIBDRAGON_GIT } = require('../constants');
 const {
-  runGitMaybeHost,
+  runGit,
   installDependencies,
   updateImage,
   destroyContainer,
@@ -55,7 +55,7 @@ const update = async (info) => {
   }
 
   if (info.vendorStrategy === 'submodule') {
-    await runGitMaybeHost(info, [
+    await runGit(info, [
       'submodule',
       'update',
       '--remote',
@@ -63,7 +63,7 @@ const update = async (info) => {
       info.vendorDirectory,
     ]);
   } else if (info.vendorStrategy === 'subtree') {
-    await runGitMaybeHost(info, [
+    await runGit(info, [
       'subtree',
       'pull',
       '--prefix',

package/modules/helpers.js

@@ -124,11 +124,12 @@ async function dirExists(path) {
  * }} SpawnOptions
  */
 
-// A simple Promise wrapper for child_process.spawn. Return the err/out streams
-// from the process by default. Specify inheritStdout / inheritStderr to disable
-// this and inherit the parent process's stream, passing through the TTY if any.
 /**
- *
+ * A simple Promise wrapper for child_process.spawn. Return the err/out streams
+ * from the process by default. Specify inheritStdout / inheritStderr to disable
+ * this and inherit the parent process's stream, passing through the TTY if any.
+ * Runs everything in a shell, so be careful with user input. By default, we get
+ * the input from user but this is the whole idea of most of the logic here.
  * @param {string} cmd
  * @param {string[]} params
  * @param {SpawnOptions} options
@@ -183,6 +184,10 @@ function spawnProcess(
         enableOutTTY ? 'inherit' : 'pipe',
         enableErrorTTY ? 'inherit' : 'pipe',
       ],
+      env: {
+        // Prevent the annoying docker "What's next?" message. It messes up everything.
+        DOCKER_CLI_HINTS: 'false',
+      },
       ...spawnOptions,
     });
 
@@ -348,17 +353,7 @@ const dockerExec = /** @type {DockerExec} */ (
         libdragonInfo.containerId,
         ...finalCmdWithParams,
       ],
-      {
-        ...options,
-        spawnOptions: {
-          env: {
-            // Prevent the annoyin docker "What's next?" message. It messes up everything.
-            DOCKER_CLI_HINTS: 'false',
-            ...options?.spawnOptions?.env,
-          },
-          ...options?.spawnOptions,
-        },
-      }
+      options
     );
   }
 );

package/modules/npm-utils.js

@@ -1,20 +1,6 @@
 const path = require('path');
-const fsClassic = require('fs');
-const fs = require('fs/promises');
 
-// TODO: stop using lodash just for a simple uniq function
-const _ = require('lodash');
-
-const { dockerHostUserParams } = require('./docker-utils');
-
-const { CONTAINER_TARGET_PATH } = require('./constants');
-const {
-  fileExists,
-  toPosixPath,
-  spawnProcess,
-  dockerExec,
-  ValidationError,
-} = require('./helpers');
+const { fileExists, spawnProcess } = require('./helpers');
 
 async function findNPMRoot() {
   try {
@@ -29,115 +15,15 @@ async function findNPMRoot() {
   }
 }
 
-/**
- * Install other NPM dependencies if this is an NPM project
- * @param {import('./project-info').LibdragonInfo} libdragonInfo
- */
-const installNPMDependencies = async (libdragonInfo) => {
-  const npmRoot = await findNPMRoot();
-  if (npmRoot) {
-    const packageJsonPath = path.join(npmRoot, 'package.json');
-
-    const { dependencies, devDependencies } = JSON.parse(
-      await fs.readFile(packageJsonPath, { encoding: 'utf8' })
-    );
-
-    const deps = await Promise.all(
-      Object.keys({
-        ...dependencies,
-        ...devDependencies,
-      })
-        .filter((dep) => dep !== 'libdragon')
-        .map(async (dep) => {
-          const npmPath = await runNPM(['ls', dep, '--parseable=true']);
-          return {
-            name: dep,
-            paths: _.uniq(npmPath.split('\n').filter((f) => f)),
-          };
-        })
-    );
-
-    await Promise.all(
-      deps.map(({ name, paths }) => {
-        return /** @type Promise<void> */ (
-          new Promise((resolve, reject) => {
-            fsClassic.access(
-              path.join(paths[0], 'Makefile'),
-              fsClassic.constants.F_OK,
-              async (e) => {
-                if (e) {
-                  // File does not exist - skip
-                  resolve();
-                  return;
-                }
-
-                if (paths.length > 1) {
-                  reject(
-                    new ValidationError(
-                      `Using same dependency with different versions is not supported! ${name}`
-                    )
-                  );
-                  return;
-                }
-
-                try {
-                  const relativePath = toPosixPath(
-                    path.relative(libdragonInfo.root, paths[0])
-                  );
-                  const containerPath = path.posix.join(
-                    CONTAINER_TARGET_PATH,
-                    relativePath
-                  );
-                  const makePath = path.posix.join(containerPath, 'Makefile');
-
-                  await dockerExec(
-                    libdragonInfo,
-                    [...dockerHostUserParams(libdragonInfo)],
-                    [
-                      '/bin/bash',
-                      '-c',
-                      '[ -f ' +
-                        makePath +
-                        ' ] && make -C ' +
-                        containerPath +
-                        ' && make -C ' +
-                        containerPath +
-                        ' install',
-                    ]
-                  );
-
-                  resolve();
-                } catch (e) {
-                  reject(e);
-                }
-              }
-            );
-          })
-        );
-      })
-    );
-  }
-};
-
 /**
  * @param {string[]} params
  */
 function runNPM(params) {
   return spawnProcess(
     /^win/.test(process.platform) ? 'npm.cmd' : 'npm',
-    params,
-    {
-      userCommand: false,
-      inheritStdin: true,
-      inheritStdout: false,
-      inheritStderr: false,
-      spawnOptions: {
-        shell: true,
-      },
-    }
+    params
   );
 }
 module.exports = {
-  installNPMDependencies,
   findNPMRoot,
 };

package/modules/utils.js

@@ -10,13 +10,11 @@ const {
   dockerExec,
   dirExists,
   assert,
-  CommandError,
   ValidationError,
   toNativePath,
 } = require('./helpers');
 
 const { dockerHostUserParams } = require('./docker-utils');
-const { installNPMDependencies } = require('./npm-utils');
 
 /**
  * @param {import('./project-info').LibdragonInfo} libdragonInfo
@@ -42,10 +40,17 @@ const installDependencies = async (libdragonInfo) => {
       CONTAINER_TARGET_PATH + '/' + libdragonInfo.vendorDirectory,
       ...dockerHostUserParams(libdragonInfo),
     ],
-    ['/bin/bash', './build.sh']
+    ['/bin/bash', './build.sh'],
+    {
+      userCommand: false,
+      inheritStdin: true,
+      inheritStdout: false,
+      inheritStderr: false,
+      spawnOptions: {
+        shell: true,
+      },
+    }
   );
-
-  await installNPMDependencies(libdragonInfo);
 };
 
 /**
@@ -119,8 +124,7 @@ const destroyContainer = async (libdragonInfo) => {
 };
 
 /**
- * Invokes host git with provided params. If host does not have git, falls back
- * to the docker git, with the nix user set to the user running libdragon.
+ * Invokes host git with provided params.
  */
 
 /**
@@ -129,43 +133,23 @@ const destroyContainer = async (libdragonInfo) => {
  * @param {string[]} params
  * @param {import('./helpers').SpawnOptions} options
  */
-async function runGitMaybeHost(libdragonInfo, params, options = {}) {
+async function runGit(libdragonInfo, params, options = {}) {
   assert(
     libdragonInfo.vendorStrategy !== 'manual',
     new Error('Should never run git if vendoring strategy is manual.')
   );
-  try {
-    const isWin = /^win/.test(process.platform);
-
-    return await spawnProcess(
-      'git',
-      ['-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.
-      isWin
-        ? { inheritStdin: false, ...options }
-        : { inheritStdout: true, inheritStderr: true, ...options }
-    );
-  } catch (e) {
-    if (e instanceof CommandError) {
-      throw e;
-    }
-
-    assert(
-      !process.env.DOCKER_CONTAINER,
-      new Error('[runGitMaybeHost] Native git should exist in a container.')
-    );
-
-    return await dockerExec(
-      libdragonInfo,
-      // Use the host user when initializing git as we will need access
-      [...dockerHostUserParams(libdragonInfo)],
-      ['git', ...params],
-      // Let's enable tty here to show the progress
-      { inheritStdout: true, inheritStderr: true, ...options }
-    );
-  }
+  const isWin = /^win/.test(process.platform);
+
+  return await spawnProcess(
+    'git',
+    ['-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.
+    isWin
+      ? { inheritStdin: false, ...options }
+      : { inheritStdout: true, inheritStderr: true, ...options }
+  );
 }
 
 /**
@@ -267,7 +251,7 @@ async function initGitAndCacheContainerId(libdragonInfo) {
  */
 async function ensureGit(info) {
   const gitRoot = (
-    await runGitMaybeHost(info, ['rev-parse', '--show-toplevel'], {
+    await runGit(info, ['rev-parse', '--show-toplevel'], {
       inheritStdin: false,
       inheritStdout: false,
       inheritStderr: false,
@@ -283,7 +267,7 @@ async function ensureGit(info) {
   // where there is a git working tree higher in the host filesystem, which
   // the container does not have access to.
   if (!gitRoot) {
-    await runGitMaybeHost(info, ['init']);
+    await runGit(info, ['init']);
   }
 }
 
@@ -294,6 +278,6 @@ module.exports = {
   checkContainerRunning,
   checkContainerAndClean,
   initGitAndCacheContainerId,
-  runGitMaybeHost,
+  runGit,
   ensureGit,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libdragon",
-  "version": "11.4.4",
+  "version": "12.0.1",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {
@@ -41,7 +41,6 @@
   "dependencies": {
     "chalk": "^4.1.0",
     "command-line-usage": "^6.1.1",
-    "lodash": "^4.17.20",
     "zx": "^8.1.8"
   },
   "devDependencies": {
@@ -49,11 +48,9 @@
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/command-line-usage": "^5.0.2",
-    "@types/lodash": "^4.14.182",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
     "esbuild": "^0.20.0",
-    "ed64": "^2.0.4",
     "eslint": "^9.11.0",
     "jest": "^29.5.0",
     "postject": "^1.0.0-alpha.6",