libdragon 10.7.1 → 10.8.0

package/README.md

@@ -123,6 +123,10 @@ will init the container for this project and run `make && make install` for `ed6
 
 This is an experimental dependency management.
 
+## TODOS
+
+- [ ] Skip CI checks for irrelevant changes.
+
 ## Funding
 
 If this tool helped you, consider supporting its development by sponsoring it!

package/modules/actions/help.js

@@ -39,7 +39,7 @@ const printUsage = (info) => {
 
         To disable auto-vendoring, init with \`manual\`. With \`manual\`, libdragon files are expected at the location provided by \`--directory\` flag and the user is responsible for vendoring and updating them. This will allow using any other manual vendoring method.
 
-        You can always switch to manual by re-running \`init\` with \`--strategy manual\`, though you will be responsible for managing the existing submodule/subtree. Also it is not possible to automatically switch back.
+        You can always switch strategy by re-running \`init\` with \`--strategy\`, though you will be responsible for handling the old vendored files as they will be kept as is.
 
         With the \`manual\` strategy, it is still recommended to have a git repository at project root such that container actions can execute faster by caching the container id inside the \`.git\` folder.\n`,
       alias: 's',

package/modules/actions/init.js

@@ -27,12 +27,99 @@ const {
   toPosixPath,
   toNativePath,
 } = require('../helpers');
