Merge pull request #11 from torch2424/last-launch-fixes

Last Before Launch Fixes

Author: torch2424

README.md

@@ -47,18 +47,13 @@ You can install as-bind in your project by running the following:
 
 ## Quick Start
 
-**1. In your Assemblyscript**
+**1. Compiling your Assemblyscript**
 
-Export everything from the asbind assemblyscript library:
+To enable as-bind for your AssemblyScript Wasm modules, add the as-bind entrypoint when compiling your module:
 
-```typescript
-// This should be in your entry point file for your Assemblyscript project
-
-// '../node_modules/as-bind/*' should be the relative path to this directory in your project
-export * from "../node_modules/as-bind/lib/assembly/asbind.ts";
-```
+`asc ./node_modules/as-bind/lib/assembly/as-bind.ts your-entryfile.ts [...other cli options...]`
 
-After this, let's export an example function we can try:
+For **optional testing purposes** , let's export an example function we can try in `your-entryfile.ts`:
 
 ```typescript
 export function myExportedFunctionThatTakesAString(value: string): string {
@@ -78,7 +73,7 @@ const wasm = fetch("./path-to-my-wasm.wasm");
 const asyncTask = async () => {
   const asBindInstance = await AsBind.instantiate(wasm);
 
-  // You can now use your wasm / asbind instance!
+  // You can now use your wasm / as-bind instance!
   const response = asBindInstance.exports.myExportedFunctionThatTakesAString(
     "Hello World!"
   );
@@ -98,7 +93,7 @@ const wasm = fs.readFileSync("./path-to-my-wasm.wasm");
 const asyncTask = async () => {
   const asBindInstance = await AsBind.instantiate(wasm);
 
-  // You can now use your wasm / asbind instance!
+  // You can now use your wasm / as-bind instance!
   const response = asBindInstance.exports.myExportedFunctionThatTakesAString(
     "Hello World!"
   );

examples/markdown-parser/assembly/index.ts

@@ -1,8 +1,5 @@
 // Wasm module to do a basic markdown to HTML
 
-// Export asbind
-export * from "../../../dist/asbind";
-
 import { log } from "./util";
 
 import { Token } from "./tokenizer/token";

examples/markdown-parser/index.js

@@ -1,11 +1,11 @@
 import { h, render, Component } from "preact";
-import asbind from "../../dist/asbind.esm";
+import asbind from "../../dist/as-bind.esm";
 
 // Import our TypeScript equivalent
-import { convertMarkdownToHTML } from "../../dist/examples/markdown-parser/assembly/index";
+import { convertMarkdownToHTML } from "../../dist/ts/index";
 import "./index.css";
 
-let testMarkdown = `# __asbind__ ~~convert~~ **markdown** to     html
+let testMarkdown = `# __as-bind__ ~~convert~~ **markdown** to     html
 
       * Item 1
       * Item 2
@@ -15,7 +15,7 @@ let testMarkdown = `# __asbind__ ~~convert~~ **markdown** to     html
 
       ## And now we are back!
 
