libdragon 10.4.2 → 10.7.0

package/modules/parameters.js

@@ -0,0 +1,129 @@
+const chalk = require('chalk').stderr;
+
+const { log } = require('./helpers');
+const actions = require('./actions');
+const { fn: printUsage } = require('./actions/help');
+const { STATUS_BAD_PARAM } = require('./constants');
+const { globals } = require('./globals');
+
+const parseParameters = async (argv) => {
+  const options = {
+    EXTRA_PARAMS: [],
+    CURRENT_ACTION: undefined,
+  };
+
+  for (let i = 2; i < argv.length; i++) {
+    const val = argv[i];
+
+    if (['--verbose', '-v'].includes(val)) {
+      options.VERBOSE = true;
+      globals.verbose = true;
+      continue;
+    }
+
+    // TODO: we might move these to actions as well.
+    if (['--image', '-i'].includes(val)) {
+      options.DOCKER_IMAGE = argv[++i];
+      continue;
+    } else if (val.indexOf('--image=') === 0) {
+      options.DOCKER_IMAGE = val.split('=')[1];
+      continue;
+    }
+
+    if (['--directory', '-d'].includes(val)) {
+      options.VENDOR_DIR = argv[++i];
+      continue;
+    } else if (val.indexOf('--directory=') === 0) {
+      options.VENDOR_DIR = val.split('=')[1];
+      continue;
+    }
+
+    if (['--strategy', '-s'].includes(val)) {
+      options.VENDOR_STRAT = argv[++i];
+      continue;
+    } else if (val.indexOf('--strategy=') === 0) {
+      options.VENDOR_STRAT = val.split('=')[1];
+      continue;
+    }
+
+    if (['--file', '-f'].includes(val)) {
+      options.FILE = argv[++i];
+      continue;
+    } else if (val.indexOf('--file=') === 0) {
+      options.FILE = val.split('=')[1];
+      continue;
+    }
+
+    if (val.indexOf('-') == 0) {
+      log(chalk.red(`Invalid flag \`${val}\``));
+      printUsage();
+      process.exit(STATUS_BAD_PARAM);
+    }
+
+    if (options.CURRENT_ACTION) {
+      log(chalk.red(`Expected only a single action, found: \`${val}\``));
+      printUsage();
+      process.exit(STATUS_BAD_PARAM);
+    }
+
+    options.CURRENT_ACTION = actions[val];
+
+    if (!options.CURRENT_ACTION) {
+      log(chalk.red(`Invalid action \`${val}\``));
+      printUsage();
+      process.exit(STATUS_BAD_PARAM);
+    }
+
+    if (options.CURRENT_ACTION.forwardsRestParams) {
+      options.EXTRA_PARAMS = argv.slice(i + 1);
+      break;
+    }
+  }
+
+  if (!options.CURRENT_ACTION) {
+    log(chalk.red('No action provided'));
+    printUsage();
+    process.exit(STATUS_BAD_PARAM);
+  }
+
+  if (
+    options.CURRENT_ACTION === actions.exec &&
+    options.EXTRA_PARAMS.length === 0
+  ) {
+    log(chalk.red('You should provide a command to exec'));
+    printUsage(undefined, [options.CURRENT_ACTION.name]);
+    process.exit(STATUS_BAD_PARAM);
+  }
+
+  if (
+    ![actions.init, actions.install, actions.update].includes(
+      options.CURRENT_ACTION
+    ) &&
+    options.DOCKER_IMAGE
+  ) {
+    log(chalk.red('Invalid flag: image'));
+    printUsage(undefined, [options.CURRENT_ACTION.name]);
+    process.exit(STATUS_BAD_PARAM);
+  }
+
+  if (
+    options.VENDOR_STRAT &&
+    !['submodule', 'subtree', 'manual'].includes(options.VENDOR_STRAT)
+  ) {
+    log(chalk.red(`Invalid strategy \`${options.VENDOR_STRAT}\``));
+    printUsage();
+    process.exit(STATUS_BAD_PARAM);
+  }
+
+  if (![actions.disasm].includes(options.CURRENT_ACTION) && options.FILE) {
+    log(chalk.red('Invalid flag: file'));
+    printUsage(undefined, [options.CURRENT_ACTION.name]);
+    process.exit(STATUS_BAD_PARAM);
+  }
+
+  return { options };
+};
+
+module.exports = {
+  parseParameters,
+};

package/modules/project-info.js

@@ -4,11 +4,11 @@ const fs = require('fs/promises');
 
 const {
   checkContainerAndClean,
-  findNPMRoot,
-  runGitMaybeHost,
-  tryCacheContainerId,
+  initGitAndCacheContainerId,
 } = require('./actions/utils');
 
+const { findNPMRoot } = require('./actions/npm-utils');
+
 const {
   LIBDRAGON_PROJECT_MANIFEST,
   CONFIG_FILE,
@@ -20,7 +20,17 @@ const {
   CONTAINER_TARGET_PATH,
 } = require('./constants');
 
-const { fileExists, log, spawnProcess, toPosixPath } = require('./helpers');
+const {
+  fileExists,
+  log,
+  spawnProcess,
+  toPosixPath,
+  assert,
+  ParameterError,
+} = require('./helpers');
+
+const initAction = require('./actions/init');
+const destroyAction = require('./actions/destroy');
 
 async function findContainerId(libdragonInfo) {
   const idFile = path.join(libdragonInfo.root, '.git', CACHED_CONTAINER_FILE);
@@ -42,7 +52,13 @@ async function findContainerId(libdragonInfo) {
     ])
   )
     .split('\n')
