libdragon 10.9.0 → 11.0.0

package/README.md

@@ -6,7 +6,7 @@ This is a wrapper for a docker container to make managing the libdragon toolchai
 
 ## Prerequisites
 
-You should have [docker](https://www.docker.com/products/docker-desktop) (`>= 18`) installed on your system.
+You should have [docker](https://www.docker.com/products/docker-desktop) (`>= 24`) installed on your system.
 
 `git` is not strictly required to use the tool. Still, it is highly recommended to have git on your host machine as it will be used instead of the one in the container.
 
@@ -51,9 +51,11 @@ Download the [pre-built executable](https://github.com/anacierdem/libdragon-dock
 
 ### via NPM
 
-Install [node.js](https://nodejs.org/en/download/) (`>= 14`) and install `libdragon` as a global NPM package;
+Install [node.js](https://nodejs.org/en/download/) (`>= 18`) and install `libdragon` as a global NPM package;
 
+```bash
     npm install -g libdragon
+```
 
 To update the tool to the latest, do `npm i -g libdragon@latest`.
 
@@ -61,19 +63,25 @@ To update the tool to the latest, do `npm i -g libdragon@latest`.
 
 Navigate to the folder you want to initialize your project and invoke libdragon;
 
+```bash
     libdragon init
+```
 
 On first `init` an example project will be created, the container will be downloaded, started and latest libdragon will get installed on it with all the example ROMs built. You can find all the example ROMs in the `libdragon` folder.
 
 The container's `make` can be invoked on your current working directory via;
 
+```
     libdragon make
+```
 
 Any additonal parameters are passed down to the actual make command. You can work on the files simultaneously with the docker container and any built artifacts will be available in project directory as it is mounted on the container.
 
 To update the library and rebuild/install all the artifacts;
 
+```
     libdragon update
+```
 
 In general, you can invoke libdragon as follows;
 
@@ -87,22 +95,32 @@ Run `libdragon help [action]` for more details on individual actions.
 
 Initialize your project as usual:
 
+```bash
     libdragon init
+```
 
 Then switch the submodule to the desired branch:
 
-    cd ./libdragon
-    git checkout opengl
-    cd ..
+```bash
+    git -C ./libdragon checkout opengl
     libdragon install
+```
+
+If your changes are on a different remote, then you will need to manage your git remotes as usual. If you also want to update the remote tracking branch for the submodule, run:
+
+```bash
+    git submodule set-branch -b opengl libdragon
+```
 
-If your changes are on a different remote, then you will need to manage your git remotes as usual.
+This will update the branch on `.gitmodules` and if you commit that change, subsequent initializations will use the `opengl` branch by default.
 
 ### Testing changes on libdragon
 
 As libdragon is an actively developed library, you may find yourself at a position where you want to change a few things on it and see how it works. In general, if you modify the files in `libdragon` folder of your project, you can install that version to the docker container by simply running:
 
+```bash
     libdragon install
+```
 
 This will update all the artifacts in your container and your new code will start linking against the new version when you re-build it via `libdragon make`. The build system should pick up the change in the library and re-compile the dependent files.
 
@@ -132,17 +150,23 @@ To be able to share your project with the library change, you just commit your c
 
 ## Working on this repository
 
-After cloning this repository on a system with node.js (`>= 14`) & docker (`>= 18`), in this repository's root do;
+After cloning this repository on a system with node.js (`>= 18`) & docker (`>= 24`), in this repository's root do;
 
+```bash
     npm install
+```
 
 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`)
 
+```bash
     git submodule update --init
+```
 
 Then run;
 
+```bash
     npm run libdragon -- init
+```
 
 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.
 
@@ -160,17 +184,23 @@ There is a root `Makefile` making deeper makefiles easier with these recipes;
 
 For example, to re-build the original libdragon examples do;
 
+```bash
     npm run libdragon -- make examples
+```
 
 Similarly to run the `clean` recipe, run;
 
+```bash
     npm run libdragon -- make clean
+```
 
 Keep in mind that `--` is necessary for actual arguments when using npm scripts.
 
 To update the submodule and re-build everything;
 
+```bash
     npm run libdragon -- update
+```
 
 ### Local test bench
 
@@ -182,22 +212,36 @@ There are also additional vscode launch configurations to build libdragon exampl
 
 For a quick development loop it really helps linking the code in this repository as the global libdragon installation. To do this run;
 
+```bash
     npm link
+```
 
 in the root of the repository. Once you do this, running `libdragon` will use the code here rather than the actual npm installation. Then you can test your changes in the libdragon project here or elsewhere on your computer. This setup is automatically done if you use the [devcontainer](#experimental-devcontainer-support).
 
 When you are happy with your changes, you can verify you conform to the coding standards via:
 
+```bash
     npm run format-check
     npm run lint-check
+```
 
 You can auto-fix applicable errors by running `format` and `lint` scripts instead. Additionally, typescript is used as the type system. To be able to get away with transpiling the code during development, jsDoc flavor of types are used instead of inline ones. To check your types, run:
 
+```bash
     npm run tsc
+```
+
+To run the test suite:
+
+```bash
+    npm run test
+```
 
 This repository uses [`semantic-release`](https://github.com/semantic-release/semantic-release) and manages releases from specially formatted commit messages. To simplify creating them you can use:
 
+```bash
     npx cz
+```
 
 It will create a `semantic-release` compatible commit from your current staged changes.
 
@@ -268,3 +312,4 @@ This is an experimental dependency management.
 ## Funding
 
 If this tool helped you, consider supporting its development by sponsoring it!
+

package/modules/actions/install.js

@@ -1,9 +1,5 @@
-const chalk = require('chalk').stderr;
-
 const { installDependencies } = require('./utils');
 const { start } = require('./start');
-const { syncImageAndStart } = require('./update-and-start');
-const { log } = require('../helpers');
 
 /**
  * Updates the image if flag is provided and install vendors onto the container.
@@ -15,22 +11,11 @@ const install = async (libdragonInfo) => {
   let updatedInfo = libdragonInfo;
 
   if (!process.env.DOCKER_CONTAINER) {
-    const imageName = libdragonInfo.options.DOCKER_IMAGE;
-    // If an image is provided, attempt to install
-    if (imageName) {
-      log(
-        chalk.yellow(
-          'Using `install` action to update the docker image is deprecated. Use the `update` action instead.'
-        )
-      );
-      updatedInfo = await syncImageAndStart(libdragonInfo);
-    } else {
-      // Make sure existing one is running
-      updatedInfo = {
-        ...updatedInfo,
-        containerId: await start(libdragonInfo),
-      };
-    }
+    // Make sure existing one is running
+    updatedInfo = {
+      ...updatedInfo,
+      containerId: await start(libdragonInfo),
+    };
   }
 
   // Re-install vendors on new image

package/modules/constants.js

@@ -21,6 +21,4 @@ module.exports = /** @type {const} */ ({
   STATUS_ERROR: 1,
   STATUS_BAD_PARAM: 2,
   STATUS_VALIDATION_ERROR: 4,
-
-  IMAGE_FILE: 'docker-image', // deprecated
 });

package/modules/parameters.js

@@ -121,7 +121,6 @@ const parseParameters = async (argv) => {
     !(
       /** @type {typeof actions[keyof actions][]} */ ([
         actions.init,
-        actions.install,
         actions.update,
       ]).includes(options.CURRENT_ACTION)
     ) &&

package/modules/project-info.js

@@ -14,7 +14,6 @@ const {
   CONFIG_FILE,
   DOCKER_HUB_IMAGE,
   DEFAULT_STRATEGY,
-  IMAGE_FILE,
   LIBDRAGON_SUBMODULE,
   CACHED_CONTAINER_FILE,
   CONTAINER_TARGET_PATH,
@@ -159,15 +158,7 @@ const readProjectInfo = async function (optionInfo) {
     return /** @type {NoProjectInfo} */ (optionInfo);
   }
 
-  const migratedRoot = await findLibdragonRoot();
-
-  // Look for old one for backwards compatibility
-  const projectRoot =
-    migratedRoot ??
-    (await findLibdragonRoot(
-      '.',
-      path.join(LIBDRAGON_PROJECT_MANIFEST, IMAGE_FILE)
-    ));
+  const projectRoot = await findLibdragonRoot();
 
   if (
     !projectRoot &&
@@ -204,7 +195,7 @@ const readProjectInfo = async function (optionInfo) {
 
   log(`Project root: ${info.root}`, true);
 
-  if (migratedRoot) {
+  if (projectRoot) {
     info = {
       ...info,
       ...JSON.parse(
@@ -214,20 +205,6 @@ const readProjectInfo = async function (optionInfo) {
         )
       ),
     };
-  } else {
-    // Cleanup old files and migrate to the new config file
-    const imageFile = path.join(
-      info.root,
-      LIBDRAGON_PROJECT_MANIFEST,
-      IMAGE_FILE
-    );
-    if (await fileExists(imageFile)) {
-      info.imageName = (
-        await fs.readFile(imageFile, { encoding: 'utf8' })
-      ).trim();
-      // Immediately update the config as this is the first migration
-      await Promise.all([writeProjectInfo(info), fs.rm(imageFile)]);
-    }
   }
 
   if (!process.env.DOCKER_CONTAINER) {

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "libdragon",
-  "version": "10.9.0",
+  "version": "11.0.0",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {
-    "node": ">=14",
+    "node": ">=18",
     "npm": ">=8"
   },
   "bin": {
     "libdragon": "./index.js"
   },
   "scripts": {
+    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js",
     "libdragon": "node index.js",
     "start": "node index.js start",
     "stop": "node index.js stop",
@@ -50,10 +51,14 @@
     "cz-conventional-changelog": "^3.3.0",
     "ed64": "^2.0.4",
     "eslint": "^7.32.0",
+    "ffi-napi": "^4.0.3",
+    "jest": "^29.5.0",
     "pkg": "^5.5.2",
     "prettier": "^2.4.0",
-    "semantic-release": "^19.0.2",
-    "typescript": "^4.7.4"
+    "ref-napi": "^3.0.3",
+    "semantic-release": "^21.0.9",
+    "typescript": "^4.7.4",
+    "zx": "^7.2.2"
   },
   "overrides": {
     "minimist": "1.2.6"