Document

├── .gitignore ├── test ├── addition.as ├── main.js ├── index.html └── rollup.config.js ├── CONTRIBUTORS ├── package.json ├── CONTRIBUTING ├── README.md ├── index.js └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | test/build -------------------------------------------------------------------------------- /test/addition.as: -------------------------------------------------------------------------------- 1 | //@ts-ignore 2 | export function add(a: i32, b: i32): i32 { 3 | return a + b; 4 | } 5 | -------------------------------------------------------------------------------- /test/main.js: -------------------------------------------------------------------------------- 1 | import { instancePromise } from "asc:./addition.as"; 2 | 3 | instancePromise.then(instance => { 4 | alert(instance.exports.add(40, 2)); 5 | }); 6 | -------------------------------------------------------------------------------- /test/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Document 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /test/rollup.config.js: -------------------------------------------------------------------------------- 1 | let asc = require("../index.js").asc; 2 | 3 | export default { 4 | input: "main.js", 5 | output: { 6 | file: "build/main.js", 7 | name: "test", 8 | format: "umd" 9 | }, 10 | plugins: [ 11 | asc({ 12 | fileExtension: ".as", 13 | compilerOptions: { 14 | optimizeLevel: 3, 15 | runtime: "none" 16 | //shrinkLevel: 1, 17 | //importMemory: true 18 | } 19 | }) 20 | ] 21 | }; 22 | -------------------------------------------------------------------------------- /CONTRIBUTORS: -------------------------------------------------------------------------------- 1 | # People who have agreed to one of the CLAs and can contribute patches. 2 | # The AUTHORS file lists the copyright holders; this file 3 | # lists people. For example, Google employees are listed here 4 | # but not in AUTHORS, because Google holds the copyright. 5 | # 6 | # https://developers.google.com/open-source/cla/individual 7 | # https://developers.google.com/open-source/cla/corporate 8 | # 9 | # Names should be added to this file as: 10 | # Name 11 | Surma 12 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rollup-plugin-assemblyscript", 3 | "version": "2.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "keywords": [], 7 | "author": "Surma ", 8 | "license": "Apache-2.0", 9 | "peerDependencies": { 10 | "assemblyscript": "*", 11 | "as-bind": "*" 12 | }, 13 | "devDependencies": { 14 | "husky": "^4.2.3", 15 | "lint-staged": "^10.0.8", 16 | "prettier": "^1.19.1", 17 | "rollup": "^2.32.1" 18 | }, 19 | "scripts": { 20 | "test": "cd test && rollup -c", 21 | "test-serve": "npx servez test" 22 | }, 23 | "husky": { 24 | "hooks": { 25 | "pre-commit": "lint-staged" 26 | } 27 | }, 28 | "lint-staged": { 29 | "*.{js,css,md}": "prettier --write" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /CONTRIBUTING: -------------------------------------------------------------------------------- 1 | Want to contribute? Great! First, read this page (including the small print at the end). 2 | 3 | ### Before you contribute 4 | Before we can use your code, you must sign the 5 | [Google Individual Contributor License Agreement] 6 | (https://cla.developers.google.com/about/google-individual) 7 | (CLA), which you can do online. The CLA is necessary mainly because you own the 8 | copyright to your changes, even after your contribution becomes part of our 9 | codebase, so we need your permission to use and distribute your code. We also 10 | need to be sure of various other things—for instance that you'll tell us if you 11 | know that your code infringes on other people's patents. You don't have to sign 12 | the CLA until after you've submitted your code for review and a member has 13 | approved it, but you must do it before we can put your code into our codebase. 14 | Before you start working on a larger contribution, you should get in touch with 15 | us first through the issue tracker with your idea so that we can help out and 16 | possibly guide you. Coordinating up front makes it much easier to avoid 17 | frustration later on. 18 | 19 | ### Code reviews 20 | All submissions, including submissions by project members, require review. We 21 | use Github pull requests for this purpose. 22 | 23 | ### The small print 24 | Contributions made by corporations are covered by a different agreement than 25 | the one above, the 26 | [Software Grant and Corporate Contributor License Agreement] 27 | (https://cla.developers.google.com/about/google-corporate). 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rollup-plugin-assemblyscript 2 | 3 | A [Rollup] plugin that allows you to import [AssemblyScript] files and compiles them on-the-fly. 4 | 5 | ## Usage 6 | 7 | ### Installation 8 | 9 | ``` 10 | $ npm install --save rollup-plugin-assemblyscript 11 | ``` 12 | 13 | ### Configuration 14 | 15 | ```js 16 | // rollup.config.js 17 | import { asc } from "rollup-plugin-assemblyscript"; 18 | 19 | export default { 20 | /* ... */ 21 | plugins: [ 22 | // ... 23 | asc(options) 24 | // ... 25 | ] 26 | }; 27 | ``` 28 | 29 | And in your JavaScript code you can now import AssemblyScript as usual: 30 | 31 | ```js 32 | // addition.as 33 | export function add(a: i32, b: i32): i32 { 34 | return a + b; 35 | } 36 | ``` 37 | 38 | ```js 39 | // main.js 40 | import wasmUrl from "asc:./addition.as"; 41 | 42 | WebAssembly.instantiateStreaming(fetch(wasmUrl), {}).then(({ instance }) => 43 | console.log(instance.exports.add(40, 2)) 44 | ); 45 | ``` 46 | 47 | ## Options 48 | 49 | - `compilerOptions`: Options bag that is passed straight to the [AssemblyScript compiler library]. 50 | - `matcher`: A RegExp that is used to decided what imports to handle. The default is `PREFIX_MATCHER`, which will match all imports that start with `asc:`. 51 | - `useAsBind`: Injects the [`as-bind`][as-bind] package into the compilation process for high-level type bindings. See [their README][as-bind] for details (implies `--exportRuntime`). 52 | 53 | --- 54 | 55 | License Apache-2.0 56 | 57 | [rollup]: https://rollupjs.org 58 | [assemblyscript]: https://assemblyscript.org 59 | [assemblyscript compiler library]: https://docs.assemblyscript.org/details/compiler#api 60 | [as-bind]: https://npm.im/as-bind 61 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2020 Google Inc. All Rights Reserved. 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * http://www.apache.org/licenses/LICENSE-2.0 7 | * Unless required by applicable law or agreed to in writing, software 8 | * distributed under the License is distributed on an "AS IS" BASIS, 9 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 10 | * See the License for the specific language governing permissions and 11 | * limitations under the License. 12 | */ 13 | 14 | const asCompiler = require("assemblyscript/cli/asc"); 15 | const { basename, join } = require("path"); 16 | const { tmpdir } = require("os"); 17 | const fsp = require("fs/promises"); 18 | 19 | const MARKER = "asc:"; 20 | const PREFIX_MATCHER = /^asc:(.+)$/; 21 | const defaultOpts = { 22 | matcher: PREFIX_MATCHER, 23 | compilerOptions: {}, 24 | useAsBind: false 25 | }; 26 | 27 | // This special import contains the `compileStreaming` polyfill. 28 | const SPECIAL_IMPORT = "__rollup-plugin-assemblyscript_compileStreaming"; 29 | 30 | function asc(opts) { 31 | opts = { ...defaultOpts, ...opts }; 32 | 33 | return { 34 | name: "assemblyscript", 35 | async resolveId(rawId, importee) { 36 | if (rawId === SPECIAL_IMPORT) { 37 | return SPECIAL_IMPORT; 38 | } 39 | const matches = opts.matcher.exec(rawId); 40 | if (!matches) { 41 | return; 42 | } 43 | const { id } = await this.resolve(matches[1], importee); 44 | this.addWatchFile(id); 45 | return MARKER + id; 46 | }, 47 | async load(id) { 48 | if (id === SPECIAL_IMPORT) { 49 | return ` 50 | export async function compileStreaming(respP) { 51 | if('compileStreaming' in WebAssembly) { 52 | return WebAssembly.compileStreaming(respP); 53 | } 54 | return respP 55 | .then(resp => resp.arrayBuffer()) 56 | .then(buffer => WebAssembly.compile(buffer)); 57 | } 58 | `; 59 | } 60 | if (!id.startsWith(MARKER)) { 61 | return; 62 | } 63 | id = id.slice(MARKER.length); 64 | const fileName = basename(id).replace(/\.[^.]+$/, ""); 65 | const wasmFileName = `${fileName}.wasm`; 66 | const folder = tmpdir(); 67 | const wasmFilePath = join(folder, wasmFileName); 68 | await asCompiler.ready; 69 | await new Promise(async (resolve, reject) => { 70 | const params = [ 71 | opts.useAsBind 72 | ? [ 73 | require.resolve("as-bind/lib/assembly/as-bind.ts"), 74 | "--exportRuntime" 75 | ] 76 | : [], 77 | id, 78 | "-b", 79 | wasmFilePath, 80 | ...Object.entries(opts.compilerOptions).map(([opt, val]) => { 81 | if (val === true) { 82 | return `--${opt}`; 83 | } 84 | return `--${opt}=${val}`; 85 | }), 86 | opts.fileExtension ? [`--extension`, opts.fileExtension] : [] 87 | ].flat(); 88 | asCompiler.main(params, async err => { 89 | if (err) { 90 | return reject(`${err}`); 91 | } 92 | resolve(); 93 | }); 94 | }); 95 | const source = await fsp.readFile(wasmFilePath); 96 | const referenceId = this.emitFile({ 97 | type: "asset", 98 | name: `${fileName}.wasm`, 99 | source 100 | }); 101 | if (opts.compilerOptions.sourceMap) { 102 | const sourceMapFileName = wasmFileName + ".map"; 103 | const sourceMapFilePath = join(folder, sourceMapFileName); 104 | this.emitFile({ 105 | type: "asset", 106 | fileName: `assets/${sourceMapFileName}`, 107 | source: await fsp.readFile(sourceMapFilePath) 108 | }); 109 | } 110 | 111 | return ` 112 | import {compileStreaming} from "${SPECIAL_IMPORT}"; 113 | export const wasmUrl = import.meta.ROLLUP_FILE_URL_${referenceId}; 114 | export default wasmUrl; 115 | `; 116 | } 117 | }; 118 | } 119 | 120 | module.exports = { asc, PREFIX_MATCHER }; 121 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2020 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. --------------------------------------------------------------------------------