@gjsify/oxfmt-native 0.22.0 → 0.23.0

package/README.md

@@ -1,6 +1,6 @@
 # @gjsify/oxfmt-native
 
-A native Rust cdylib + Vala/GObject bridge that wraps oxc's formatter ([oxfmt](https://oxc.rs/docs/guide/usage/formatter)) and exposes it to GJS via `gi://`. This is the formatter engine used by `gjsify format` / `gjsify fix` under GJS — npm's `oxfmt` is a Rust N-API binary that cannot load in GJS, so this bridge is how gjsify formats without a Node runtime. The bridge links oxfmt's pure-Rust CLI core, so the full CLI surface runs in-process: `.oxfmtrc(.json)` + `.editorconfig` resolution, ignore handling, parallel file walking, `--write` / `--check` / `--list-different`. Ships prebuilt `.so` + `.gir` + `.typelib` for Linux.
+A native Rust cdylib + Vala/GObject bridge that wraps oxc's formatter ([oxfmt](https://oxc.rs/docs/guide/usage/formatter)) and exposes it to GJS via `gi://`. This is the formatter engine used by `gjsify format` / `gjsify fix` under GJS — npm's `oxfmt` is a Rust N-API binary that cannot load in GJS, so this bridge is how gjsify formats without a Node runtime. The bridge links oxfmt's pure-Rust CLI core, so the full CLI surface runs in-process: `.oxfmtrc(.json)` + `.editorconfig` resolution, ignore handling, parallel file walking, `--write` / `--check` / `--list-different`. Ships prebuilt native libraries + `.gir` + `.typelib` for Linux and macOS — see [Platform coverage](#platform-coverage).
 
 Part of the [gjsify](https://github.com/gjsify/gjsify) project — Node.js and Web APIs for GJS (GNOME JavaScript).
 
@@ -40,6 +40,26 @@ git submodule update --init refs/oxc
 gjsify workspace @gjsify/oxfmt-native build:prebuilds   # needs meson + vala + cargo
 ```
 
+## Platform coverage
+
+| Platform | Prebuild | Built by |
+|---|---|---|
+| `linux-x86_64` | ✅ `.so` + `.gir` + `.typelib` | native runner |
+| `linux-aarch64` | ✅ | native runner |
+| `linux-ppc64`, `linux-s390x`, `linux-riscv64` | ❌ | not built — the `refs/oxc` crate graph is too slow under QEMU |
+| `darwin-arm64` (macOS, Apple silicon) | ✅ `.dylib` + `.gir` + `.typelib` | `macos-latest` runner |
+| `darwin-x64` (macOS, Intel) | ❌ | — no runner leg yet |
+| Windows | ❌ | — no Vala/GI bridge in this repo targets Windows |
+
+All prebuilds are produced by [`.github/workflows/prebuilds.yml`](../../../.github/workflows/prebuilds.yml)
+and committed back to the repository.
+
+**Known gap — a `darwin-arm64` prebuild is built and shipped, but the CLI does not
+load it yet.** `detectNativePackages()` (`packages/infra/cli/src/utils/detect-native-packages.ts`)
+hardcodes a `linux-` directory prefix, and `buildNativeEnv()` exports `LD_LIBRARY_PATH`,
+which macOS `dyld` ignores in favour of `DYLD_LIBRARY_PATH`. Both are CLI-side fixes;
+until they land, `gjsify format` on macOS falls back to spawning the npm `oxfmt` Node launcher.
+
 ## License
 
 MIT

package/meson.build

@@ -17,6 +17,48 @@ vala_deps = [
     dependency('gobject-2.0'),
 ]
 
+# ----------------------------------------------------------------------------
+# Host-dependent naming + runtime-lookup conventions
+#
+# Three things differ per host and MUST agree, or the prebuild loads on one
+# platform and silently fails on the other (mirrors @gjsify/napi's meson
+# branch):
+#
+#   1. cargo's cdylib leaf     — libgjsify_oxfmt.{so,dylib}
+#   2. meson's library() leaf  — libgjsifyoxfmt.{so,dylib}; the typelib records
+#      this name and gjs' g_module_open() resolves exactly it at load.
+#   3. how the Vala library finds its sibling Rust cdylib at runtime. Both
+#      files ship side by side in prebuilds/<platform>-<arch>/, so the lookup
+#      must be relative to the loading binary: $ORIGIN on ELF, @loader_path on
+#      Mach-O. On macOS this is load-bearing — unlike Linux (where the CLI
+#      exports LD_LIBRARY_PATH for the prebuild dir) nothing sets
+#      DYLD_LIBRARY_PATH, so the rpath is the ONLY way the cdylib is found.
+#
+# Windows is deliberately absent: no Vala bridge here has had any Windows
+# portability work, so `else` (ELF naming) is the honest fallback rather than a
+# .dll branch that would imply support that does not exist.
+# ----------------------------------------------------------------------------
+host_system = host_machine.system()
+
+if host_system == 'darwin'
+    rust_cdylib_name = 'libgjsify_oxfmt.dylib'
+    shared_lib_name = 'libgjsifyoxfmt.dylib'
+    lib_rpath = '@loader_path'
+    # Normalise the cdylib's LC_ID_DYLIB to @rpath/<leaf> BEFORE the Vala
+    # library links against it: ld64 copies the dependency's install name
+    # verbatim into the dependent's LC_LOAD_DYLIB. rustc's own install name has
+    # varied across releases (absolute build path in older rustc, @rpath/<leaf>
+    # in current ones); pinning it here makes the recorded dependency
+    # rustc-version-independent, and @rpath/ is never longer than an absolute
+    # path so install_name_tool can always rewrite in place.
+    rust_cdylib_post = ' && install_name_tool -id "@rpath/' + rust_cdylib_name + '" "$3"'
+else
+    rust_cdylib_name = 'libgjsify_oxfmt.so'
+    shared_lib_name = 'libgjsifyoxfmt.so'
+    lib_rpath = '$ORIGIN'
+    rust_cdylib_post = ''
+endif
+
 # ----------------------------------------------------------------------------
 # Rust cdylib (cargo)
 #
@@ -35,9 +77,10 @@ rust_target_dir = meson.current_build_dir() / 'cargo-target'
 
 rust_cdylib = custom_target('gjsify-oxfmt-rust',
     input:  rust_sources,
-    output: 'libgjsify_oxfmt.so',
+    output: rust_cdylib_name,
     command: ['sh', '-c',
-              'cargo build --release --manifest-path "$1" --target-dir "$2" && cp "$2/release/libgjsify_oxfmt.so" "$3"',
+              'cargo build --release --manifest-path "$1" --target-dir "$2" && cp "$2/release/'
+                  + rust_cdylib_name + '" "$3"' + rust_cdylib_post,
               'sh',
               meson.current_source_dir() / 'src/rust/Cargo.toml',
               rust_target_dir,
@@ -68,7 +111,11 @@ libGjsifyOxfmt = library('gjsifyoxfmt', sources,
     link_depends: rust_cdylib,
     install: true,
     install_dir: [true, true, true, true],
-    install_rpath: '$ORIGIN',
+    # `build_rpath` (not just `install_rpath`) is what matters for the prebuild:
+    # the artifact shipped in prebuilds/ is copied straight out of the build
+    # dir, never through `meson install`, so only the build-tree rpath survives.
+    build_rpath: lib_rpath,
+    install_rpath: lib_rpath,
 )
 
 g_ir_compiler = find_program('g-ir-compiler')
@@ -76,7 +123,7 @@ g_ir_compiler = find_program('g-ir-compiler')
 custom_target(meson.project_name() + '-1.0.typelib',
     command: [
         g_ir_compiler,
-        '--shared-library', 'libgjsifyoxfmt.so',
+        '--shared-library', shared_lib_name,
         '--output', '@OUTPUT@',
         meson.current_build_dir() / meson.project_name() + '-1.0.gir',
     ],

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/oxfmt-native",
-    "version": "0.22.0",
+    "version": "0.23.0",
     "description": "Vala/GObject + Rust cdylib bridge to oxc's formatter (oxfmt) for GJS. Formats JavaScript/TypeScript/JSX under GJS without a Node runtime — the Node-free counterpart to the npm `oxfmt` native napi binary, backing `gjsify format` under GJS. Wraps oxc_formatter (Prettier-compatible) via a single-shot FFI; the embedded CSS/HTML/Markdown ExternalFormatter (Prettier-NAPI) is out of scope.",
     "type": "module",
     "main": "lib/esm/index.js",
@@ -20,6 +20,11 @@
         "src/vala"
     ],
     "gjsify": {
+        "platforms": [
+            "linux-x86_64",
+            "linux-aarch64",
+            "darwin-arm64"
+        ],
         "prebuilds": "prebuilds",
         "runtimes": {
             "gjs": "polyfill",
@@ -36,9 +41,9 @@
         "init:meson:wipe": "gjsify run init:meson --wipe",
         "build": "gjsify run build:gjsify && gjsify run build:types",
         "build:gjsify": "gjsify build --library 'src/ts/**/*.{ts,js}'",
-        "build:meson": "gjsify run init:meson && meson compile -C build",
+        "build:meson": "node ../../../scripts/check-refs-pin.mjs . && gjsify run init:meson && meson compile -C build",
         "build:types": "gjsify tsc",
-        "build:prebuilds": "gjsify run build:meson && mkdir -p prebuilds/linux-x86_64 && cp build/libgjsifyoxfmt.so build/libgjsify_oxfmt.so build/GjsifyOxfmt-1.0.gir build/GjsifyOxfmt-1.0.typelib prebuilds/linux-x86_64/"
+        "build:prebuilds": "gjsify run build:meson && node ../../../scripts/stage-prebuild.mjs ."
     },
     "keywords": [
         "gjs",
@@ -57,7 +62,7 @@
         "@girs/gobject-2.0": "^4.1.0"
     },
     "devDependencies": {
-        "@gjsify/cli": "^0.22.0",
+        "@gjsify/cli": "^0.23.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },