@gjsify/oxfmt-native 0.4.44

package/README.md

@@ -0,0 +1,45 @@
+# @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.
+
+Part of the [gjsify](https://github.com/gjsify/gjsify) project — Node.js and Web APIs for GJS (GNOME JavaScript).
+
+## Installation
+
+```bash
+gjsify install @gjsify/oxfmt-native
+```
+
+## Usage
+
+```typescript
+import { hasNativeOxfmt, format, runOxfmt } from '@gjsify/oxfmt-native';
+
+if (hasNativeOxfmt()) {
+    // Single-shot in-memory format (Prettier-compatible defaults)
+    console.log(format('const   x:number=1', 'input.ts'));
+    // => "const x: number = 1;\n"
+
+    // Full oxfmt CLI in-process (argv WITHOUT the program name).
+    // Honors .oxfmtrc(.json) / .editorconfig, prints to stdout/stderr,
+    // returns the process exit code.
+    const code = runOxfmt(['--check', '--config', '/abs/.oxfmtrc.json', 'src']);
+}
+```
+
+Not covered (requires oxfmt's Node-API host by design): the embedded CSS/HTML/Vue/Markdown Prettier `ExternalFormatter`, JS/TS config files (`.oxfmtrc.ts`), `--init` / `--migrate`, LSP and stdin mode.
+
+Under normal usage `@gjsify/oxfmt-native` is consumed automatically by the gjsify CLI (`gjsify format`, `gjsify fix`) — direct use is only needed when embedding the formatter in custom tooling.
+
+## Building from source
+
+The Rust shim path-deps into the `refs/oxc` submodule (pinned to the `oxfmt_v*` tag matching the workspace's npm `oxfmt` devDependency — `oxc_formatter` is yanked on crates.io, the formatter lives in-tree only):
+
+```bash
+git submodule update --init refs/oxc
+gjsify workspace @gjsify/oxfmt-native build:prebuilds   # needs meson + vala + cargo
+```
+
+## License
+
+MIT

package/lib/esm/_virtual/_rolldown/runtime.js

@@ -0,0 +1 @@
+var e=Object.defineProperty,__name=(t,n)=>e(t,`name`,{value:n,configurable:!0});export{__name};

package/lib/esm/index.js

@@ -0,0 +1 @@
+import"./_virtual/_rolldown/runtime.js";function gi(){return globalThis.imports?.gi}let e=null,t=!1,n=null;function loadNativeOxfmt(){if(t)return e;t=!0;try{let t=gi();if(!t)return n=Error(`imports.gi not available — not running under GJS?`),null;let r=t.GjsifyOxfmt;return r?(e=r,e):(n=Error(`GjsifyOxfmt typelib not found on GI_TYPELIB_PATH`),null)}catch(t){return n=t instanceof Error?t:Error(String(t)),e=null,null}}function hasNativeOxfmt(){return loadNativeOxfmt()!==null}function getOxfmtLoadError(){return n}function format(e,t=`input.ts`){let r=loadNativeOxfmt();if(!r)throw n??Error(`@gjsify/oxfmt-native: prebuild not available`);let i=gi()?.GLib;if(!i)throw Error(`@gjsify/oxfmt-native: GLib not available (not running under GJS?)`);let a=new i.Bytes(new TextEncoder().encode(e)),o=new r.Formatter().format(t,a)?.get_data()??new Uint8Array;return new TextDecoder().decode(o)}function runOxfmt(e){let t=loadNativeOxfmt();if(!t)throw n??Error(`@gjsify/oxfmt-native: prebuild not available`);return new t.Formatter().run(e)}export{format,getOxfmtLoadError,hasNativeOxfmt,loadNativeOxfmt,runOxfmt};

package/lib/types/index.d.ts

@@ -0,0 +1,46 @@
+/** Minimal structural type of the `gi://GjsifyOxfmt` `Formatter` GObject. */
+interface FormatterInstance {
+    /** Format `code`, typed from `filename`'s extension. Throws on fatal error. */
+    format(filename: string | null, code: unknown): unknown;
+    /** Run the oxfmt CLI in-process (argv WITHOUT program name) → exit code. */
+    run(args: string[]): number;
+}
+interface FormatterCtor {
+    new (): FormatterInstance;
+}
+export interface NativeOxfmtModule {
+    Formatter: FormatterCtor;
+}
+export declare function loadNativeOxfmt(): NativeOxfmtModule | null;
+/** True when the native oxfmt prebuild is loadable under the current runtime. */
+export declare function hasNativeOxfmt(): boolean;
+/** The error from the last failed `loadNativeOxfmt()`, if any. */
+export declare function getOxfmtLoadError(): Error | null;
+/**
+ * Format JS/TS/JSX `code` via oxc's formatter, under GJS, without Node.
+ * `filename` selects the dialect by extension (default: TypeScript).
+ * Throws if the native prebuild is unavailable or formatting fails.
+ */
+export declare function format(code: string, filename?: string): string;
+/**
+ * Run the full oxfmt CLI in-process, under GJS, without Node.
+ *
+ * `args` are the CLI arguments WITHOUT the program name
+ * (`process.argv.slice(2)` shaped) — e.g.
+ * `['--check', '--config', '/abs/.oxfmtrc.json', 'src']`. This covers the
+ * complete pure-Rust oxfmt surface: `.oxfmtrc(.json)` + `.editorconfig`
+ * resolution, ignore handling, parallel file walking, `--write` /
+ * `--check` / `--list-different`. Reports to stdout/stderr exactly like
+ * the npm `oxfmt` binary. The working directory is the current process
+ * working directory.
+ *
+ * Not covered (requires oxfmt's Node-API host): embedded CSS/HTML/Vue/
+ * Markdown via the Prettier ExternalFormatter, JS/TS config files
+ * (`.oxfmtrc.ts`), `--init` / `--migrate`, LSP and stdin mode.
+ *
+ * Returns the process exit code (0 = success, 1 = config error or
+ * `--check` mismatch, 2 = no files found / format failed). Throws if the
+ * native prebuild is unavailable.
+ */
+export declare function runOxfmt(args: string[]): number;
+export {};

package/meson.build

@@ -0,0 +1,87 @@
+project('GjsifyOxfmt', ['c', 'vala'], version: '1.0')
+
+# Required system packages (Fedora 43+):
+#   dnf install vala meson ninja-build cargo
+# and the refs/oxc submodule:
+#   git submodule update --init refs/oxc
+#
+# Pipeline:
+#   src/rust/   → cargo builds libgjsify_oxfmt.so (cdylib, against refs/oxc)
+#   src/vala/   → vala compiles GjsifyOxfmt-1.0.so + GIR + typelib
+#   The Vala lib links against the Rust cdylib via -lgjsify_oxfmt.
+
+cc = meson.get_compiler('c')
+
+vala_deps = [
+    dependency('glib-2.0'),
+    dependency('gobject-2.0'),
+]
+
+# ----------------------------------------------------------------------------
+# Rust cdylib (cargo)
+#
+# Single custom_target combining `cargo build` and copying the resulting
+# cdylib into the meson build dir under the expected name, so meson tracks
+# it as a build artifact and serializes the Vala link step behind it.
+# ----------------------------------------------------------------------------
+cargo = find_program('cargo')
+
+rust_sources = files(
+    'src/rust/Cargo.toml',
+    'src/rust/src/lib.rs',
+)
+
+rust_target_dir = meson.current_build_dir() / 'cargo-target'
+
+rust_cdylib = custom_target('gjsify-oxfmt-rust',
+    input:  rust_sources,
+    output: 'libgjsify_oxfmt.so',
+    command: ['sh', '-c',
+              'cargo build --release --manifest-path "$1" --target-dir "$2" && cp "$2/release/libgjsify_oxfmt.so" "$3"',
+              'sh',
+              meson.current_source_dir() / 'src/rust/Cargo.toml',
+              rust_target_dir,
+              '@OUTPUT@',
+    ],
+    build_by_default: true,
+    install: false,
+)
+
+# ----------------------------------------------------------------------------
+# Vala library + GIR + typelib
+# ----------------------------------------------------------------------------
+sources = files(
+    'src/vala/gjsify-oxfmt-glue.c',
+    'src/vala/oxfmt.vala',
+)
+
+inc = include_directories('src/vala')
+
+# Tell ld where to find libgjsify_oxfmt.so (placed there by rust_cdylib)
+link_args = ['-L' + meson.current_build_dir(), '-lgjsify_oxfmt']
+
+libGjsifyOxfmt = library('gjsifyoxfmt', sources,
+    dependencies: vala_deps,
+    include_directories: inc,
+    vala_gir: meson.project_name() + '-1.0.gir',
+    link_args: link_args,
+    link_depends: rust_cdylib,
+    install: true,
+    install_dir: [true, true, true, true],
+    install_rpath: '$ORIGIN',
+)
+
+g_ir_compiler = find_program('g-ir-compiler')
+
+custom_target(meson.project_name() + '-1.0.typelib',
+    command: [
+        g_ir_compiler,
+        '--shared-library', 'libgjsifyoxfmt.so',
+        '--output', '@OUTPUT@',
+        meson.current_build_dir() / meson.project_name() + '-1.0.gir',
+    ],
+    output: meson.project_name() + '-1.0.typelib',
+    depends: libGjsifyOxfmt,
+    install: true,
+    install_dir: get_option('libdir') / 'girepository-1.0',
+)

package/package.json

@@ -0,0 +1,74 @@
+{
+    "name": "@gjsify/oxfmt-native",
+    "version": "0.4.44",
+    "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",
+    "module": "lib/esm/index.js",
+    "types": "lib/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./lib/types/index.d.ts",
+            "default": "./lib/esm/index.js"
+        }
+    },
+    "files": [
+        "lib",
+        "prebuilds",
+        "meson.build",
+        "src/rust",
+        "src/vala"
+    ],
+    "gjsify": {
+        "prebuilds": "prebuilds",
+        "runtimes": {
+            "gjs": "polyfill",
+            "node": "none",
+            "browser": "none",
+            "nativescript": "none"
+        }
+    },
+    "scripts": {
+        "clear": "rm -rf lib build tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo || exit 0",
+        "check": "gjsify tsc --noEmit",
+        "init:meson": "meson setup build .",
+        "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: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/"
+    },
+    "keywords": [
+        "gjs",
+        "oxc",
+        "oxfmt",
+        "formatter",
+        "prettier",
+        "typescript",
+        "vala",
+        "rust",
+        "native"
+    ],
+    "dependencies": {
+        "@girs/gjs": "4.0.4",
+        "@girs/glib-2.0": "2.88.0-4.0.4",
+        "@girs/gobject-2.0": "2.88.0-4.0.4"
+    },
+    "devDependencies": {
+        "@gjsify/cli": "workspace:^",
+        "@types/node": "^25.9.2",
+        "typescript": "^6.0.3"
+    },
+    "author": "Pascal Garber <pascal@artandcode.studio>",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/gjsify/gjsify.git",
+        "directory": "packages/infra/oxfmt-native"
+    },
+    "bugs": {
+        "url": "https://github.com/gjsify/gjsify/issues"
+    },
+    "homepage": "https://github.com/gjsify/gjsify/tree/main/packages/infra/oxfmt-native#readme"
+}

