libdragon 10.0.0 → 10.3.1

package/CHANGELOG.md

@@ -1,18 +1,118 @@
 # Change Log
 
+## [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 he 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.
+  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.
+  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.
@@ -62,7 +162,6 @@ git pull, so listing them here will not be useful anymore, let's not bother now.
 - 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

package/README.md

@@ -36,49 +36,15 @@ You can invoke libdragon as follows;
 
     libdragon [flags] <action>
 
-### Available actions
-
-__`init`__
-
-Creates a libdragon project in the current directory. Every libdragon project will have its own docker container instance. If you are in a git repository or an NPM project, libdragon will be initialized at their root also marking there with a `.libdragon` folder.
-
-A git repository and a submodule at `./libdragon` will also be created. Do not remove the `.libdragon` folder and you commit its contents if you are using git, as it keeps persistent libdragon project information.
-
-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.
-
-__`make`__
-
-Runs the libdragon build system in the current directory. It will mirror your current working directory to the container. If you change your host working directory, `make` will be executed in the corresponding folder in the container as well.
-
-This action will first try to execute `make` in the container and if the container is not accessible, it will attempt a complete `start` cycle.
-
-__`install`__
-
-Attempts to build and install everything libdragon related into the container. This includes all the tools and third parties used by libdragon except for the toolchain. If you have made changes to libdragon, you can execute this action to build everything based on your changes. If you are not working on libdragon, you can just use the `update` action instead.
-
-__`update`__
-
-This action will update the submodule from the remote branch (`trunk`) with a merge strategy and then perform a `libdragon install`. You can use the `install` action to only update all libdragon related artifacts in the container given you have an intact `./libdragon` at the root.
-
-__`start`__
-
-Start the container assigned to the current libdragon project. Will first attempt to start an existing container if exists, followed by a new container run and `install` action. Will always print out the container id on success.
-
-__`stop`__
-
-Stop the container assigned to the current libdragon project.
+Run `libdragon help [action]` for more details on individual actions.
 
 ### Available flags
 
-__`--image <docker-image>`__
+**`--image <docker-image>`**
 
 Use this flag to provide a custom image to use instead of the default. It should include the toolchain at `/n64_toolchain`. It will be effective for `init`, `install` and `update` actions and will cause a re-initialization of the container if an image different from what was written to project configuration is provided.
 
-__`--byte-swap`__
-
-Enable byte-swapped ROM output for the build system.
-
-__`--verbose`__
+**`--verbose`**
 
 Be verbose. This will print all commands dispatched and their outputs as well.
 
@@ -88,11 +54,15 @@ After cloning this repository on a system with node.js (`>= 14`) & docker (`>= 1
 
     npm install
 
-This will install all necessary NPM dependencies. Then run;
+This will install all necessary NPM dependencies. Now it is time to get the original libdragon repository. (you can also clone this repository with `--recurse-submodules`)
+
+    git submodule update --init
+
+Then run;
 
     npm run libdragon -- init
 
-to download the pre-built toolchain image from docker hub, get the original libdragon repository as a submodule, start and initialize it. This will also install [test bench](#local-test-bench) dependencies into the container if any.
+to download the pre-built toolchain image, start and initialize it. This will also install [test bench](#local-test-bench) dependencies into the container if any.
 
 Now you will be able to work on the files simultaneously with the docker container and any built binaries will be available in your workspace as it is mounted on the container.
 

package/index.js

@@ -3,95 +3,101 @@
 const chalk = require('chalk');
 const { readProjectInfo, CommandError, globals } = require('./modules/helpers');
 const actions = require('./modules/actions');
+const { printUsage } = require('./modules/usage');
 
 const STATUS_OK = 0;
 const STATUS_ERROR = 1;
 const STATUS_BAD_PARAM = 2;
 
-// Command line options
-const options = {
-  BYTE_SWAP: false,
-  DOCKER_IMAGE: undefined,
-  VERBOSE: false,
-
-  ACTION: undefined,
-  PARAMS: undefined,
-};
-
-// Allow standard io here
-/* eslint-disable no-console */
+let options = {},
+  currentAction;
 
 for (let i = 2; i < process.argv.length; i++) {
   const val = process.argv[i];
 
-  if (val === '--byte-swap') {
-    options.BYTE_SWAP = true;
-    continue;
-  }
+  // Allow console here
+  /* eslint-disable no-console */
 
-  if (val === '--verbose') {
+  if (['--verbose', '-v'].includes(val)) {
     options.VERBOSE = true;
     globals.verbose = true;
     continue;
   }
 
-  if (val === '--image') {
+  if (['--image', '-i'].includes(val)) {
     options.DOCKER_IMAGE = process.argv[++i];
     continue;
+  } else if (val.indexOf('--image=') === 0) {
+    options.DOCKER_IMAGE = val.split('=')[1];
+    continue;
   }
 
   if (val.indexOf('--') >= 0) {
     console.error(chalk.red(`Invalid flag \`${val}\``));
-    actions.help.fn();
+    printUsage();
     process.exit(STATUS_BAD_PARAM);
   }
 
-  if (options.ACTION) {
+  if (currentAction) {
     console.error(
       chalk.red(`Expected only a single action, found: \`${val}\``)
     );
-    actions.help.fn();
+    printUsage();
     process.exit(STATUS_BAD_PARAM);
   }
 
-  options.ACTION = actions[val];
+  currentAction = actions[val];
 
-  if (!options.ACTION) {
+  if (!currentAction) {
     console.error(chalk.red(`Invalid action \`${val}\``));
-    actions.help.fn();
+    printUsage();
     process.exit(STATUS_BAD_PARAM);
   }
 
-  if (options.ACTION.forwardsRestParams) {
+  if (currentAction.forwardsRestParams) {
     options.PARAMS = process.argv.slice(i + 1);
     break;
   }
 }
 
-if (!options.ACTION) {
+if (!currentAction) {
   console.error(chalk.red('No action provided'));
-  actions.help.fn();
+  printUsage();
   process.exit(STATUS_BAD_PARAM);
 }
 
+if (currentAction === actions.exec && options.PARAMS.length === 0) {
+  console.error(chalk.red('You should provide a command to exec'));
+  printUsage(undefined, [currentAction.name]);
+  process.exit(STATUS_BAD_PARAM);
+}
+
+if (
+  ![actions.init, actions.install, actions.update].includes(currentAction) &&
+  options.DOCKER_IMAGE
+) {
+  console.error(chalk.red('Invalid flag: image'));
+  printUsage(undefined, [currentAction.name]);
+  process.exit(STATUS_BAD_PARAM);
+}
 
 readProjectInfo()
   .then((info) =>
-    options.ACTION.fn(
+    currentAction.fn(
       {
         ...info,
         options,
-        ...options.ACTION,
+        ...currentAction,
       },
-      options.PARAMS
+      options.PARAMS ?? []
     )
   )
   .catch((e) => {
-    const userTargetedError = e instanceof CommandError && e.showOutput;
+    const userTargetedError = e instanceof CommandError && e.userCommand;
 
     // Show additional information to user if verbose or we did a mistake
     if (globals.verbose || !userTargetedError) {
-      console.error(chalk.red(globals.verbose? e.stack : e.message));
+      console.error(chalk.red(globals.verbose ? e.stack : e.message));
     }
 
     // Print the underlying error out only if not verbose and we did a mistake