Merge pull request #53 from mjbvz/add-wasm-package

Add wasm package

Author: tclem

.github/workflows/ci.yaml

@@ -28,6 +28,9 @@ jobs:
       - name: Build
         run: make build
 
+      - name: Build JS
+        run: make build-js
+
   lint:
     name: Lint
     runs-on: ubuntu-latest

.gitignore

@@ -3,3 +3,4 @@ Cargo.lock
 /crates/*/target/
 /crates/*/Cargo.lock
 .vscode/
+.DS_Store

Makefile

@@ -1,5 +1,5 @@
 .PHONY: all
-all: build lint test
+all: build build-js lint test
 
 .PHONY: clean
 clean:
@@ -22,6 +22,11 @@ build:
 	# Use --all-targets to ensure that all of the benchmarks compile.
 	cargo build --all-targets --all-features
 
+.PHONY: build-js
+build-js:
+	npm --prefix crates/string-offsets/js install
+	npm --prefix crates/string-offsets/js run compile
+
 .PHONY: test
 test:
 	RUST_BACKTRACE=1 cargo test

crates/string-offsets/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+pkg
+.tgz

crates/string-offsets/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+## Building the WASM/JS package
+
+The code for the wasm + js wrapper package is stored in the `js` directory. To build it:
+
+```sh
+cd js
+npm i
+npm run compile
+```
+
+The js code will be output to `js/pkg`.
+
+To run a quick sanity check of the JS package:
+
+```sh
+npm test
+```
+
+To publish the package to npm, run:
+
+```sh
+cd js
+npm publish
+```

crates/string-offsets/Cargo.toml

@@ -8,6 +8,16 @@ repository = "https://github.com/github/rust-gems"
 license = "MIT"
 keywords = ["unicode", "positions", "utf16", "characters", "lines"]
 categories = ["algorithms", "data-structures", "text-processing", "development-tools::ffi"]
+exclude = ["/js"]
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[features]
+wasm = ["wasm-bindgen"]
+
+[dependencies]
+wasm-bindgen = { version = "0.2", optional = true }
 
 [dev-dependencies]
 rand = "0.9"

crates/string-offsets/js/.npmignore

@@ -0,0 +1,4 @@
+/*
+!/pkg
+pkg/*/package.json
+pkg/*/README.md