@flowscripter/template-bun-rust-library 1.0.1

package/.github/workflows/check-bun-dependencies.yml

@@ -0,0 +1,9 @@
+name: check-bun-dependencies
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+jobs:
+  call-check-bun-dependencies:
+    uses: flowscripter/.github/.github/workflows/check-bun-dependencies.yml@v1
+    secrets: inherit

package/.github/workflows/check-rust-dependencies.yml

@@ -0,0 +1,9 @@
+name: check-rust-dependencies
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 1 * * *"
+jobs:
+  call-check-deno-dependencies:
+    uses: flowscripter/.github/.github/workflows/check-rust-dependencies.yml@v1
+    secrets: inherit

package/.github/workflows/lint-pr-message.yml

@@ -0,0 +1,11 @@
+name: lint-pr-message
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+jobs:
+  call-lint-pr-message:
+    uses: flowscripter/.github/.github/workflows/lint-pr-message.yml@v1
+    secrets: inherit

package/.github/workflows/release-bun-rust-library.yml

@@ -0,0 +1,8 @@
+name: release-bun-rust-library
+on:
+  push:
+    branches: [main]
+jobs:
+  call-release-bun-rust-library:
+    uses: flowscripter/.github/.github/workflows/release-bun-rust-library.yml@v1
+    secrets: inherit

package/.github/workflows/validiate-bun-rust-library-pr.yml

@@ -0,0 +1,8 @@
+name: validate-bun-rust-library-pr
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  call-validate-bun-rust-library-pr:
+    uses: flowscripter/.github/.github/workflows/validate-bun-rust-library-pr.yml@v1
+    secrets: inherit

package/Cargo.lock

@@ -0,0 +1,16 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "flowscripter_template_bun_rust_library"
+version = "1.0.1"
+dependencies = [
+ "flowscripter_template_rust_library",
+]
+
+[[package]]
+name = "flowscripter_template_rust_library"
+version = "1.1.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "976ac733ec768cafc5771dd98b6a08a0551dc0f7358ac0df2d40eb091f3ee977"

