@flowscripter/template-bun-executable 1.0.0

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/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-executable.yml

@@ -0,0 +1,10 @@
+name: release-bun-executable
+on:
+  push:
+    branches: [main]
+jobs:
+  call-release-bun-executable:
+    uses: flowscripter/.github/.github/workflows/release-bun-executable.yml@v1
+    secrets: inherit
+    with:
+      executable-name: "template-bun-executable"

package/.github/workflows/validate-bun-executable-pr.yml

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

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,97 @@
+# template-bun-executable
+
+[![version](https://img.shields.io/github/v/release/flowscripter/template-bun-executable?sort=semver)](https://github.com/flowscripter/template-bun-executable/releases)
+[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/template-bun-executable/release-bun-executable.yml)](https://github.com/flowscripter/template-bun-executable/actions/workflows/release-bun-executable.yml)
+[![coverage](https://codecov.io/gh/flowscripter/template-bun-executable/graph/badge.svg?token=uWK0oWsBjr)](https://codecov.io/gh/flowscripter/template-bun-executable)
+[![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/template-bun-executable/index.html)
+[![license: MIT](https://img.shields.io/github/license/flowscripter/template-bun-executable)](https://github.com/flowscripter/template-bun-executable/blob/main/LICENSE)
+
+> Project template for a cross-platform Bun executable with ffi native library
+> and Bun library dependencies.
+
+## Template Usage
+
+Create a new Bun project using this as a template:
+
+`bun create @flowscripter/template-bun-executable`
+
+## Bun Module Usage
+
+Add the module:
+
+`bun add @flowscripter/template-bun-executable`
+
+Use the module:
+
+```typescript
+import { world } from "@flowscripter/template-deno-executable";
+
+world();
+```
+
+## Binary Executable Usage
+
+Download and extract zip from:
+https://github.com/flowscripter/template-bun-executable/releases
+
+Run the executable: `./template-bun-executable`
+
+**NOTE**: The executable is 10's of megabytes in size as the entire Bun runtime
+is included.
+
+**NOTE**: Due to this issue https://github.com/oven-sh/bun/issues/7208 the MacOS
+executable is neither signed nor notarised. This means a "Developer cannot be
+verified" error will be displayed when the CLI it is executed. This requires
+explicitly allowing the CLI to be executed via:
+
+_"System Settings" > "Privacy & Security" > "Security" > "Allow Anyway"_
+
+## Functional Tests
+
+Refer to [functional_tests/README.md](functional_tests/README.md)
+
+## Development
+
+Test:
+
+`bun test`
+
+Compile binary:
+
+`bun build index.ts --compile --outfile /tmp/template-bun-executable`
+
+**NOTE**: The following tasks use Deno as it excels at these and Bun does not
+currently provide such functionality:
+
+Format:
+
+`deno fmt`
+
+Lint:
+
+`deno lint index.ts src/ tests/`
+
+Generate HTML API Documentation:
+
+`deno doc --html --name=template-bun-executable 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-executable/index.html)
+
+## License
+
+MIT © Flowscripter

package/bun.lock

@@ -0,0 +1,35 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "@flowscripter/template-bun-executable",
+      "dependencies": {
+        "@flowscripter/template-bun-library": "1.0.3",
+        "@flowscripter/template-bun-rust-library": "1.0.6",
+      },
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "^5.0.0",
+      },
+    },
+  },
+  "packages": {
+    "@flowscripter/template-bun-library": ["@flowscripter/template-bun-library@1.0.3", "", { "peerDependencies": { "typescript": "^5.7.3" } }, "sha512-0AQLu8hGf+dzT+0m7EbUG8lJadzTcUROzp3Z8swlKcqhTBuIZrb+Vg9fyWw1M8YWsk9Jk/ZaXjb00teAI5D6Zg=="],
+
+    "@flowscripter/template-bun-rust-library": ["@flowscripter/template-bun-rust-library@1.0.6", "", { "peerDependencies": { "typescript": "^5.0.0" } }, "sha512-jFE005w91y1zen81KHU6wfuf2xrSFm5+zo75GCuI6GSolfnfGWLaDuLwQce/gvGegCz0dDvj4WxmQMMH9OrOzA=="],
+
+    "@types/bun": ["@types/bun@1.2.2", "", { "dependencies": { "bun-types": "1.2.2" } }, "sha512-tr74gdku+AEDN5ergNiBnplr7hpDp3V1h7fqI2GcR/rsUaM39jpSeKH0TFibRvU0KwniRx5POgaYnaXbk0hU+w=="],
+
+    "@types/node": ["@types/node@22.13.2", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-Z+r8y3XL9ZpI2EY52YYygAFmo2/oWfNSj4BCpAXE2McAexDk8VcnBMGC9Djn9gTKt4d2T/hhXqmPzo4hfIXtTg=="],
+
+    "@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/functional_tests/README.md

@@ -0,0 +1,23 @@
+## Executable Functional Tests
+
+#### Setup
+
+Ensure the executable is built:
+
+    bun build ../index.ts --compile --outfile /tmp/template-bun-executable
+
+Install requirements:
+
+    pip3 install -r pip-requirements.txt
+
+#### Testing
+
+Run the functional tests:
+
+    export EXECUTABLE=/tmp/template-bun-executable
+    behave
+
+To run with logging output from the test steps (this is the best set of
+arguments I can find):
+
+    behave --no-logcapture --no-color --logging-level=DEBUG

package/functional_tests/features/environment.py

@@ -0,0 +1,9 @@
+import os
+
+from support.pexpect_wrapper import PExpectWrapper
+
+
+def before_all(context):
+
+    context.config.setup_logging()
+    context.pexpect_wrapper = PExpectWrapper(os.environ.get('EXECUTABLE'))

package/functional_tests/features/executable.feature

@@ -0,0 +1,9 @@
+Feature: Executable
+
+  Scenario: Executable success
+    When the executable is launched
+    Then the executable should complete successfully
+    And the executable should have output "Hello"
+    And the executable should have output "World"
+    And the executable should have output "Hello"
+    And the executable should have output "World 4"

package/functional_tests/features/steps/executable.py

@@ -0,0 +1,18 @@
+from behave import when, then
+
+
+@when('the executable is launched')
+def step_impl(context):
+    context.pexpect_wrapper.start()
+
+
+@then('the executable should complete successfully')
+def step_impl(context):
+    context.pexpect_wrapper.expect_eof()
+    status = context.pexpect_wrapper.complete()
+    assert status == 0, 'unexpected exit status: {}'.format(status)
+
+
+@then('the executable should have output "{message}"')
+def step_impl(context, message):
+    context.pexpect_wrapper.expect(message)

package/functional_tests/features/support/pexpect_wrapper.py

@@ -0,0 +1,45 @@
+from pexpect.popen_spawn import PopenSpawn
+from pexpect import EOF
+import logging
+log = logging.getLogger("pexpect_wrapper")
+
+
+class PExpectWrapper:
+
+    def __init__(self, executable):
+        self.executable = executable
+        self.child = None
+        self.output = None
+
+    def start(self):
+        assert self.child is None
+
+        self.child = PopenSpawn(self.executable, encoding='utf-8')
+
+    def expect(self, message):
+        assert self.child is not None
+
+        found = ''
+        while len(self.output) > 0:
+            next_line = self.output.pop(0)
+            log.debug('looking for "{}" in "{}"'.format(message, next_line))
+            if message in next_line:
+                found = next_line
+                break
+
+        assert found != '', 'expected {} in output'.format(message)
+
+
+    def expect_eof(self):
+        assert self.child is not None
+
+        self.child.expect(EOF)
+
+    def complete(self):
+        assert self.child is not None
+
+        exit_status = self.child.wait()
+
+        self.output = self.child.before.split('\n')
+
+        return exit_status

package/functional_tests/pip-requirements.txt

@@ -0,0 +1,2 @@
+pexpect
+behave

package/index.ts

@@ -0,0 +1,4 @@
+import { hello } from "./src/hello.ts";
+export * from "./src/hello.ts";
+
+hello();

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@flowscripter/template-bun-executable",
+  "module": "index.ts",
+  "type": "module",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@flowscripter/template-bun-library": "1.0.3",
+    "@flowscripter/template-bun-rust-library": "1.0.6"
+  }
+}

package/src/hello.ts

@@ -0,0 +1,12 @@
+import * as bunLib from "@flowscripter/template-bun-library";
+import * as rustLib from "@flowscripter/template-bun-rust-library";
+
+/**
+ * Logs out some greetings.
+ */
+export function hello(): void {
+  console.info("Hello");
+  bunLib.world();
+  console.info("Hello");
+  rustLib.world();
+}

package/tests/hello_test.ts

@@ -0,0 +1,9 @@
+import { describe, expect, test } from "bun:test";
+import { hello } from "../src/hello.ts";
+
+describe("Hello Tests", () => {
+  test("Simple Test", () => {
+    hello();
+    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
+  }
+}