libdragon 10.7.0 → 10.7.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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
@@ -8,22 +19,6 @@
 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.
-- Skip reading the project information for `version` and `help` commands. This
-was breaking things when these were run with a stopped docker service.
-- Resolved a potential failure case where the host mount path is not reported
-as a native path. That would prevent proper container discovery. This was not
-being an issue previously but I realized it was not working for Windows now.
-- Do not throw if the output stream is not finalized. This was previously causing
-issues when the long output of a command is piped to another process like `less`.
-Fixes #46
-- Produce a correct error if an invalid flag with a singe `-` is provided.
-- Sekeleton project's Makefile `clean` recipe now works properly. Fixes #56.
-- A case where it is impossible to recover the container is fixed. This was
-happening when the host does not have git and the cached container file is
-missing. In that case the cli was attempting to run git without the containerId.
-- `destroy` can now cleanup any remaining container even if the project init was
-failed. This is also useful to clean up old folders that were once libdragon
-projects.
 
 ### Added
 

package/index.js

@@ -2,7 +2,6 @@
 
 const chalk = require('chalk').stderr;
 
-const { fn: printUsage } = require('./modules/actions/help');
 const {
   STATUS_OK,
   STATUS_BAD_PARAM,
@@ -25,11 +24,6 @@ parseParameters(process.argv)
   .catch((e) => {
     if (e instanceof ParameterError) {
       log(chalk.red(e.message));
-      printUsage({
-        options: {
-          EXTRA_PARAMS: [e.actionName],
-        },
-      });
       process.exit(STATUS_BAD_PARAM);
     }
     if (e instanceof ValidationError) {

package/modules/parameters.js

@@ -2,7 +2,6 @@ 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');
 
@@ -56,13 +55,11 @@ const parseParameters = async (argv) => {
 
     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);
     }
 
@@ -70,7 +67,6 @@ const parseParameters = async (argv) => {
 
     if (!options.CURRENT_ACTION) {
       log(chalk.red(`Invalid action \`${val}\``));
-      printUsage();
       process.exit(STATUS_BAD_PARAM);
     }
 
@@ -82,7 +78,6 @@ const parseParameters = async (argv) => {
 
   if (!options.CURRENT_ACTION) {
     log(chalk.red('No action provided'));
-    printUsage();
     process.exit(STATUS_BAD_PARAM);
   }
 
@@ -91,7 +86,6 @@ const parseParameters = async (argv) => {
     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);
   }
 
@@ -102,7 +96,6 @@ const parseParameters = async (argv) => {
     options.DOCKER_IMAGE
   ) {
     log(chalk.red('Invalid flag: image'));
-    printUsage(undefined, [options.CURRENT_ACTION.name]);
     process.exit(STATUS_BAD_PARAM);
   }
 
@@ -111,13 +104,11 @@ const parseParameters = async (argv) => {
     !['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);
   }
 

package/modules/project-info.js

@@ -77,17 +77,21 @@ async function findContainerId(libdragonInfo) {
   }
 }
 
-async function findLibdragonRoot(start = '.') {
-  const manifest = path.join(start, LIBDRAGON_PROJECT_MANIFEST, CONFIG_FILE);
-  if (await fileExists(manifest)) {
+async function findLibdragonRoot(
+  start = '.',
+  relativeFile = path.join(LIBDRAGON_PROJECT_MANIFEST, CONFIG_FILE)
+) {
+  const fileToCheck = path.join(start, relativeFile);
+  log(`Checking if file exists: ${path.resolve(fileToCheck)}`, true);
+  if (await fileExists(fileToCheck)) {
     return path.resolve(start);
+  }
+
+  const parent = path.resolve(start, '..');
+  if (parent !== path.resolve(start)) {
+    return findLibdragonRoot(parent, relativeFile);
   } else {
-    const parent = path.resolve(start, '..');
-    if (parent !== path.resolve(start)) {
-      return findLibdragonRoot(parent);
-    } else {
-      return;
-    }
+    return;
   }
 }
 
@@ -114,7 +118,15 @@ async function readProjectInfo(info) {
     return info;
   }
 
-  const projectRoot = await findLibdragonRoot();
+  const migratedRoot = await findLibdragonRoot();
+
+  // Look for old one for backwards compatibility
+  const projectRoot =
+    migratedRoot ??
+    (await findLibdragonRoot(
+      '.',
+      path.join(LIBDRAGON_PROJECT_MANIFEST, IMAGE_FILE)
+    ));
 
   if (!projectRoot && !forceReadProjectInfo) {
     throw new ParameterError(
@@ -146,16 +158,15 @@ async function readProjectInfo(info) {
 
   log(`Project root: ${info.root}`, true);
 
-  const configFile = path.join(
-    info.root,
-    LIBDRAGON_PROJECT_MANIFEST,
-    CONFIG_FILE
-  );
-
-  if (await fileExists(configFile)) {
+  if (migratedRoot) {
     info = {
       ...info,
-      ...JSON.parse(await fs.readFile(configFile, { encoding: 'utf8' })),
+      ...JSON.parse(
+        await fs.readFile(
+          path.join(info.root, LIBDRAGON_PROJECT_MANIFEST, CONFIG_FILE),
+          { encoding: 'utf8' }
+        )
+      ),
     };
   } else {
     // Cleanup old files and migrate to the new config file

package/package.json

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