package/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "flowscripter_template_bun_rust_library"
+version ="1.0.1"
+edition = "2021"
+description = "Project template for a Rust library with Bun FFI bindings."
+homepage = "https://github.com/flowscripter"
+license = "MIT"
+repository = "https://github.com/flowscripter/template-bun-rust-library"
+exclude = [".github/"]
+
+[lib]
+crate-type = ["cdylib","lib"]
+
+[dependencies]
+flowscripter_template_rust_library = "1.1.10"

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Flowscripter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# template-bun-rust-library
+
+[![version](https://img.shields.io/github/v/release/flowscripter/template-bun-rust-library?sort=semver)](https://github.com/flowscripter/template-bun-rust-library/releases)
+[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/template-bun-rust-library/release-bun-rust-library.yml)](https://github.com/flowscripter/template-bun-rust-library/actions/workflows/release-bun-rust-library.yml)
+[![coverage](https://codecov.io/gh/flowscripter/template-bun-rust-library/branch/main/graph/badge.svg?token=EMFT2938ZF)](https://codecov.io/gh/flowscripter/template-bun-rust-library)
+[![license: MIT](https://img.shields.io/github/license/flowscripter/template-bun-rust-library)](https://github.com/flowscripter/template-bun-rust-library/blob/main/LICENSE)
+
+> Project template for a Rust library with Bun FFI bindings.
+
+## Template Usage
+
+Create a new Bun project using this as a template:
+
+`bun create @flowscripter/template-bun-rust-library`
+
+## Bun Module Usage
+
+Add the module:
+
+`bun add @flowscripter/template-bun-rust-library`
+
+Use the module:
+
+```typescript
+import { world } from "@flowscripter/template-bun-rust-library";
+
+world();
+```
+
+## Development
+
+Build:
+
+Test:
+
+`cargo test`
+
+`cargo build --release && bun test`
+
+**NOTE**: The following tasks use Deno as it excels at these and Bun does not
+currently provide such functionality:
+
+Format:
+
+`deno fmt`
+
+Lint:
+
+`cargo fmt && deno lint index.ts src/ tests/`
+
+Generate HTML API Documentation:
+
+`deno doc --html --name=template-bun-library index.ts`
+
+## Documentation
+
+### Overview
+
+Sample mermaid diagram to test rendering in markdown:
+
+```mermaid
+classDiagram
+    Foo <|-- Bar
+```
+
+### API
+
+Link to auto-generated API docs:
+
+[API Documentation](https://flowscripter.github.io/template-bun-library/index.html)
+
+## License
+
+MIT © Flowscripter

package/bun.lock

@@ -0,0 +1,27 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "@flowscripter/template-bun-rust-library",
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "^5.0.0",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.2.2", "", { "dependencies": { "bun-types": "1.2.2" } }, "sha512-tr74gdku+AEDN5ergNiBnplr7hpDp3V1h7fqI2GcR/rsUaM39jpSeKH0TFibRvU0KwniRx5POgaYnaXbk0hU+w=="],
+
+    "@types/node": ["@types/node@22.13.4", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-ywP2X0DYtX3y08eFVx5fNIw7/uIv8hYUKgXoK8oayJlLnKcRfEYCxWMVE1XagUdVtCJlZT1AU4LXEABW+L1Peg=="],
+
+    "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
+
+    "bun-types": ["bun-types@1.2.2", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-RCbMH5elr9gjgDGDhkTTugA21XtJAy/9jkKe/G3WR2q17VPGhcquf9Sir6uay9iW+7P/BV0CAHA1XlHXMAVKHg=="],
+
+    "typescript": ["typescript@5.7.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw=="],
+
+    "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
+  }
+}

package/index.ts

@@ -0,0 +1 @@
+export * from "./src/lib.ts";

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@flowscripter/template-bun-rust-library",
+  "module": "index.ts",
+  "type": "module",
+  "version": "1.0.1",
+  "ffiLibBaseUri": "https://github.com/flowscripter/template-bun-rust-library/releases/download/v1.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package/src/lib-path.ts

@@ -0,0 +1,61 @@
+import os from "node:os";
+import { suffix } from "bun:ffi";
+import path from "node:path";
+import { mkdir } from "node:fs/promises";
+import packageJson from "../package.json";
+
+export async function getLibPath(libName: string) {
+  let fullLibName = libName + "." + suffix;
+
+  if (suffix !== "dll") {
+    fullLibName = "lib" + fullLibName;
+  }
+
+  // look for release build location in preference
+  const builtLibPath = path.join("target", "release", fullLibName);
+
+  console.debug(`builtLibPath: ${builtLibPath}`);
+
+  const builtLibFile = Bun.file(builtLibPath);
+  let exists = await builtLibFile.exists();
+
+  console.debug(`${builtLibPath} exists: ${exists}`);
+
+  if (exists) {
+    return builtLibPath;
+  }
+
+  // look for release installed location
+  const installedLibFolder = path.join(os.homedir(), ".flowscripter", "lib");
+  const installedLibPath = path.join(installedLibFolder, fullLibName);
+  const installedLibFile = Bun.file(installedLibPath);
+
+  exists = await installedLibFile.exists();
+
+  console.debug(`${installedLibPath} exists: ${exists}`);
+
+  if (exists) {
+    return installedLibPath;
+  }
+
+  console.debug(`packageJson.ffiLibBaseUri: ${packageJson.ffiLibBaseUri}`);
+
+  // look for release download location
+  const remotePath = path.join(packageJson.ffiLibBaseUri, fullLibName);
+
+  console.debug(`remotePath: ${remotePath}`);
+
+  await mkdir(installedLibFolder, { recursive: true });
+
+  try {
+    const result = await fetch(remotePath);
+
+    await Bun.write(installedLibPath, result);
+  } catch (e) {
+    console.error(
+      `Failed to download ${remotePath} to ${installedLibPath}: ${e}`,
+    );
+  }
+
+  return installedLibPath;
+}

package/src/lib.rs

@@ -0,0 +1,30 @@
+//! # Template Bun Rust Library
+//!
+//! `flowscripter_template_bun_rust_library` provides a sample function to be called from Bun FFI.
+
+use flowscripter_template_rust_library::adder;
+
+/// Adds two numbers together.
+///
+/// # Examples
+/// ```
+/// let arg1 = 2;
+/// let arg2 = 2;
+/// let answer = flowscripter_template_bun_rust_library::add(arg1, arg2);
+///
+/// assert_eq!(4, answer);
+/// ```
+#[no_mangle]
+pub extern "C" fn add(a: i32, b: i32) -> i32 {
+    adder(a, b)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn adder_works() {
+        assert_eq!(4, add(2, 2));
+    }
+}

package/src/lib.ts

@@ -0,0 +1,26 @@
+import { dlopen, FFIType } from "bun:ffi";
+import { getLibPath } from "./lib-path.ts";
+
+const {
+  symbols: {
+    add,
+  },
+} = dlopen(
+  await getLibPath("flowscripter_template_bun_rust_library"),
+  {
+    add: {
+      args: [
+        FFIType.i32,
+        FFIType.i32,
+      ],
+      returns: FFIType.i32,
+    },
+  },
+);
+
+/**
+ * Adds 2 and 2 and logs the result as "World 4"
+ */
+export function world(): void {
+  console.info(`World ${add(2, 2)}`);
+}

package/tests/integration_test.rs

@@ -0,0 +1,6 @@
+use flowscripter_template_bun_rust_library;
+
+#[test]
+fn world_works() {
+    assert_eq!(4, flowscripter_template_bun_rust_library::add(2, 2));
+}

package/tests/world_test.ts

@@ -0,0 +1,9 @@
+import { describe, expect, test } from "bun:test";
+import { world } from "../src/lib.ts";
+
+describe("World Tests", () => {
+  test("Simple Test", () => {
+    world();
+    expect(true);
+  });
+});

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}