-      Here is a [link to the source code](https://github.com/torch2424/asbind)
+      Here is a [link to the source code](https://github.com/torch2424/as-bind)
 
       And an image of the author!
 
@@ -35,7 +35,7 @@ let testMarkdown = `# __asbind__ ~~convert~~ **markdown** to     html
 
       > WebAssembly is cool - Torch2424, 2019
 
-      \`npm install asbind\`
+      \`npm install as-bind\`
 
       \`\`\`
         const someCode = "hello world!";
@@ -91,7 +91,7 @@ ${markdown}
 
 ------
 
-asbind response:
+as-bind response:
 
 ${html}
 `);

lib/assembly/asbind.ts renamed to lib/assembly/as-bind.ts

@@ -10,7 +10,7 @@ const SUPPORTED_REF_TYPES = {
       return wasmExports.__retain(wasmExports.__allocString(arg));
     },
     getValueFromRef: (wasmExports, responseRef) => {
-      return wasmExports.__getString(responseRef).slice(0);
+      return wasmExports.__getString(responseRef);
     }
   },
   INT8ARRAY: {

lib/supported-ref-types.js

@@ -2,9 +2,9 @@
   "name": "as-bind",
   "description": "Isomorphic library to handle passing high-level data structures between AssemblyScript and JavaScript 🤝🚀",
   "version": "0.1.1",
-  "main": "dist/asbind.cjs.js",
-  "module": "dist/asbind.esm.js",
-  "browser": "dist/asbind.iife.js",
+  "main": "dist/as-bind.cjs.js",
+  "module": "dist/as-bind.esm.js",
+  "browser": "dist/as-bind.iife.js",
   "scripts": {
     "build": "run-s lib:wasm:build lib:js:build",
     "dev": "run-p lib:watch lib:test:watch",
@@ -15,19 +15,20 @@
     "lib:watch": "chokidar --initial \"lib/**/*\" -c \"run-s lib:wasm:build lib:js:build:dev test\"",
     "lib:test:watch": "chokidar \"test/**/*.js\" \"test/**/*.ts\" -c \"run-s lib:test:build test\"",
     "lib:wasm:build": "run-s lib:wasm:build:debug lib:wasm:build:optimized lib:wasm:build:cp",
-    "lib:wasm:build:debug": "asc lib/assembly/asbind.ts -b dist/asbind.debug.wasm -t dist/asbind.debug.wat --sourceMap --validate --debug --runtime full",
-    "lib:wasm:build:optimized": "asc lib/assembly/asbind.ts -b dist/asbind.wasm --sourceMap dist/asbind.wasm.map -t dist/asbind.wat --validate --runtime full -O3",
+    "lib:wasm:build:debug": "asc lib/assembly/as-bind.ts -b dist/as-bind.debug.wasm -t dist/as-bind.debug.wat --sourceMap --validate --debug --runtime full",
+    "lib:wasm:build:optimized": "asc lib/assembly/as-bind.ts -b dist/as-bind.wasm --sourceMap dist/as-bind.wasm.map -t dist/as-bind.wat --validate --runtime full -O3",
     "lib:wasm:build:cp": "cpy 'lib/assembly/**/*' dist",
     "lib:js:build": "rollup -c --environment LIB,PROD",
     "lib:js:build:dev": "rollup -c --environment LIB,DEV",
-    "lib:test:build": "asc test/assembly/test.ts -b test/assembly/test.wasm --validate --runtime full --debug",
+    "lib:test:build": "asc lib/assembly/as-bind.ts test/assembly/test.ts -b test/assembly/test.wasm --validate --runtime full --debug",
     "lib:deploy": "np",
     "md:build": "run-s md:wasm:build md:ts:build md:js:build",
-    "md:dev": "run-p lib:watch md:wasm:watch md:js:watch serve",
+    "md:dev": "run-p lib:watch md:wasm:watch md:ts:watch md:js:watch serve",
     "md:wasm:watch": "chokidar --initial \"examples/markdown-parser/assembly/**/*\" -c \"run-s md:wasm:build\"",
+    "md:ts:watch": "chokidar --initial \"examples/markdown-parser/assembly/**/*\" -c \"run-s md:ts:build\"",
     "md:js:watch": "chokidar --initial \"examples/markdown-parser/**/*\" -c \"rollup -c --environment MD,DEV\"",
-    "md:wasm:build": "asc examples/markdown-parser/assembly/index.ts -b dist/examples/markdown-parser/index.wasm -t dist/examples/markdown-parser/index.wat --sourceMap dist/examples/markdown-parser/index.wasm.map --validate --runtime full",
-    "md:ts:build": "tsc --project examples/markdown-parser/assembly/ --outDir dist/ --module \"es2015\"",
+    "md:wasm:build": "asc lib/assembly/as-bind.ts examples/markdown-parser/assembly/index.ts -b dist/examples/markdown-parser/index.wasm -t dist/examples/markdown-parser/index.wat --sourceMap dist/examples/markdown-parser/index.wasm.map --validate --runtime full",
+    "md:ts:build": "tsc --project examples/markdown-parser/assembly/ --outDir dist/ts/ --module \"es2015\"",
     "md:js:build": "rollup -c --environment MD,PROD",
     "md:deploy": "run-s build md:build md:deploy:gh-pages",
     "md:deploy:gh-pages": "gh-pages -d dist/examples/markdown-parser"
@@ -75,7 +76,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/torch2424/asbind.git"
+    "url": "git+https://github.com/torch2424/as-bind.git"
   },
   "keywords": [
     "assemblyscript",
@@ -95,8 +96,8 @@
   "author": "Aaron Turner",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/torch2424/asbind/issues"
+    "url": "https://github.com/torch2424/as-bind/issues"
   },
-  "homepage": "https://github.com/torch2424/asbind#readme",
+  "homepage": "https://github.com/torch2424/as-bind#readme",
   "dependencies": {}
 }

package.json

@@ -1,5 +1,4 @@
 // The entry file of your WebAssembly module.
-export * from "../../lib/assembly/asbind";
 
 export function helloWorld(world: string): string {
   return "Hello " + world + "!";

test/assembly/test.ts

@@ -1,6 +1,6 @@
 const fs = require("fs");
 const assert = require("assert");
-const { AsBind } = require("../dist/asbind.cjs");
+const { AsBind } = require("../dist/as-bind.cjs");
 
 const wasmBytes = new Uint8Array(fs.readFileSync("./test/assembly/test.wasm"));