wasmoon 2.0

.github/workflows/publish.yml

@@ -5,24 +5,101 @@ on:
         branches: [main]
 
 jobs:
-    publish:
+    build:
         runs-on: ubuntu-latest
-
         steps:
-            - uses: actions/checkout@v4
+            - name: Checkout repository
+              uses: actions/checkout@v6
               with:
                   submodules: recursive
-            - uses: mymindstorm/setup-emsdk@v14
-            - name: Use Node.js 22.x
-              uses: actions/setup-node@v4
+
+            - name: Setup EMSDK
+              uses: mymindstorm/setup-emsdk@v14
+              with:
+                  version: 5.0.2
+
+            - name: Use Node.js 24.x
+              uses: actions/setup-node@v6
               with:
-                  node-version: 22.x
-            - run: npm ci
-            - run: npm run lint:nofix
-            - run: npm run build:wasm
-            - run: npm run build
-            - run: npm test
-            - run: npm run luatests
-            - uses: JS-DevTools/npm-publish@v3
+                  node-version: 24.x
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Run lint (no fix)
+              run: npm run lint:nofix
+
+            - name: Build WASM
+              run: npm run build:wasm
+
+            - name: Build project
+              run: npm run build
+
+            - name: Run tests
+              run: npm test
+
+            - name: Run Lua tests
+              run: npm run luatests
+
+            - name: Upload build artifact
+              uses: actions/upload-artifact@v7
+              with:
+                  name: build-artifact
+                  path: |
+                      package.json
+                      package-lock.json
+                      dist/
+                      bin/
+                      LICENSE
+
+    publish_npm:
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v6
+
+            - name: Download build artifact
+              uses: actions/download-artifact@v8
+              with:
+                  name: build-artifact
+                  path: build-artifact
+
+            - name: Restore build artifact
+              run: cp -r build-artifact/* .
+
+            - name: Publish to npm
+              uses: JS-DevTools/npm-publish@v3
               with:
                   token: ${{ secrets.NPM_TOKEN }}
+
+    # Emscripten still doesn't support deno
+    # publish_jsr:
+    #     runs-on: ubuntu-latest
+    #     needs: build
+    #     permissions:
+    #         contents: read
+    #         id-token: write
+    #     steps:
+    #         - name: Download build artifact
+    #           uses: actions/download-artifact@v4
+    #           with:
+    #               name: build-artifact
+    #               path: build-artifact
+
+    #         - name: Restore build artifact
+    #           run: cp -r build-artifact/* .
+
+    #         - name: Generate jsr.json from package.json
+    #           run: |
+    #               node -e "const pkg = require('./package.json'); \
+    #               const jsr = { \
+    #                 name: '@ceifa/' + pkg.name, \
+    #                 version: pkg.version, \
+    #                 exports: pkg.main, \
+    #                 include: ['dist/**/*', 'bin/**/*']
+    #               }; \
+    #               require('fs').writeFileSync('jsr.json', JSON.stringify(jsr, null, 2));"
+
+    #         - name: Publish to JSR
+    #           run: npx jsr publish

.github/workflows/test.yml

@@ -10,15 +10,15 @@ jobs:
 
         strategy:
             matrix:
-                node-version: [18, 20, 22]
+                node-version: [22, 24]
 
         steps:
-            - uses: actions/checkout@v4
+            - uses: actions/checkout@v6
               with:
                   submodules: recursive
-            - uses: mymindstorm/setup-emsdk@v12
+            - uses: mymindstorm/setup-emsdk@v14
             - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v4
+              uses: actions/setup-node@v6
               with:
                   node-version: ${{ matrix.node-version }}
             - run: npm ci

.prettierrc → .oxfmtrc.json

@@ -5,5 +5,7 @@
     "quoteProps": "consistent",
     "semi": false,
     "printWidth": 140,
-    "tabWidth": 4
+    "tabWidth": 4,
+    "sortPackageJson": false,
+    "ignorePatterns": ["rolldown.config.*.js"]
 }

.oxlintrc.json

@@ -0,0 +1,13 @@
+{
+    "plugins": ["import", "promise", "node"],
+    "rules": {
+        "no-shadow": "off",
+        "no-extend-native": "off",
+        "consistent-function-scoping": "off",
+        "promise/always-return": "off"
+    },
+    "ignorePatterns": ["dist/**", "build/**", "rolldown.config.ts", "rolldown.config.*.js", "utils/**"],
+    "env": {
+        "builtin": true
+    }
+}

README.md

@@ -74,26 +74,27 @@ $: ./sum.lua 10 30
 
 ## When to use wasmoon and fengari
 