package/prebuilds/linux-x86_64/GjsifyOxfmt-1.0.gir

@@ -0,0 +1,65 @@
+<?xml version="1.0"?>
+<!-- GjsifyOxfmt-1.0.gir generated by valac 0.56.19, do not modify. -->
+<repository version="1.2" xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:doc="http://www.gtk.org/introspection/doc/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
+<include name="GObject" version="2.0"/>
+<include name="GLib" version="2.0"/>
+<package name="gjsifyoxfmt"/>
+<c:include name="gjsify-oxfmt-glue.h"/>
+<c:include name="gjsifyoxfmt.h"/>
+<doc:format name="unknown"/>
+<namespace name="GjsifyOxfmt" version="1.0" shared-library="libgjsifyoxfmt.so" c:prefix="GjsifyOxfmt" c:identifier-prefixes="GjsifyOxfmt" c:symbol-prefixes="gjsify_oxfmt">
+	<class name="Formatter" c:type="GjsifyOxfmtFormatter" c:symbol-prefix="formatter" glib:type-name="GjsifyOxfmtFormatter" glib:get-type="gjsify_oxfmt_formatter_get_type" glib:type-struct="FormatterClass" parent="GObject.Object">
+		<field name="parent_instance" readable="0" private="1">
+			<type name="GObject.Object" c:type="GObject"/>
+		</field>
+		<field name="priv" readable="0" private="1">
+			<type name="FormatterPrivate" c:type="GjsifyOxfmtFormatterPrivate*"/>
+		</field>
+		<method name="format" c:identifier="gjsify_oxfmt_formatter_format" throws="1">
+			<return-value transfer-ownership="full">
+				<type name="GLib.Bytes" c:type="GBytes*"/>
+			</return-value>
+			<parameters>
+				<instance-parameter name="self" transfer-ownership="none">
+					<type name="GjsifyOxfmt.Formatter" c:type="GjsifyOxfmtFormatter*"/>
+				</instance-parameter>
+				<parameter name="filename" transfer-ownership="none" nullable="1">
+					<type name="utf8" c:type="const gchar*"/>
+				</parameter>
+				<parameter name="code" transfer-ownership="none">
+					<type name="GLib.Bytes" c:type="GBytes*"/>
+				</parameter>
+			</parameters>
+		</method>
+		<method name="run" c:identifier="gjsify_oxfmt_formatter_run">
+			<return-value transfer-ownership="full">
+				<type name="gint" c:type="gint"/>
+			</return-value>
+			<parameters>
+				<instance-parameter name="self" transfer-ownership="none">
+					<type name="GjsifyOxfmt.Formatter" c:type="GjsifyOxfmtFormatter*"/>
+				</instance-parameter>
+				<parameter name="args" transfer-ownership="none">
+					<array length="1" c:type="gchar**">
+						<type name="utf8" c:type="gchar*"/>
+					</array>
+				</parameter>
+				<parameter name="args_length1" transfer-ownership="none">
+					<type name="gint" c:type="gint"/>
+				</parameter>
+			</parameters>
+		</method>
+		<constructor name="new" c:identifier="gjsify_oxfmt_formatter_new">
+			<return-value transfer-ownership="full">
+				<type name="GjsifyOxfmt.Formatter" c:type="GjsifyOxfmtFormatter*"/>
+			</return-value>
+		</constructor>
+	</class>
+	<record name="FormatterClass" c:type="GjsifyOxfmtFormatterClass" glib:is-gtype-struct-for="Formatter">
+		<field name="parent_class" readable="0" private="1">
+			<type name="GObject.ObjectClass" c:type="GObjectClass"/>
+		</field>
+	</record>
+	<record name="FormatterPrivate" c:type="GjsifyOxfmtFormatterPrivate" disguised="1"/>
+</namespace>
+</repository>