watr 2.4.1 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "watr",
-  "version": "2.4.1",
+  "version": "3.1.0",
   "description": "Ligth & fast WAT compiler",
   "main": "watr.js",
   "exports": {
@@ -11,7 +11,8 @@
   },
   "type": "module",
   "scripts": {
-    "test": "node test"
+    "test": "node test",
+    "postinstall": "git submodule update --init --recursive"
   },
   "repository": {
     "type": "git",
@@ -30,7 +31,9 @@
     "wabt",
     "pretty-print",
     "webassembly",
-    "wasm-text"
+    "wasm-text",
+    "wast",
+    "wat-compiler"
   ],
   "author": "Dmitry Iv",
   "license": "MIT",

package/readme.md

@@ -1,7 +1,8 @@
 # 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) [![npm](https://img.shields.io/npm/v/watr?color=red)](https://npmjs.org/watr)
 
-Bare minimum wasm text compiler/formatter. A light & fast alternative to [wat2wasm](https://github.com/AssemblyScript/wabt.js).<br/>
-Useful for hi-level languages or dynamic (in-browser) compilation.<br>
+Light & fast WASM compiler. An alternative to [wabt/wat2wasm](https://github.com/AssemblyScript/wabt.js) or [spec/wast]().<br/>
+Useful for high-level languages or dynamic (in-browser) compilation.<br>
+Supports full [spec text syntax](https://webassembly.github.io/spec/core/text/index.html) and [official testsuite](https://github.com/WebAssembly/testsuite).
 
 ## Usage
 
@@ -10,7 +11,7 @@ Useful for hi-level languages or dynamic (in-browser) compilation.<br>
 Compile wasm text or syntax tree into wasm binary.
 
 ```js
-import compile from 'watr' // or `import { compile } from 'watr'`
+import { compile } from 'watr'
 
 const buffer = compile(`(func (export "double")
   (param f64) (result f64)
@@ -23,6 +24,20 @@ const {double} = instance.exports
 double(108) // 216
 ```
 
+### Parse
+
+Parse input wasm text into syntax tree.
+
+```js
+import { parse } from 'watr'
+
+parse(`(func (export "double") (param f64) (result f64) (f64.mul (local.get 0) (f64.const 2)))`)
+// [
+//   'func', ['export', '"double"'], ['param', 'f64'], ['result', 'f64'],
+//   ['f64.mul', ['local.get', 0], ['f64.const', 2]]
+// ]
+```
+
 ### Print
 
 Format input wasm text or syntax tree into minified or pretty form.
@@ -54,69 +69,53 @@ print(src, {
 // (func (export "double")(param f64)(result f64)(f64.mul (local.get 0)(f64.const 2)))
 ```
 
-### Parse
-
-Parse input wasm text into syntax tree.
-
-```js
-import { parse } from 'watr'
-
-parse(`(func (export "double") (param f64) (result f64) (f64.mul (local.get 0) (f64.const 2)))`)
-// [
-//   'func', ['export', '"double"'], ['param', 'f64'], ['result', 'f64'],
-//   ['f64.mul', ['local.get', 0], ['f64.const', 2]]
-// ]
-```
-
 <!-- See [REPL](https://audio-lab.github.io/watr/repl.html).-->
 
 ## Status
 
 * [x] core
+* [x] [mutable globals](https://github.com/WebAssembly/mutable-global)
+* [x] [extended const](https://github.com/WebAssembly/extended-const/blob/main/proposals/extended-const/Overview.md)
+* [x] [nontrapping float to int](https://github.com/WebAssembly/nontrapping-float-to-int-conversions)
+* [x] [sign extension](https://github.com/WebAssembly/sign-extension-ops)
 * [x] [multi-value](https://github.com/WebAssembly/spec/blob/master/proposals/multi-value/Overview.md)
 * [x] [bulk memory ops](https://github.com/WebAssembly/bulk-memory-operations/blob/master/proposals/bulk-memory-operations/Overview.md)
+* [x] [multiple memories](https://github.com/WebAssembly/multi-memory/blob/master/proposals/multi-memory/Overview.md)
 * [x] [simd](https://github.com/WebAssembly/simd/blob/master/proposals/simd/SIMD.md)
-* [x] [extended const](https://github.com/WebAssembly/extended-const/blob/main/proposals/extended-const/Overview.md)
-* [ ] [multiple memories](https://github.com/WebAssembly/multi-memory/blob/master/proposals/multi-memory/Overview.md)
-* [ ] [func refs](https://github.com/WebAssembly/function-references/blob/main/proposals/function-references/Overview.md)
+* [x] [relaxed simd](https://github.com/WebAssembly/relaxed-simd)
+* [x] [fixed-width simd](https://github.com/WebAssembly/simd/blob/master/proposals/simd/SIMD.md)
+* [x] [tail_call](https://github.com/WebAssembly/tail-call)
+* [x] [ref types](https://github.com/WebAssembly/reference-types/blob/master/proposals/reference-types/Overview.md)
+* [x] [func refs](https://github.com/WebAssembly/function-references/blob/main/proposals/function-references/Overview.md)
 * [ ] [gc](https://github.com/WebAssembly/gc)
+* [ ] [exceptions](https://github.com/WebAssembly/exception-handling)
+* [ ] [memory64](https://github.com/WebAssembly/memory64)
+* [ ] [annotations](https://github.com/WebAssembly/annotations)
+* [ ] [code_metadata](https://github.com/WebAssembly/tool-conventions/blob/main/CodeMetadata.md)
+* [ ] [js strings](https://github.com/WebAssembly/js-string-builtins/blob/main/proposals/js-string-builtins/Overview.md)
 
 ## Alternatives
 
-&nbsp; | Size (gzipped) | Performance (op/s)
+&nbsp; | Size (gzipped) | Performance
 ---|---|---
-watr | 5 kb | 6000
-[wat-compiler](https://github.com/stagas/wat-compiler) | 6 kb | 348
-[wabt](https://github.com/AssemblyScript/wabt.js) | 300 kb | 574
-<!-- [wassemble](https://github.com/wingo/wassemble) | ? kb | ? -->
+watr | 6.2 kb | 11.6 op/s
+[spec/wast.js](https://github.com/WebAssembly/spec/tree/main/interpreter#javascript-library) | 216 kb | 7.1 op/s
+[wabt](https://github.com/WebAssembly/wabt) | 282 kb | 2.3 op/s
+[wat-compiler](https://github.com/stagas/wat-compiler) | 7.7 kb | 1.34 op/s
 
 <!--
 ## Projects using watr
 
-* [auro](https://github.com/audio-lab/auro) – audio processing language
+* [piezo](https://github.com/audio-lab/piezo) – 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)
-
-<!--
-## Refs
-
-* [mdn wasm text format](https://developer.mozilla.org/en-US/docs/WebAssembly/Understanding_the_text_format)
-* [wasm reference manual](https://github.com/sunfishcode/wasm-reference-manual/blob/master/WebAssembly.md)
-* [wabt source search](https://github.com/WebAssembly/wabt/search?p=5&q=then)
-* [wat control flow](https://developer.mozilla.org/en-US/docs/WebAssembly/Reference/Control_flow)
-* [ontouchstart wasm book](https://ontouchstart.pages.dev/chapter_wasm_binary)
-* [hackernoon](https://web.archive.org/web/20210215171830/https://hackernoon.com/webassembly-binary-format-explained-part-2-hj1t33yp?source=rss)
-* [webassemblyjs](https://github.com/xtuc/webassemblyjs)
-* [chasm](https://github.com/ColinEberhardt/chasm/blob/master/src/encoding.ts)
-* [WebBS](https://github.com/j-s-n/WebBS)
-* [leb128a](https://github.com/minhducsun2002/leb128/blob/master/src/index.ts)
-* [leb128b](https://github.com/shmishtopher/wasm-LEB128/tree/master/esm)
 -->
 
 <p align=center><a href="https://github.com/krsnzd/license/">🕉</a></p>