-Wasmoon compiles the [official Lua code](https://github.com/lua/lua) to webassembly and creates an abstraction layer to interop between Lua and JS, instead of [fengari](https://github.com/fengari-lua/fengari), that is an entire Lua VM rewritten in JS.
+Wasmoon compiles the [official Lua code](https://github.com/lua/lua) to WebAssembly and creates an abstraction layer to interop between Lua and JS, instead of [fengari](https://github.com/fengari-lua/fengari), which is an entire Lua VM rewritten in JS.
 
 ### Performance
 
-Because of wasm, wasmoon will run Lua code much faster than fengari, but if you are going to interop a lot between JS and Lua, this may be not be true anymore, you probably should test on you specific use case to take the prove.
+Because of WebAssembly, wasmoon runs Lua code significantly faster than fengari. The table below shows results from a [heap sort benchmark](https://github.com/ceifa/wasmoon/blob/main/bench/heapsort.lua) sorting a list of 2,000 numbers (100 iterations, 5 warmup):
 
-This is the results running a [heap sort code](https://github.com/ceifa/wasmoon/blob/main/bench/heapsort.lua) in a list of 2k numbers 10x(less is better):
+|                  | avg        | median     | min        | max        | stddev    | relative |
+| ---------------- | ---------- | ---------- | ---------- | ---------- | --------- | -------- |
+| **Wasmoon**      | 13.41 ms   | 13.07 ms   | 12.20 ms   | 16.23 ms   | 1.12 ms   | 1.00x    |
+| **Fengari**      | 137.36 ms  | 138.51 ms  | 119.70 ms  | 165.54 ms  | 11.16 ms  | 10.24x   |
 
-| wasmoon  | fengari   |
-| -------- | --------- |
-| 15.267ms | 389.923ms |
+Wasmoon is **~10x faster** than fengari for pure Lua execution. If your use case involves heavy interop between JS and Lua, the difference may be smaller, benchmark your specific scenario.
 
 ### Size
 
 Fengari is smaller than wasmoon, which can improve the user experience if in web environments:
 
 |             | wasmoon | fengari |
 | ----------- | ------- | ------- |
-| **plain**   | 393kB   | 214kB   |
-| **gzipped** | 130kB   | 69kB    |
+| **plain**   | 357kB   | 211kB   |
+| **gzipped** | 123kB   | 69kB    |
 
 ## Fixing common errors on web environment
 

bench/comparisons.js

@@ -1,30 +1,52 @@
-const { readFileSync } = require('fs')
-const path = require('path')
+import { Lua } from '../dist/index.js'
+import fengari from 'fengari'
+import { isMainModule, parseBenchOptions, readBenchAsset, runBenchmarks } from './utils.js'
 
-const fengari = require('fengari')
-const wasmoon = require('../dist/index')
+const heapsort = readBenchAsset('heapsort.lua')
 
-const heapsort = readFileSync(path.resolve(__dirname, 'heapsort.lua'), 'utf-8')
-
-const startFengari = () => {
+function runFengariIteration() {
     const state = fengari.lauxlib.luaL_newstate()
-    fengari.lualib.luaL_openlibs(state)
+    try {
+        fengari.lualib.luaL_openlibs(state)
+        assertStatus(fengari.lauxlib.luaL_loadstring(state, fengari.to_luastring(heapsort)), 'Fengari load')
+        assertStatus(fengari.lua.lua_pcallk(state, 0, 1, 0, 0, null), 'Fengari compile')
+        assertStatus(fengari.lua.lua_pcallk(state, 0, 1, 0, 0, null), 'Fengari execute')
+    } finally {
+        fengari.lua.lua_close(state)
+    }
+}
 
-    console.time('Fengari')
-    fengari.lauxlib.luaL_loadstring(state, fengari.to_luastring(heapsort))
-    fengari.lua.lua_callk(state, 0, 1, 0, null)
-    fengari.lua.lua_callk(state, 0, 0, 0, null)
-    console.timeEnd('Fengari')
+function createWasmoonIteration(lua) {
+    return function runWasmoonIteration() {
+        const state = lua.createState()
+        try {
+            assertStatus(state.global.lua.luaL_loadstring(state.global.address, heapsort), 'Wasmoon load')
+            assertStatus(state.global.lua.lua_pcallk(state.global.address, 0, 1, 0, 0, null), 'Wasmoon compile')
+            assertStatus(state.global.lua.lua_pcallk(state.global.address, 0, 1, 0, 0, null), 'Wasmoon execute')
+        } finally {
+            state.global.close()
+        }
+    }
 }
 
-const startWasmoon = async () => {
-    const state = await new wasmoon.LuaFactory().createEngine()
+function assertStatus(status, label) {
+    if (status !== 0) {
+        throw new Error(`${label} failed with status ${status}`)
+    }
+}
 
-    console.time('Wasmoon')
-    state.global.lua.luaL_loadstring(state.global.address, heapsort)
-    state.global.lua.lua_callk(state.global.address, 0, 1, 0, null)
-    state.global.lua.lua_callk(state.global.address, 0, 0, 0, null)
-    console.timeEnd('Wasmoon')
+export async function runComparisonBench(options = {}) {
+    const lua = await Lua.load()
+    return runBenchmarks({
+        title: 'Comparison benchmarks',
+        benches: [
+            { name: 'Fengari heapsort', run: runFengariIteration },
+            { name: 'Wasmoon heapsort', run: createWasmoonIteration(lua) },
+        ],
+        options,
+    })
 }
 
-Promise.resolve().then(startFengari).then(startWasmoon).catch(console.error)
+if (isMainModule(import.meta.url)) {
+    await runComparisonBench(parseBenchOptions())
+}

bench/heapsort.lua

@@ -57,4 +57,6 @@ return function()
             assert(a[i] <= a[i + 1])
         end
     end
+
+    return Num
 end

bench/index.js

@@ -0,0 +1,20 @@
+import { runComparisonBench } from './comparisons.js'
+import { runStepBench } from './steps.js'
+import { parseBenchOptions, printArtifactSizes, printBenchUsage } from './utils.js'
+
+const options = parseBenchOptions()
+
+if (options.help) {
+    printBenchUsage()
+    process.exit(0)
+}
+
+printArtifactSizes()
+
+if (options.suite === 'all' || options.suite === 'steps') {
+    await runStepBench(options)
+}
+
+if (options.suite === 'all' || options.suite === 'comparisons') {
+    await runComparisonBench(options)
+}