+const { syncImageAndStart } = require('./update-and-start');
+
+const autoDetect = async (info) => {
+  const vendorTarget = path.relative(
+    info.root,
+    toNativePath(info.vendorDirectory)
+  );
+  const vendorTargetExists = await fs.stat(vendorTarget).catch((e) => {
+    if (e.code !== 'ENOENT') throw e;
+    return false;
+  });
+
+  if (
+    vendorTargetExists &&
+    (await runGitMaybeHost(info, [
+      'submodule',
+      'status',
+      info.vendorDirectory,
+    ]).catch((e) => {
+      if (!(e instanceof CommandError)) {
+        throw e;
+      }
+    }))
+  ) {
+    log(`${info.vendorDirectory} is a submodule.`);
+    return 'submodule';
+  }
+
+  if (vendorTargetExists) {
+    const gitLogs = await runGitMaybeHost(info, ['log'], {
+      inheritStdin: false,
+      inheritStdout: false,
+      inheritStderr: false,
+    });
+
+    if (gitLogs.includes(`git-subtree-dir: ${info.vendorDirectory}`)) {
+      log(`${info.vendorDirectory} is a subtree.`);
+      return 'subtree';
+    }
+  }
+};
+
+const autoVendor = async (info) => {
+  // Update the strategy information for the project if the flag is provided
+  if (info.options.VENDOR_STRAT) {
+    info.vendorStrategy = info.options.VENDOR_STRAT;
+  }
+
+  // Update the directory information for the project if the flag is provided
+  if (info.options.VENDOR_DIR) {
+    const relativeVendorDir = path.relative(info.root, info.options.VENDOR_DIR);
+    // Validate vendoring path
+    if (relativeVendorDir.startsWith('..')) {
+      throw new ParameterError(
+        `\`--directory=${info.options.VENDOR_DIR}\` is outside the project directory.`,
+        info.options.CURRENT_ACTION.name
+      );
+    }
+
+    // Immeditately convert it to a posix and relative path
+    info.vendorDirectory = toPosixPath(relativeVendorDir);
+  }
+
+  // No need to do anything here
+  if (info.vendorStrategy === 'manual') {
+    return info;
+  }
+
+  await runGitMaybeHost(info, ['init']);
+  const detectedStrategy = await autoDetect(info);
+
+  if (
+    info.options.VENDOR_STRAT &&
+    detectedStrategy &&
+    detectedStrategy !== info.options.VENDOR_STRAT
+  ) {
+    throw new ValidationError(
+      `${info.vendorDirectory} is a ${detectedStrategy} which is different from the provided strategy: ${info.options.VENDOR_STRAT}.`
+    );
+  }
 
-const autoVendor = async (libdragonInfo) => {
-  await runGitMaybeHost(libdragonInfo, ['init']);
+  if (detectedStrategy) {
+    log(
+      `Using ${info.vendorDirectory} as a ${detectedStrategy} vendoring target.`
+    );
+    return {
+      ...info,
+      vendorStrategy: detectedStrategy,
+    };
+  }
 
-  if (libdragonInfo.vendorStrategy === 'submodule') {
-    await runGitMaybeHost(libdragonInfo, [
+  if (info.vendorStrategy === 'submodule') {
+    await runGitMaybeHost(info, [
       'submodule',
       'add',
       '--force',
@@ -41,19 +128,22 @@ const autoVendor = async (libdragonInfo) => {
       '--branch',
       LIBDRAGON_BRANCH,
       LIBDRAGON_GIT,
-      libdragonInfo.vendorDirectory,
+      info.vendorDirectory,
     ]);
-  } else if (libdragonInfo.vendorStrategy === 'subtree') {
+    return info;
+  }
+
+  if (info.vendorStrategy === 'subtree') {
     // Create a commit if it does not exist. This is required for subtree.
     try {
-      await runGitMaybeHost(libdragonInfo, ['rev-parse', 'HEAD']);
+      await runGitMaybeHost(info, ['rev-parse', 'HEAD']);
     } catch (e) {
       if (!(e instanceof CommandError)) throw e;
 
       // This will throw if git user name/email is not set up. Let's not assume
       // anything for now. This means subtree is not supported for someone without
       // git on the host machine.
-      await runGitMaybeHost(libdragonInfo, [
+      await runGitMaybeHost(info, [
         'commit',
         '--allow-empty',
         '-n',
@@ -62,18 +152,17 @@ const autoVendor = async (libdragonInfo) => {
       ]);
     }
 
-    await runGitMaybeHost(libdragonInfo, [
+    await runGitMaybeHost(info, [
       'subtree',
       'add',
       '--prefix',
-      path.relative(libdragonInfo.root, libdragonInfo.vendorDirectory),
+      path.relative(info.root, info.vendorDirectory),
       LIBDRAGON_GIT,
       LIBDRAGON_BRANCH,
       '--squash',
     ]);
+    return info;
   }
-
-  return libdragonInfo;
 };
 
 /**
@@ -83,10 +172,8 @@ const autoVendor = async (libdragonInfo) => {
 async function init(info) {
   log(`Initializing a libdragon project at ${info.root}`);
 
-  let newInfo = info;
-
   // Validate manifest
-  const manifestPath = path.join(newInfo.root, LIBDRAGON_PROJECT_MANIFEST);
+  const manifestPath = path.join(info.root, LIBDRAGON_PROJECT_MANIFEST);
   const manifestStats = await fs.stat(manifestPath).catch((e) => {
     if (e.code !== 'ENOENT') throw e;
     return false;
@@ -98,95 +185,52 @@ async function init(info) {
     );
   }
 
-  // Validate vendoring strategy. Do not allow a switch after successful initialization
-  if (
-    newInfo.haveProjectConfig &&
-    newInfo.options.VENDOR_STRAT &&
-    newInfo.options.VENDOR_STRAT !== 'manual' &&
-    newInfo.vendorStrategy !== newInfo.options.VENDOR_STRAT
-  ) {
-    throw new ParameterError(
-      `Requested strategy switch: ${newInfo.vendorStrategy} -> ${newInfo.options.VENDOR_STRAT} It is not possible to switch vendoring strategy after initializing a project. You can always switch to manual and handle libdragon yourself.`,
-      info.options.CURRENT_ACTION.name
-    );
-  }
-
-  // Update the strategy information for the project if the flag is provided
-  if (newInfo.options.VENDOR_STRAT) {
-    newInfo.vendorStrategy = newInfo.options.VENDOR_STRAT;
-  }
-
-  // Update the directory information for the project if the flag is provided
-  if (newInfo.options.VENDOR_DIR) {
-    const relativeVendorDir = path.relative(info.root, info.options.VENDOR_DIR);
-    // Validate vendoring path
-    if (relativeVendorDir.startsWith('..')) {
-      throw new ParameterError(
-        `\`--directory=${info.options.VENDOR_DIR}\` is outside the project directory.`,
-        info.options.CURRENT_ACTION.name
-      );
-    }
-
-    // Immeditately convert it to a posix and relative path
-    newInfo.vendorDirectory = toPosixPath(relativeVendorDir);
-  }
-
-  if (newInfo.haveProjectConfig) {
+  if (info.haveProjectConfig) {
     log(
       `${path.join(
-        newInfo.root,
+        info.root,
         LIBDRAGON_PROJECT_MANIFEST
       )} exists. This is already a libdragon project, starting it...`
     );
-    if (newInfo.options.DOCKER_IMAGE) {
+    if (info.options.DOCKER_IMAGE) {
       log(
         `Not changing docker image. Use the install action if you want to override the image.`
       );
     }
-    // TODO: we may make sure git and submodule is initialized here
-    return await install(newInfo);
+    if (info.options.DOCKER_IMAGE) {
+      info = await syncImageAndStart(info);
+    } else {
+      info = {
+        ...info,
+        containerId: await start(info),
+      };
+    }
+    info = await autoVendor(info);
+    await installDependencies(info);
+    return info;
   }
 
-  await updateImage(newInfo, newInfo.imageName);
+  await updateImage(info, info.imageName);
 
   // Download image and start it
-  newInfo.containerId = await start(newInfo);
+  info.containerId = await start(info);
 
   // We have created a new container, save the new info ASAP
-  await initGitAndCacheContainerId(newInfo);
+  await initGitAndCacheContainerId(info);
 
-  if (newInfo.vendorStrategy !== 'manual') {
-    const vendorTarget = path.relative(
-      newInfo.root,
-      toNativePath(newInfo.vendorDirectory)
-    );
-    const vendorTargetExists = await fs.stat(vendorTarget).catch((e) => {
-      if (e.code !== 'ENOENT') throw e;
-      return false;
-    });
-
-    if (vendorTargetExists) {
-      throw new ValidationError(
-        `${path.resolve(
-          vendorTarget
-        )} already exists. That is the libdragon vendoring target, please remove and retry.`
-      );
-    }
-
-    newInfo = await autoVendor(newInfo);
-  }
+  info = await autoVendor(info);
 
   log(`Preparing project files...`);
   const skeletonFolder = path.join(__dirname, '../../skeleton');
 
   await Promise.all([
-    installDependencies(newInfo),
+    installDependencies(info),
     // node copy functions does not work with pkg
-    copyDirContents(skeletonFolder, newInfo.root),
+    copyDirContents(skeletonFolder, info.root),
   ]);
 
-  log(chalk.green(`libdragon ready at \`${newInfo.root}\`.`));
-  return newInfo;
+  log(chalk.green(`libdragon ready at \`${info.root}\`.`));
+  return info;
 }
 
 module.exports = {
@@ -200,7 +244,9 @@ module.exports = {
 
     By default, a git repository and a submodule at \`./libdragon\` will be created to automatically update the vendored libdragon files on subsequent \`update\`s. If you intend to opt-out from this feature, see the \`--strategy manual\` flag to provide your self-managed libdragon copy. The default behaviour is intended for users who primarily want to consume libdragon as is.
 
-    If this is the first time you are creating a libdragon project at that location, this action will also create skeleton project files to kickstart things with the given image, if provided. For subsequent runs, it will act like \`start\` thus can be used to revive an existing project without modifying it.`,
+    If this is the first time you are creating a libdragon project at that location, this action will also create skeleton project files to kickstart things with the given image, if provided. For subsequent runs, it will act like \`start\` thus can be used to revive an existing project without modifying it.
+
+    If you have an existing project with an already vendored submodule or subtree libdragon copy, \`init\` will automatically detect it at the provided \`--directory\`.`,
     group: ['docker', 'vendoring'],
   },
 };

package/modules/actions/install.js

@@ -2,7 +2,7 @@ const chalk = require('chalk').stderr;
 
 const { installDependencies } = require('./utils');
 const { start } = require('./start');
-const { updateAndStart } = require('./update-and-start');
+const { syncImageAndStart } = require('./update-and-start');
 const { log } = require('../helpers');
 
 /**
@@ -16,17 +16,17 @@ const { log } = require('../helpers');
  * depends on it. It used to only update the image if the flag is provided and
  * we still keep that logic but with a deprecation warning.
  */
-const install = async (libdragonInfo, skipUpdate) => {
+const install = async (libdragonInfo) => {
   let updatedInfo = libdragonInfo;
   const imageName = libdragonInfo.options.DOCKER_IMAGE;
   // If an image is provided, attempt to install
-  if (imageName && skipUpdate !== true) {
+  if (imageName) {
     log(
       chalk.yellow(
         'Using `install` action to update the docker image is deprecated. Use the `update` action instead.'
       )
     );
-    updatedInfo = await updateAndStart(libdragonInfo);
+    updatedInfo = await syncImageAndStart(libdragonInfo);
   } else {
     // Make sure existing one is running
     updatedInfo = {

package/modules/actions/start.js

@@ -34,19 +34,20 @@ const initContainer = async (libdragonInfo) => {
       ])
     ).trim();
 
-    const newInfo = {
-      ...libdragonInfo,
-      containerId: newId,
-    };
-
     // chown the installation folder once on init
     const { uid, gid } = libdragonInfo.userInfo;
-    await dockerExec(newInfo, [
-      'chown',
-      '-R',
-      `${uid >= 0 ? uid : ''}:${gid >= 0 ? gid : ''}`,
-      '/n64_toolchain',
-    ]);
+    await dockerExec(
+      {
+        ...libdragonInfo,
+        containerId: newId,
+      },
+      [
+        'chown',
+        '-R',
+        `${uid >= 0 ? uid : ''}:${gid >= 0 ? gid : ''}`,
+        '/n64_toolchain',
+      ]
+    );
   } catch (e) {
     // Dispose the invalid container, clean and exit
     await destroyContainer({

package/modules/actions/update-and-start.js

@@ -2,7 +2,7 @@ const { log } = require('../helpers');
 const { updateImage, destroyContainer } = require('./utils');
 const { start } = require('./start');
 
-async function updateAndStart(libdragonInfo) {
+async function syncImageAndStart(libdragonInfo) {
   const oldImageName = libdragonInfo.imageName;
   const imageName = libdragonInfo.options.DOCKER_IMAGE ?? oldImageName;
   // If an image is provided, always attempt to install it
@@ -29,5 +29,5 @@ async function updateAndStart(libdragonInfo) {
 }
 
 module.exports = {
-  updateAndStart,
+  syncImageAndStart,
 };

package/modules/actions/update.js

@@ -1,26 +1,25 @@
 const { log } = require('../helpers');
 const { LIBDRAGON_GIT, LIBDRAGON_BRANCH } = require('../constants');
-const { runGitMaybeHost } = require('./utils');
-const { fn: install } = require('./install');
-const { updateAndStart } = require('./update-and-start');
+const { runGitMaybeHost, installDependencies } = require('./utils');
+const { syncImageAndStart } = require('./update-and-start');
 
 const update = async (info) => {
-  const newInfo = await updateAndStart(info);
+  info = await syncImageAndStart(info);
 
-  if (newInfo.vendorStrategy !== 'manual') {
-    log(`Updating ${newInfo.vendorStrategy}...`);
+  if (info.vendorStrategy !== 'manual') {
+    log(`Updating ${info.vendorStrategy}...`);
   }
 
-  if (newInfo.vendorStrategy === 'submodule') {
-    await runGitMaybeHost(newInfo, [
+  if (info.vendorStrategy === 'submodule') {
+    await runGitMaybeHost(info, [
       'submodule',
       'update',
       '--remote',
       '--merge',
-      newInfo.vendorDirectory,
+      info.vendorDirectory,
     ]);
-  } else if (newInfo.vendorStrategy === 'subtree') {
-    await runGitMaybeHost(newInfo, [
+  } else if (info.vendorStrategy === 'subtree') {
+    await runGitMaybeHost(info, [
       'subtree',
       'pull',
       '--prefix',
@@ -31,9 +30,7 @@ const update = async (info) => {
     ]);
   }
 
-  // The second parameter forces it to skip the image update step as we already
-  // do that above.
-  return await install(newInfo, true);
+  await installDependencies(info);
 };
 
 module.exports = {

package/modules/actions/utils.js

@@ -110,35 +110,35 @@ 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.
  */
-async function runGitMaybeHost(libdragonInfo, params) {
+async function runGitMaybeHost(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);
-    await spawnProcess(
+    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 }
-        : { inheritStdout: true, inheritStderr: true }
+        ? { inheritStdin: false, ...options }
+        : { inheritStdout: true, inheritStderr: true, ...options }
     );
   } catch (e) {
     if (e instanceof CommandError) {
       throw e;
     }
 
-    await dockerExec(
+    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 }
+      { inheritStdout: true, inheritStderr: true, ...options }
     );
   }
 }

package/modules/project-info.js

@@ -66,12 +66,14 @@ async function findContainerId(libdragonInfo) {
     const idIndex = str.indexOf(shortId);
     const longId = str.slice(idIndex, idIndex + 64);
     if (longId.length === 64) {
-      const newInfo = { ...libdragonInfo, containerId: longId };
       // This shouldn't happen but if the user somehow deleted the .git folder
       // (we don't have the container id file at this point) we can recover the
       // project. `git init` is safe anyways and it is not executed if strategy
       // is `manual`
-      await initGitAndCacheContainerId(newInfo);
+      await initGitAndCacheContainerId({
+        ...libdragonInfo,
+        containerId: longId,
+      });
       return longId;
     }
   }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "libdragon",
-  "version": "10.7.1",
+  "version": "10.8.0",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {
-    "node": ">=14"
+    "node": ">=14",
+    "npm": ">=8"
   },
   "bin": {
     "libdragon": "./index.js"
@@ -39,10 +40,19 @@
     "lodash": "^4.17.20"
   },
   "devDependencies": {
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "^3.3.0",
     "ed64": "^2.0.4",
     "eslint": "^7.32.0",
     "pkg": "^5.5.2",
-    "prettier": "^2.4.0"
+    "prettier": "^2.4.0",
+    "semantic-release": "^19.0.2"
+  },
+  "overrides": {
+    "minimist": "1.2.6"
   },
   "pkg": {
     "targets": [
@@ -53,5 +63,44 @@
     "assets": [
       "skeleton/**"
     ]
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git",
+      [
+        "@semantic-release/exec",
+        {
+          "prepareCmd": "./pack.sh"
+        }
+      ],
+      [
+        "@semantic-release/github",
+        {
+          "assets": [
+            {
+              "path": "libdragon-linux-x86_64.tar.gz",
+              "label": "Linux executable"
+            },
+            {
+              "path": "libdragon-macos-x86_64.tar.gz",
+              "label": "MacOS executable"
+            },
+            {
+              "path": "libdragon-win-x86_64.zip",
+              "label": "Windows executable"
+            }
+          ]
+        }
+      ]
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }

package/CHANGELOG.md

@@ -1,582 +0,0 @@
-# Change Log
-
-## [10.7.1] - 2022-04-20
-
-### Fixed
-
-- Migrating from and old version was incorrectly erroring out to do an additional
-`init`, which is not necessarily required.
-
-### Changed
-
-- Do not print usage information when a command fails.
-
-## [10.7.0] - 2022-04-17
-
-### Fixed
-
-- Logs properly goes to stderr now. Previously they were written to stdout. This
-means the id output of the `start` action is now written to stdout while we can
-also display other information on the terminal. This allowed enabling the docker
-logs for a more responsive experience. The output of `help` still goes to stdout.
-
-### Added
-
-- Stdin consumption support. Now it is possible to pipe anything to `exec` and
-it will pass it through to the target. In case of no running container, it will
-keep a copy of the stdin stream until the docker process is ready. This enables
-piping in data from the host if ever needed for some reason. This enables usages
-like `cat file.txt | libdragon exec cat - | less`.
-- Automatically convert host paths into posix format so that the user can use
-the host's path autocompletion. It will also convert absolute host paths into
-relative container paths automatically. Previously all paths were assumed to be
-container paths relative to the location corresponding to the host cwd.
-Closes #24.
-
-### Changed
-
-- Refactored process spawns.
-- Refactored main flow and separated parsing logic.
-- Reorder actions & correction on flag usage for help output.
-- Setting `--verbose` for `start` does not guarantee the only-id output anymore.
-- Refactored parameter parsing.
-- Update submdule for local development.
-
-## [10.6.0] - 2022-04-09
-### Fixed
-
-- Fix a path bug that would cause incorrect behaviour when the command is run
-deeper than a single level in the project folder.
-- Fix a potential issue where `build.sh`might be incorrectly found inexistant
-if the OS is picky about the paths to have native separators.
-- Only save project information when necessary. Previously actions like `help`
-were saving project info mistakenly.
-
-### Added
-
-- `disasm` action to simplify disassembling ELF files generated by the toolchain.
-- `version` action to display current version.
-- `destroy` action to remove the libdragon project.
-- Additional documentation for flags.
-- Print duration information when verbose.
-
-### Changed
-
-- Refactored out NPM related functions.
-- Moved usage parameters to respective actions files as a refactor.
-- It is possible to provide an absolute path to init `--directory` as long as it
-is inside the project directory. Previously it was possible to provide somewhere
-outside the project, but it would fail with an unexpected error.
-- Simplify saving mechanism. Each action now internally resolves into the data
-to save if any.
-
-## [10.4.2] - 2022-04-03
-
-### Fixed
-
-- Make sure actions depending on an `init` fail in a non-project directory to
-keep the project state consistent. This fixes #51.
-- `update` action now tries to update the toolchain image as well. Previously
-this was not the case contrary to what someone would expect. Considering it won't
-change the behaviour for non-latest images and the toolchain did not have any
-breaking changes for a long time, this is not considered a breaking change either.
-- `start` action was printing stuff other than the container id. It doesn't
-anymore.
-- Stop unnecessarily printing container id and a few messages related to updates.
-- Fix a potential race condition that might cause unexpected failures.
-- Correct some errors' exit codes.
-### Added
-
-- A new exit code (`4`) to represent unexpected conditions.
-
-### Changed
-
-- Deprecated providing the image flag for `install` action by displaying a
-warning and removing it from documentation, without changing behaviour even
-though it is higly unlikely this feature was ever used. It mainly exists for
-historical reasons and it wil be removed in next major release.
-- Update documentation to warn against changing strategy is a one way operation.
-- Update documentation to reflect `update` action changes.
-- Minor refactors.
-- Update submodule for local environment.
-
-## [10.4.1] - 2022-03-23
-
-### Fixed
-
-- Update the root makefile to utilize `SOURCE_DIR` for example builds. Then we are
-  able to map container files to local files properly with a generic regex in the
-  problem matcher. This fixes #13 and does not change any behaviour.
-- Add missing examples to the vscode run configurations.
-- Install and build libdragon related things in the container when `exec` and
-  `make` causes a new container run. This was previously prevented on `v10.3.1`
-  because it was unnecessarily delaying all exec operations when the container
-  is started. Refactoring things allowed me to realize this can be improved
-  instead of forcing the user to do a manual `install`.
-- Fix a potential issue that may cause the git commands to run in current folder
-  instead of the project root.
-- Attach the error handler once for spawnProcess.
-- Update vulnerable dependencies.
-
-### Added
-
-- `--directory` option to customize vendoring location.
-- `--strategy` option to select a vendoring strategy. Currently supported options
-  are `submodule`, `subtree` and `manual`. The default is `submodule` and `manual`
-  can be used to opt-out of auto vendoring. Useful if the user wants to utilize
-  a different vendoring strategy and opt-out of the auto-managed git flows.
-
-### Changed
-
-- Migrate to a json file for persistent project information.
-- Only save the configuration file on successful exit except for the initial
-  migration.
-- Do not prevent init if there is a file named libdragon in the target folder.
-  This used to cause problems on windows but I cannot reproduce it anymore
-  with `2.33.1.windows.1`. It may be something caused by my old configuration.
-- Minor performance improvements.
-
-## [10.3.1] - 2022-01-25
-
-### Fixed
-
-- Do not try to parse arguments after exec/make. They used to get evaluated as
-  libdragon paramaters previously, preventing passing down -v to the container
-  make for example.
-- Docker image update issues
-  - Attempt an image update whenever the image flag is provided. Previously this
-    was only done if a different image name is provided, preventing the update of
-    the latest image. Previously not providing an image name was behaving the same
-    so this is not a breaking change.
-  - Start action used to update the image if provided but this bug was already
-    prevented by previous fixes by not accepting the image flag for actions other
-    than init/update/install. Start action no longer tries to update the image
-    regardless.
-
-### Changed
-
-- Only accept the image flag for init, install, and update actions as documented.
-- Improve documentation for the `init` and `install` actions.
-- Do not attempt an `install` when running `exec`, just start the container. If
-  there is a half-baked container, a manual `install` will potentially restore it.
-- Update libdragon.
-
-### Added
-
-- Extra information for skipping the image flag when doing init for an already
-  initialized project.
-
-## [10.3.0] - 2022-01-20
-
-### Changed
-
-- Update dependencies.
-- Detailed help output.
-- Move action descriptions to `libdragon help`.
-- Update libdragon to latest version for local build.
-
-### Added
-
-- Shorthand flag support.
-
-## [10.2.1] - 2021-10-14
-
-### Changed
-
-- Updated ed64.
-
-### Fixed
-
-- Fix skeleton project to match latest libdragon.
-
-## [10.2.0] - 2021-10-10
-
-### Added
-
-- Container discovery. The tool can now find a container even if `.git` is lost.
-- A few additional error messages for some potentially confusing cases such as
-  already having a file with `libdragon` like name.
-
-### Changed
-
-- Show more output for downloading the container and initial git operations.
-- Remove an extra log during initialization.
-- The submodule was always being initialized when a container is started. This
-  was making some actions inconsistent. For example `install` or `make` action
-  was trying to re-initialize the submodule unnecessarily. This is fixed by only
-  initializing it with the `init` action. If any of those need to re-init the
-  container, now they assume there is an intact libdragon folder to use.
-- Similarly a git repository is not initialized unnecessarily anymore.
-- `update` and `install` are now able to start containers if necessary.
-- Always try to copy skeleton files, they won't overwrite anything already.
-- Do not re-initialize if there is a `.libdragon` folder. We now only try to
-  start it in this case. If it is not a complete container, it can probably be
-  recovered by a `libdragon install` or `libdragon update`.
-
-### Fixed
-
-- Fix wording for libdragon install on the container.
-- Improve image name persitence such that the tool finds and updates it more
-  consistently.
-
-## [10.1.0] - 2021-10-07
-
-### Added
-
-- `exec` action to execute arbitrary commands in the container with TTY support.
-  This also improves the color output support as docker now knows it is using TTY.
-- Add more verbose logging for skeleton project copy.
-
-### Changed
-
-- Removed partially not working `--byte-swap` option. It does not already work
-  with the new libdragon build system so there is no need keeping it in the tool.
-
-### Fixed
-
-- Publish skeleton project files to NPM.
-
-## [10.0.0] - 2021-10-04
-
-### Changed
-
-- A complete re-write of the tool. Check documentation for the new usage. It is
-  much more straightforward to use now. `libdragon make` behaves almost the same.
-
-## [9.0.0] - 2021-09-06
-
-### Changed
-
-- Updated libdragon. We will be changing the update mechanism to be based on a
-  git pull, so listing them here will not be useful anymore, let's not bother now.
-- Start using the new build system.
-- Update node engine spec to be at least 14.
-- Added minimum docker version to readme.
-
-### Added
-
-- Github actions integration
-  - Start building a standalone Windows executable
-
-### Fixed
-
-- Fixed changelog dates to ISO8601
-
-## [8.0.0] - 2021-07-28
-
-### Changed
-
-- Removed make, download, init, buildDragon, prepareDragon, and installDependencies NPM scripts
-  - Update the necessary vscode and travis configuration
-  - Update the readme to match - this also fixes #31
-- Improve fastpath of dfs_read (https://github.com/DragonMinded/libdragon/pull/133)
-- Refactor n64tool (https://github.com/DragonMinded/libdragon/pull/153, https://github.com/DragonMinded/libdragon/pull/155)
-  - It no longer support byte-swapping and only generates a z64 file.
-  - Change test bench Makefile to reflect latest changes
-
-### Fixed
-
-- Zero-initialize the token array to avoid -Werror=maybe-uninitialized (https://github.com/DragonMinded/libdragon/pull/134)
-- Initialize arguments to main libdragon entrypoint (https://github.com/DragonMinded/libdragon/pull/136)
-- SD support fixes and dragonfs fopen fix (https://github.com/DragonMinded/libdragon/pull/137)
-- lib/include paths in tests Makefile (https://github.com/DragonMinded/libdragon/pull/138)
-- Reenable test_timer_ticks for emulators (https://github.com/DragonMinded/libdragon/pull/140)
-- n64tool: return error in case the seek offset required backward seek (https://github.com/DragonMinded/libdragon/pull/144)
-- Add missing extern "C" in debug.h (https://github.com/DragonMinded/libdragon/pull/146)
-- Ensure C++ global constructors are not garbage collected by ld (https://github.com/DragonMinded/libdragon/pull/148)
-- Fix clipped RDP rectangle drawing (https://github.com/DragonMinded/libdragon/pull/147)
-- Enable byte swap flag for the make action and update documentation accordingly
-- Skip the second parameter to the libdragon command as well
-- Enable --byte-swap flag for the make action
-
-### Added
-
-- restart_timer and new_timer_stopped functions (https://github.com/DragonMinded/libdragon/pull/131)
-- dfs_rom_addr (https://github.com/DragonMinded/libdragon/pull/133)
-- Implement EEPROM Filesystem and test ROM (https://github.com/DragonMinded/libdragon/pull/125)
-- ed64romconfig binary (https://github.com/DragonMinded/libdragon/pull/153, https://github.com/DragonMinded/libdragon/pull/155)
-- Support for RTC status/read/write commands (https://github.com/DragonMinded/libdragon/pull/152)
-- Generic libdragon NPM script
-
-## [7.0.0] - 2021-06-06
-
-### Changed
-
-- Update GCC (10.2.0), binutils (2.36.1) and newlib (4.1.0) (https://github.com/DragonMinded/libdragon/pull/130)
-- Remove internal forceLatest parameter
-- Refactor internal constants
-- Update dependencies
-
-### Fixed
-
-- Free stdio file handles when closed (https://github.com/DragonMinded/libdragon/pull/128)
-
-### Added
-
-- Default exception handler (https://github.com/DragonMinded/libdragon/pull/126)
-- New debugging library (https://github.com/DragonMinded/libdragon/pull/130)
-  - Not final, may have bugs or it may change in the future
-
-## [6.0.2] - 2021-03-04
-
-### Fixed
-
-- Fix icache ops (https://github.com/DragonMinded/libdragon/pull/122)
-- Rewrite timer.c to avoid messing up the COP0 hardware counter (https://github.com/DragonMinded/libdragon/pull/123)
-- Fix 16k EEPROM detection (https://github.com/DragonMinded/libdragon/pull/124)
-
-### Added
-
-- Support GCC nested functions (https://github.com/DragonMinded/libdragon/pull/122)
-
-## [6.0.1] - 2021-02-07
-
-### Changed
-
-- Makefile: add -ffunction-sections and -fdata-sections to libdragon (https://github.com/DragonMinded/libdragon/pull/121)
-- Running vscode tasks now always rebuild libdragon examples and tests
-- Root makefile always rebuilds examples and tests
-- Update readme
-
-### Fixed
-
-- C++ test example works now (https://github.com/DragonMinded/libdragon/pull/118)
-- Delay functions work correctly now (https://github.com/DragonMinded/libdragon/pull/120)
-- Fix broken bench makefile
-- Fix incorrect rom name for resolution test vscode launch configuration
-
-### Added
-
-- `installDragon` vscode task to make and install libdragon to the container
-
-## [6.0.0] - 2021-01-23
-
-### Changed
-
-- Update base Dockerfile to use the latest toolchain setup and make it deduce processor count for the toolchain build
-- `make` action does not first restart the container anymore. This will result in minor performance gains when running make
-- `libdragon` command does not always exit with code 1 anymore, it instead echoes the underlying error code if known
-- Updated toolchain dockerfile to strip symbols from executables and remove locales and built a new base image. Closes #8
-- Move code into modules
-- Do not put unnecessary files into the NPM package
-- Renamed `dragonInstall` npm script to `prepareDragon`
-- Readme improvements
-
-### Fixed
-
-- Start using child_process spawn to prevent buffer issues. Fixes #2
-- Colors are now properly displayed when using the wrapper. Fixes #21
-
-### Added
-
-- Readme update instructions. Closes #20
-- Readme root makefile instructions
-- A red message to show the error if any, including subprocess exit codes
-- An additional `installDependencies` libdragon action and NPM script. It does what we used to do after `download` and `start` when running `install`
-- `-fdiagnostics-color` for the local test bench to enable color output
-
-## [5.0.0] - 2021-01-16
-
-### Changed
-
-- dfs: fix performance of dfs_seek to be constant-time (https://github.com/DragonMinded/libdragon/pull/115)
-  - This changes the file system layout
-
-### Fixed
-
-- n64sys: fix dma cache ops (https://github.com/DragonMinded/libdragon/pull/116)
-- Added a new root makefile to batch multiple operations. Fixes #10
-- Added local search paths to improve test bench compile time. Fixes #18
-
-### Added
-
-- Exposed the TV_TYPE at 0x80000300 as a n64sys function (https://github.com/DragonMinded/libdragon/pull/113)
-- Initial libdragon testsuite (https://github.com/DragonMinded/libdragon/pull/117)
-- Launch configurations for the new test suite and existing examples
-- Launch configuration to clean everything
-
-## [4.1.4] - 2020-12-31
-
-### Changed
-
-- Update readme for submodule update procedure (https://github.com/anacierdem/libdragon-docker/pull/17)
-
-### Fixed
-
-- Prevent newlines in the output (https://github.com/anacierdem/libdragon-docker/pull/19)
-
-## [4.1.3] - 2020-12-16
-
-### Changed
-
-- Removed broken patreon shield. This is only a readme change.
-
-## [4.1.2] - 2020-12-15
-
-### Changed
-
-- Updated readme on how to use this repository.
-- Update dependencies.
-- Update ed64 to `1.2.0`.
-
-### Fixed
-
-- n64tool: fix bug in detection of unaligned image sizes (https://github.com/DragonMinded/libdragon/pull/109)
-- tools/build: Set default number of jobs to number of processors (https://github.com/DragonMinded/libdragon/pull/111)
-- Build script fixes (https://github.com/DragonMinded/libdragon/pull/112)
-
-## [4.1.1] - 2020-10-05
-
-### Changed
-
-- Updated readme on how to use this repository. Fixes #14.
-- Update dependencies.
-
-### Fixed
-
-- Fix examples' n64tool argument order. (https://github.com/DragonMinded/libdragon/pull/103)
-- Change ucodetest Makefile mode from 775 to 644. (https://github.com/DragonMinded/libdragon/pull/104)
-
-## [4.1.0] - 2019-05-21
-
-### Fixed
-
-- RSP macros now supports negative offsets. (https://github.com/DragonMinded/libdragon/pull/99)
-- Exception handler properly works and sets cause register to `cr` on `reg_block_t`. (https://github.com/DragonMinded/libdragon/pull/95)
-- Padding on data sections were causing boot issues. They are properly padded. (https://github.com/DragonMinded/libdragon/pull/98)
-- n64tool: Broken ROM issue is fixed when doing byte-swapping or zero-padding. (https://github.com/DragonMinded/libdragon/pull/97)
-- GCC 10 support with default `-fno-common`. (https://github.com/DragonMinded/libdragon/pull/96)
-
-### Added
-
-- Exception cause map is now implemented and it is accessible via `info` on `exception_t`. (https://github.com/DragonMinded/libdragon/pull/95)
-
-### Changed
-
-- n64tool: Less IO operations for faster ROM build times. (https://github.com/DragonMinded/libdragon/pull/97)
-
-## [4.0.1] - 2019-04-25
-
-### Fixed
-
-- Add missing vscode files.
-
-## [4.0.0] - 2019-04-24
-
-### Added
-
-- Add ability to run a local test bench with ed64 support.
-- Add `dragonInstall` and `build` NPM scripts for managing the test bench.
-- Add vscode files for quick test bench execution.
-- `devDependencies` are now also searched for makefiles and installed in the container.
-
-### Changed
-
-- Container mount path for this repository (NPM scripts) is now the repository root instead of `.\libdragon-source`.
-  - make commands are now executed inside `.\libdragon-source`.
-  - This will not effect consumers unless they depend on container's `/libdragon` path for explicitly accessing source files or relative paths with make's `-C`. They are now relative to repository root.
-  - `--mount-path` is still supported although not used on this repository anymore. These changes do not effect a local/global installation.
-
-## [3.2.0] - 2020-04-24
-
-### Changed
-
-- MIT license
-
-## [3.1.0] - 2019-03-25
-
-### Added
-
-- Add function to detect expansion pak (https://github.com/DragonMinded/libdragon/pull/91)
-
-### Changed
-
-- No need a tag for a travis deploy anymore.
-
-## [3.0.0] - 2019-02-11
-
-### Changed
-
-- Fixed vand opcode (https://github.com/DragonMinded/libdragon/pull/86)
-- Reimplement mtc2/mfc2 with the extended syntax allowed by RSP (https://github.com/DragonMinded/libdragon/pull/89)
-- Improve error message when using MIPS opcodes not available on RSP (https://github.com/DragonMinded/libdragon/pull/90)
-
-### Added
-
-- Transfer Pak support (https://github.com/DragonMinded/libdragon/pull/88)
-
-## [2.0.5] - 2019-12-07
-
-### Changed
-
-- Added support information.
-
-## [2.0.4] - 2019-12-07
-
-### Changed
-
-- Updated readme.
-- Removed version injection as the versions have diverged with libdragon.
-
-## [2.0.3] - 2019-12-06
-
-### Changed
-
-- Updated readme.
-- Use base version for `start` and `download` actions if self-building in CI.
-- Remove unnecessary toolchain start on `update` action.
-- Start correct version on `buildDragon`.
-
-## [2.0.2] - 2019-11-30
-
-### Changed
-
-- Running `install` command now starts the container.
-
-## [2.0.1] - 2019-11-30
-
-### Changed
-
-- Updated repository URL.
-
-## [2.0.0] - 2019-11-30
-
-### Changed
-
-- Separate the docker deployment process from library code.
-- Upgraded `binutils` to 2.33.1.
-- Improved ucode example and fixed byte alignment.
-- Removed confusing assemply macros from `ucode.S`. This changed vector and scalar register names.
-- Built a new base docker hub image tagged `toolchain`.
-- Running `download` command no longer starts the container.
-
-## [1.3.15] - 2019-11-01
-
-### Changed
-
-- `libdragon install` should skip CI checks.
-
-## [1.3.14] - 2019-10-31
-
-### Changed
-
-- Skip make install if no Makefile is found.
-
-## [1.3.12] - 2019-10-29
-
-### Changed
-
-- Reduce response time for NPM commands.
-- Remove unnecessary console statements and double logs.
-
-## [1.3.11] - 2019-10-29
-
-### Fixed
-
-- Fix problem with wait ticks. They do not lock the system now.
-
-## [1.3.9] - 2019-10-27
-
-### Added
-
-- Add texture mirroring. https://github.com/DragonMinded/libdragon/commit/00a6cc8e6d136cf2578a50320f6ff0814dfb6657