libdragon 10.4.0 → 10.5.0

package/modules/actions/utils.js

@@ -1,9 +1,6 @@
 const path = require('path');
-const fsClassic = require('fs');
 const fs = require('fs/promises');
 
-const _ = require('lodash');
-
 const {
   CONTAINER_TARGET_PATH,
   CACHED_CONTAINER_FILE,
@@ -12,40 +9,27 @@ const {
 const {
   fileExists,
   log,
-  toPosixPath,
   spawnProcess,
   dockerExec,
   dirExists,
   assert,
   CommandError,
+  ValidationError,
+  ParameterError,
+  toNativePath,
 } = require('../helpers');
 
-function dockerHostUserParams(libdragonInfo) {
-  const { uid, gid } = libdragonInfo.userInfo;
-  return ['-u', `${uid >= 0 ? uid : ''}:${gid >= 0 ? gid : ''}`];
-}
-
-async function findNPMRoot() {
-  try {
-    const root = path.resolve((await runNPM(['root'])).trim(), '..');
-    // Only report if package.json really exists. npm fallbacks to cwd
-    if (await fileExists(path.join(root, 'package.json'))) {
-      return root;
-    }
-  } catch {
-    // User does not have and does not care about NPM if it didn't work
-    return undefined;
-  }
-}
+const { dockerHostUserParams } = require('./docker-utils');
+const { installNPMDependencies } = require('./npm-utils');
 
 const installDependencies = async (libdragonInfo) => {
   const buildScriptPath = path.join(
     libdragonInfo.root,
-    libdragonInfo.vendorDirectory,
+    toNativePath(libdragonInfo.vendorDirectory),
     'build.sh'
   );
   if (!(await fileExists(buildScriptPath))) {
-    throw new Error(
+    throw new ValidationError(
       `build.sh not found. Make sure you have a vendored libdragon copy at ${libdragonInfo.vendorDirectory}`
     );
   }
@@ -56,96 +40,13 @@ const installDependencies = async (libdragonInfo) => {
     libdragonInfo,
     [
       '--workdir',
-      CONTAINER_TARGET_PATH +
-        '/' +
-        toPosixPath(
-          path.relative(libdragonInfo.root, libdragonInfo.vendorDirectory)
-        ),
+      CONTAINER_TARGET_PATH + '/' + libdragonInfo.vendorDirectory,
       ...dockerHostUserParams(libdragonInfo),
     ],
     ['/bin/bash', './build.sh']
   );
 
-  // Install other NPM dependencies if this is an NPM project
-  const npmRoot = await findNPMRoot();
-  if (npmRoot) {
-    const packageJsonPath = path.join(npmRoot, 'package.json');
-
-    const { dependencies, devDependencies } = require(packageJsonPath);
-
-    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 new Promise((resolve, reject) => {
-          fsClassic.access(
-            path.join(paths[0], 'Makefile'),
-            fsClassic.F_OK,
-            async (e) => {
-              if (e) {
-                // File does not exist - skip
-                resolve();
-                return;
-              }
-
-              if (paths.length > 1) {
-                reject(
-                  new Error(
-                    `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);
-              }
-            }
-          );
-        });
-      })
-    );
-  }
+  await installNPMDependencies(libdragonInfo);
 };
 
 /**
@@ -173,7 +74,7 @@ const updateImage = async (libdragonInfo, newImageName) => {
       'docker',
       ['images', '-q', '--no-trunc', newImageName],
       false,
-      libdragonInfo.showStatus
+      false
     );
 
   // Attempt to compare digests if the new image name is the same
@@ -186,14 +87,15 @@ const updateImage = async (libdragonInfo, newImageName) => {
     const newDigest = await getDigest();
 
     if (existingDigest === newDigest) {
-      libdragonInfo.showStatus && log(`Image is the same: ${newImageName}`);
+      libdragonInfo.showStatus &&
+        log(`Image is the same: ${newImageName}`, true);
       return false;
     }
   } else {
     await download();
   }
 
-  libdragonInfo.showStatus && log(`Image is different: ${newImageName}`);
+  libdragonInfo.showStatus && log(`Image is different: ${newImageName}`, true);
   return newImageName;
 };
 
@@ -246,13 +148,6 @@ async function runGitMaybeHost(libdragonInfo, params, interactive = 'full') {
   }
 }
 
-function runNPM(params) {
-  return spawnProcess(
-    /^win/.test(process.platform) ? 'npm.cmd' : 'npm',
-    params
-  );
-}
-
 async function checkContainerAndClean(libdragonInfo) {
   const id =
     libdragonInfo.containerId &&
@@ -301,14 +196,22 @@ async function tryCacheContainerId(libdragonInfo) {
   }
 }
 
+// Throws if the project was not initialized for the current libdragonInfo
+async function mustHaveProject(libdragonInfo) {
+  if (!libdragonInfo.haveProjectConfig) {
+    throw new ParameterError(
+      'This is not a libdragon project. Initialize with `libdragon init` first.'
+    );
+  }
+}
+
 module.exports = {
   installDependencies,
   updateImage,
   destroyContainer,
   checkContainerRunning,
   checkContainerAndClean,
-  dockerHostUserParams,
   tryCacheContainerId,
   runGitMaybeHost,
-  findNPMRoot,
+  mustHaveProject,
 };

package/modules/actions/version.js

@@ -0,0 +1,17 @@
+const { version } = require('../../package.json');
+const { log } = require('../helpers');
+
+const printVersion = async () => {
+  log(`libdragon-cli v${version}`);
+};
+
+module.exports = {
+  name: 'version',
+  fn: printVersion,
+  showStatus: false,
+  usage: {
+    name: 'version',
+    summary: 'Display cli version.',
+    description: `Displays currently running cli version.`,
+  },
+};

package/modules/constants.js

@@ -13,6 +13,7 @@ module.exports = {
   STATUS_OK: 0,
   STATUS_ERROR: 1,
   STATUS_BAD_PARAM: 2,
+  STATUS_VALIDATION_ERROR: 4,
 
   IMAGE_FILE: 'docker-image', // deprecated
 };

package/modules/helpers.js

@@ -6,6 +6,7 @@ const { spawn } = require('child_process');
 
 const { globals } = require('./globals');
 
+// An error caused by a command explicitly run by the user
 class CommandError extends Error {
   constructor(message, { code, out, userCommand }) {
     super(message);
@@ -15,12 +16,20 @@ class CommandError extends Error {
   }
 }
 
+// The user provided an unexpected input
 class ParameterError extends Error {
   constructor(message) {
     super(message);
   }
 }
 
+// Something was not as expected to continue the operation
+class ValidationError extends Error {
+  constructor(message) {
+    super(message);
+  }
+}
+
 async function fileExists(path) {
   return fs
     .stat(path)
@@ -200,7 +209,11 @@ async function copyDirContents(src, dst) {
 }
 
 function toPosixPath(p) {
-  return p.replace(new RegExp('\\' + path.sep), path.posix.sep);
+  return p.replace(new RegExp('\\' + path.sep, 'g'), path.posix.sep);
+}
+
+function toNativePath(p) {
+  return p.replace(new RegExp('\\' + path.posix.sep, 'g'), path.sep);
 }
 
 function assert(condition, error) {
@@ -210,6 +223,7 @@ function assert(condition, error) {
   }
 }
 
+// TODO: we can handle showStatus here
 function log(text, verboseOnly = false) {
   if (!verboseOnly) {
     // eslint-disable-next-line no-console
@@ -226,6 +240,7 @@ function log(text, verboseOnly = false) {
 module.exports = {
   spawnProcess,
   toPosixPath,
+  toNativePath,
   log,
   dockerExec,
   assert,
@@ -234,4 +249,5 @@ module.exports = {
   copyDirContents,
   CommandError,
   ParameterError,
+  ValidationError,
 };

package/modules/project-info.js

@@ -4,11 +4,12 @@ const fs = require('fs/promises');
 
 const {
   checkContainerAndClean,
-  findNPMRoot,
   runGitMaybeHost,
   tryCacheContainerId,
 } = require('./actions/utils');
 
+const { findNPMRoot } = require('./actions/npm-utils');
+
 const {
   LIBDRAGON_PROJECT_MANIFEST,
   CONFIG_FILE,
@@ -24,8 +25,8 @@ const {
   fileExists,
   log,
   spawnProcess,
-  dirExists,
   toPosixPath,
+  assert,
 } = require('./helpers');
 
 async function findContainerId(libdragonInfo) {
@@ -67,8 +68,8 @@ async function findContainerId(libdragonInfo) {
 }
 
 async function findLibdragonRoot(start = '.') {
-  const manifest = path.join(start, LIBDRAGON_PROJECT_MANIFEST);
-  if (await dirExists(manifest)) {
+  const manifest = path.join(start, LIBDRAGON_PROJECT_MANIFEST, CONFIG_FILE);
+  if (await fileExists(manifest)) {
     return path.resolve(start);
   } else {
     const parent = path.resolve(start, '..');
@@ -89,41 +90,21 @@ async function findGitRoot() {
   }
 }
 
-/**
- * Creates the manifest folder if it does not exist. Will return true if
- * created, false otherwise.
- */
-async function createManifestIfNotExist(libdragonInfo) {
-  const manifestPath = path.join(
-    libdragonInfo.root,
-    LIBDRAGON_PROJECT_MANIFEST
-  );
-  const manifestExists = await fs.stat(manifestPath).catch((e) => {
-    if (e.code !== 'ENOENT') throw e;
-    return false;
-  });
-
-  if (manifestExists && !manifestExists.isDirectory()) {
-    throw new Error(
-      'There is already a `.libdragon` file and it is not a directory.'
-    );
-  }
-
-  if (!manifestExists) {
-    log(
-      `Creating libdragon project configuration at \`${libdragonInfo.root}\`.`
-    );
-    await fs.mkdir(manifestPath);
-  }
-}
-
 async function readProjectInfo() {
+  const projectRoot = await findLibdragonRoot();
+
   let info = {
-    root:
-      (await findLibdragonRoot()) ??
-      (await findNPMRoot()) ??
-      (await findGitRoot()),
+    root: projectRoot ?? (await findNPMRoot()) ?? (await findGitRoot()),
     userInfo: os.userInfo(),
+
+    // Use this to discriminate if there is a project when the command is run
+    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: toPosixPath(path.join('.', LIBDRAGON_SUBMODULE)),
+    vendorStrategy: DEFAULT_STRATEGY,
   };
 
   if (!info.root) {
@@ -180,47 +161,45 @@ async function readProjectInfo() {
     ).trim();
   }
 
-  info.imageName = info.imageName ?? DOCKER_HUB_IMAGE;
   log(`Active image name: ${info.imageName}`, true);
-
-  info.vendorDirectory =
-    info.vendorDirectory ?? path.join('.', LIBDRAGON_SUBMODULE);
   log(`Active vendor directory: ${info.vendorDirectory}`, true);
-
-  info.vendorStrategy = info.vendorStrategy ?? DEFAULT_STRATEGY;
   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 libdragonInfo
+ * @param info This is only the base info without action properties like showStatus
+ * fn and command line options
  */
-function setProjectInfoToSave(libdragonInfo) {
-  projectInfoToWrite = { ...projectInfoToWrite, ...libdragonInfo };
-  return libdragonInfo;
-}
+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);
 
-async function writeProjectInfo(libdragonInfo = projectInfoToWrite) {
-  await createManifestIfNotExist(libdragonInfo);
-  const manifestPath = path.join(
-    libdragonInfo.root,
-    LIBDRAGON_PROJECT_MANIFEST
+  const pathExists = await fs.stat(projectPath).catch((e) => {
+    if (e.code !== 'ENOENT') throw e;
+    return false;
+  });
+
+  if (!pathExists) {
+    log(`Creating libdragon project configuration at \`${info.root}\`.`, true);
+    await fs.mkdir(projectPath);
+  }
+
+  assert(
+    toPosixPath(info.vendorDirectory) === info.vendorDirectory,
+    new Error('vendorDirectory should always be in posix format')
   );
+
   await fs.writeFile(
-    path.join(manifestPath, CONFIG_FILE),
+    path.join(projectPath, CONFIG_FILE),
     JSON.stringify(
       {
-        imageName: libdragonInfo.imageName,
-        // Always save this in posix format
-        vendorDirectory: toPosixPath(libdragonInfo.vendorDirectory),
-        vendorStrategy: libdragonInfo.vendorStrategy,
+        imageName: info.imageName,
+        vendorDirectory: info.vendorDirectory,
+        vendorStrategy: info.vendorStrategy,
       },
       null,
       '  '
@@ -229,4 +208,4 @@ async function writeProjectInfo(libdragonInfo = 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.0",
+  "version": "10.5.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)