-    .filter((s) => s.includes(`${libdragonInfo.root} `));
+    // docker seem to save paths with posix separators but make sure we look for
+    // both, just in case
+    .filter(
+      (s) =>
+        s.includes(`${toPosixPath(libdragonInfo.root)} `) ||
+        s.includes(`${libdragonInfo.root} `)
+    );
 
   if (candidates.length > 0) {
     const str = candidates[0];
@@ -50,11 +66,12 @@ async function findContainerId(libdragonInfo) {
     const idIndex = str.indexOf(shortId);
     const longId = str.slice(idIndex, idIndex + 64);
     if (longId.length === 64) {
-      // If there is managed vendoring, make sure we have a git repo
-      if (libdragonInfo.vendorStrategy !== 'manual') {
-        await runGitMaybeHost(libdragonInfo, ['init']);
-      }
-      await tryCacheContainerId({ ...libdragonInfo, containerId: longId });
+      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);
       return longId;
     }
   }
@@ -83,20 +100,42 @@ async function findGitRoot() {
   }
 }
 
-async function readProjectInfo() {
+async function readProjectInfo(info) {
+  // No need to do anything here if the action does not depend on the project
+  // The only exception is the init and destroy actions, which do not need an
+  // existing project but readProjectInfo must always run to analyze the situation
+  const forceReadProjectInfo = [initAction, destroyAction].includes(
+    info.options.CURRENT_ACTION
+  );
+  if (
+    info.options.CURRENT_ACTION.mustHaveProject === false &&
+    !forceReadProjectInfo
+  ) {
+    return info;
+  }
+
   const projectRoot = await findLibdragonRoot();
 
-  let info = {
+  if (!projectRoot && !forceReadProjectInfo) {
+    throw new ParameterError(
+      'This is not a libdragon project. Initialize with `libdragon init` first.',
+      info.options.CURRENT_ACTION.name
+    );
+  }
+
+  info = {
+    ...info,
     root: projectRoot ?? (await findNPMRoot()) ?? (await findGitRoot()),
     userInfo: os.userInfo(),
 
     // Use this to discriminate if there is a project when the command is run
+    // Only used for the init action ATM, and it is not ideal to have this here
     haveProjectConfig: !!projectRoot,
 
     // Set the defaults immediately, these should be present at all times even
     // if we are migrating from the old config because they did not exist before
     imageName: DOCKER_HUB_IMAGE,
-    vendorDirectory: path.join('.', LIBDRAGON_SUBMODULE),
+    vendorDirectory: toPosixPath(path.join('.', LIBDRAGON_SUBMODULE)),
     vendorStrategy: DEFAULT_STRATEGY,
   };
 
@@ -158,30 +197,16 @@ async function readProjectInfo() {
   log(`Active vendor directory: ${info.vendorDirectory}`, true);
   log(`Active vendor strategy: ${info.vendorStrategy}`, true);
 
-  // Cache the latest image name
-  setProjectInfoToSave(info);
   return info;
 }
 
-let projectInfoToWrite = {};
 /**
- * Updates project info to be written. The provided keys are overwritten without
- * changing the existing values. When the process exists successfully these will
- * get written to the configuration file. Echoes back the given info.
- * @param info This is only the base info without action properties like showStatus
+ * @param info This is only the base info without options
  * fn and command line options
  */
-function setProjectInfoToSave(info) {
-  projectInfoToWrite = { ...projectInfoToWrite, ...info };
-  return info;
-}
-
-/**
- * @param info This is only the base info without action properties like showStatus
- * fn and command line options
- */
-async function writeProjectInfo(info = projectInfoToWrite) {
+async function writeProjectInfo(info) {
   // Do not log anything here as it may litter the output being always run on exit
+  if (!info) return;
 
   const projectPath = path.join(info.root, LIBDRAGON_PROJECT_MANIFEST);
 
@@ -195,13 +220,17 @@ async function writeProjectInfo(info = projectInfoToWrite) {
     await fs.mkdir(projectPath);
   }
 
+  assert(
+    toPosixPath(info.vendorDirectory) === info.vendorDirectory,
+    new Error('vendorDirectory should always be in posix format')
+  );
+
   await fs.writeFile(
     path.join(projectPath, CONFIG_FILE),
     JSON.stringify(
       {
         imageName: info.imageName,
-        // Always save this in posix format
-        vendorDirectory: toPosixPath(info.vendorDirectory),
+        vendorDirectory: info.vendorDirectory,
         vendorStrategy: info.vendorStrategy,
       },
       null,
@@ -211,4 +240,4 @@ async function writeProjectInfo(info = projectInfoToWrite) {
   log(`Configuration file updated`, true);
 }
 
-module.exports = { readProjectInfo, writeProjectInfo, setProjectInfoToSave };
+module.exports = { readProjectInfo, writeProjectInfo };

package/package.json

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

package/skeleton/Makefile

@@ -3,16 +3,17 @@ SOURCE_DIR=src
 BUILD_DIR=build
 include $(N64_INST)/include/n64.mk
 
-src=main.c
-
 all: hello.z64
+.PHONY: all
+
+OBJS = $(BUILD_DIR)/main.o
 
 hello.z64: N64_ROM_TITLE="Hello World"
-$(BUILD_DIR)/hello.elf: $(src:%.c=$(BUILD_DIR)/%.o)
 
-clean:
-	rm -f $(BUILD_DIR)/* hello.z64
+$(BUILD_DIR)/hello.elf: $(OBJS)
 
--include $(wildcard $(BUILD_DIR)/*.d)
+clean:
+	rm -f $(BUILD_DIR)/* *.z64
+.PHONY: clean
 
-.PHONY: all clean
+-include $(wildcard $(BUILD_DIR)/*.d)