watr 2.1.0 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watr",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Ligth & fast WAT compiler",
   "main": "watr.js",
   "exports": {

package/readme.md

@@ -1,14 +1,13 @@
 # watr [![test](https://github.com/audio-lab/watr/actions/workflows/test.js.yml/badge.svg)](https://github.com/audio-lab/watr/actions/workflows/test.js.yml) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/watr/latest?color=brightgreen&label=gzip)](https://bundlephobia.com/package/watr)
 
-> Bare minimum wasm text compiler & formatter.
-
-Light & fast alternative for [wat2wasm](https://github.com/AssemblyScript/wabt.js), useful for hi-level languages or dynamic (in-browser) compilation.<br>
+Bare minimum wasm text compiler & formatter, light & fast alternative for [wat2wasm](https://github.com/AssemblyScript/wabt.js).<br/>
+Useful for hi-level languages or dynamic (in-browser) compilation.<br>
 
 <!-- See [REPL](https://audio-lab.github.io/watr/repl.html).-->
 
 &nbsp; | Size (gzipped) | Performance (op/s)
 ---|---|---
-watr | 3.8 kb | 5950
+watr | 3.8 kb | 6250
 [wat-compiler](https://github.com/stagas/wat-compiler) | 6 kb | 348
 [wabt](https://github.com/AssemblyScript/wabt.js) | 300 kb | 574
 
@@ -101,12 +100,15 @@ parse(`(func (export "double") (param f64) (result f64) (f64.mul (local.get 0) (
 
 No floating HEX support, eg. `(f32.const 0x1.fffffep+127)`.
 
+<!--
 ## Projects using watr
 
 * [auro](https://github.com/audio-lab/auro) – audio processing language
+-->
 
 ## Useful links
 
+* [watlings](https://github.com/EmNudge/watlings) – learn Wasm text by examples.
 * [MDN: control flow](https://developer.mozilla.org/en-US/docs/WebAssembly/Reference/Control_flow)
 * [WASM reference manual](https://github.com/sunfishcode/wasm-reference-manual/blob/master/WebAssembly.md#loop)
 * [WASM binary encoding](https://github.com/WebAssembly/design/blob/main/BinaryEncoding.md)

package/src/compile.js

@@ -4,7 +4,12 @@ import parse from './parse.js'
 
 const OP_END = 0xb, OP_I32_CONST = 0x41, OP_I64_CONST = 0x42, OP_F32_CONST = 0x43, OP_F64_CONST = 0x44
 
-// convert wat tree to wasm binary
+/**
+ * Converts a WebAssembly Text Format (WAT) tree to a WebAssembly binary format (Wasm).
+ *
+ * @param {string|Array} nodes - The WAT tree or string to be compiled to Wasm binary.
+ * @returns {Uint8Array} The compiled Wasm binary data.
+ */
 export default (nodes) => {
   if (typeof nodes === 'string') nodes = parse(nodes);
 
@@ -161,32 +166,32 @@ const build = {
         immed = [0]
       }
 
-      // (if ...), (block ...), (loop ...)
-      else if (opCode > 1 && opCode < 5) {
+      // (block ...), (loop ...), (if ...)
+      else if (opCode === 2 || opCode === 3 || opCode === 4) {
         blocks.push(opCode)
 
         // (block $x) (loop $y)
         if (opCode < 4 && args[0]?.[0] === '$') (blocks[args.shift()] = blocks.length)
 
         // get type
-        // (result i32)
-        if (args[0]?.[0] === 'result') {
-          if (args[0].length < 3) {
-            let [, type] = args.shift()
-            immed = [TYPE[type]]
-          }
-          // (result i32 i32)
-          else {
-            let [typeId] = consumeType(args, ctx)
-            immed = [typeId]
-          }
+        // (result i32) - doesn't require registering type
+        if (args[0]?.[0] === 'result' && args[0].length < 3) {
+          let [, type] = args.shift()
+          immed = [TYPE[type]]
+        }
+        // (result i32 i32)
+        else if (args[0]?.[0] === 'result' || args[0]?.[0] === 'param') {
+          let [typeId] = consumeType(args, ctx)
+          immed = [typeId]
+        }
+        else {
+          immed = [TYPE.void]
         }
-        else immed = [TYPE.void]
 
         if (group) {
+          // (block xxx) -> block xxx end
           nodes.unshift('end')
 
-          // (block xxx) -> block xxx end
           if (opCode < 4) while (args.length) nodes.unshift(args.pop())
 
           // (if cond a) -> cond if a end

package/src/parse.js

@@ -1,6 +1,12 @@
 const OPAREN = 40, CPAREN = 41, OBRACK = 91, CBRACK = 93, SPACE = 32, DQUOTE = 34, PERIOD = 46,
   _0 = 48, _9 = 57, SEMIC = 59, NEWLINE = 32, PLUS = 43, MINUS = 45, COLON = 58
 
+/**
+ * Parses a wasm text string and constructs a nested array structure (AST).
+ *
+ * @param {string} str - The input string with WAT code to parse.
+ * @returns {Array} An array representing the nested syntax tree (AST).
+ */
 export default (str) => {
   let i = 0, level = [], buf = ''
 

package/src/print.js

@@ -2,6 +2,15 @@ import parse from './parse.js';
 
 let indent = '', newline = '\n'
 
+/**
+ * Formats a tree or a WAT string.
+ *
+ * @param {string | Array} tree - The code to print. If a string is provided, it will be parsed first.
+ * @param {Object} [options] - Printing options.
+ * @param {string} [options.indent='  '] - The string used for one level of indentation.
+ * @param {string} [options.newline='\n'] - The string used for line breaks.
+ * @returns {string} The formatted WAT string.
+ */
 export default function print(tree, options = {}) {
   if (typeof tree === 'string') tree = parse(tree);
 

package/watr.js

@@ -1,3 +1,9 @@
+/**
+ * WebAssembly Text Format (WAT) compiler, parser, printer.
+ *
+ * @module watr
+ */
+
 import compile from './src/compile.js'
 import parse from './src/parse.js'
 import print from './src/print.js'