libdragon 11.4.1 → 11.4.3

package/README.md

@@ -222,10 +222,12 @@ npm run libdragon -- update
 
 The root `bench` recipe is for building the code in root `src` folder. This is a quick way of testing your libdragon changes or a sample code built around libdragon, and is called the test bench. This recipe together with `examples` and `tests` recipes will build and install libdragon automatically as necessary. Thus, they will always produce a rom image using the libdragon code in the repository via their make dependencies, which is ideal for experimenting with libdragon itself. 
 
-There are also vscode launch configurations to quickly build the examples, tests and the bench. If you have the `N64_EMU` environment variable set pointing at your favourite emulator ([ares](https://ares-emu.net/) is highly recommended), the launch configurations ending in `(emu)` will kick your emulator with the selected example/code. You can also just hit F5 to launch the selected configuration.
+There are also vscode launch configurations to quickly build and run the examples, tests and the bench. If you have [ares](https://ares-emu.net/) on your `PATH`, the launch configurations ending in `(emu)` will start it automatically. For the examples configuration, you can navigate to the relevant `.c` file and `Run selected example` will start it most of the time. In some cases, the output ROM name may not match the `.c` file and in those cases, you can select the ROM file instead and it should work.
 
 > [!NOTE]
-> This repository also uses [ed64](https://github.com/anacierdem/ed64), so you can use the launch configurations without `(emu)` to run the code if you have an everdrive plugged in and your active configuration will just boot up.
+> This repository also uses [UNFLoader](https://github.com/buu342/N64-UNFLoader), so you can use the launch configurations without `(emu)` to run the code if you have a supported flashcart plugged in and have `UNFLoader` executable on your `PATH`.
+>
+> The special `Debug Test Bench (emu)` configuration will start ares with remote debugging for the test bench if you have `gdb-multiarch` executable on your `PATH`. It should automatically break in your `main` function.
 
 You can clean everything with the `clean` recipe/task (open the command palette and choose `Run Task -> clean`).
 

package/index.js

@@ -30,6 +30,11 @@ const { readProjectInfo, writeProjectInfo } = require('./modules/project-info');
  * @typedef {NoUnion<Exclude<Parameters<import('./modules/parameters').Actions[import('./modules/project-info').ActionsNoProject]['fn']>[0], undefined>>} EitherCLIOrLibdragonInfo
  */
 
+// This is overridden when building for SEA. When running from local or NPM,
+// the package.json version is used by the version action. esbuild will give
+// a warning for this assignment, but it works as expected.
+globalThis.VERSION = "";
+
 parseParameters(process.argv)
   .then(readProjectInfo)
   .then((info) => {

package/modules/actions/init.js

@@ -1,5 +1,3 @@
-/// <reference path="../../globals.d.ts" />
-
 const fs = require('fs/promises');
 const _fs = require('fs');
 const path = require('path');

package/modules/actions/version.js

@@ -1,8 +1,16 @@
-const { version } = require('../../package.json');
-const { log } = require('../helpers');
+const sea = require('node:sea');
+
+const { print } = require('../helpers');
 
 const printVersion = async () => {
-  log(`libdragon-cli v${version}`);
+  // Version is set during build time. If it is not set, it is set to the
+  // package.json version. This is done to avoid bundling the package.json
+  // (which would be out of date) with the built one.
+  if (!globalThis.VERSION) {
+    const { version } = require('../../package.json');
+    globalThis.VERSION = version;
+  }
+  print(`libdragon-cli v${globalThis.VERSION} ${sea.isSea() ? '(sea)' : ''}`);
 };
 
 module.exports = /** @type {const} */ ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libdragon",
-  "version": "11.4.1",
+  "version": "11.4.3",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {
@@ -75,6 +75,7 @@
       [
         "@semantic-release/exec",
         {
+          "verifyReleaseCmd": "echo \"${nextRelease.version}\" >> version.txt",
           "prepareCmd": "npm run bundle ${nextRelease.version}"
         }
       ],