├── .gitignore ├── CODEOWNERS ├── CONTRIBUTING ├── CONTRIBUTORS ├── LICENSE ├── README.md ├── index.js ├── package.json └── renovate.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json 3 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | @surma 2 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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 2019 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. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Deprecated. Please use [rollup-plugin-off-main-thread](https://github.com/surma/rollup-plugin-off-main-thread) 2 | 3 | # rollup-plugin-workz0r 4 | 5 | An ill-named [rollup] plugin to add worker bundling support. With this plugin you can just use the `new Worker("somefile.js")` constructor and rollup will bundle that file and its dependencies into a separate chunk — similar to what happens with a dynamic import. 6 | 7 | ``` 8 | $ npm install --save rollup-plugin-workz0r 9 | ``` 10 | 11 | > Note: If you are a webpack user, take a look at [worker-[plugin](https://github.com/GoogleChromeLabs/worker-plugin). 12 | 13 | ## Usage 14 | 15 | ```js 16 | // rollup.config.js 17 | import workz0r from "rollup-plugin-workz0r"; 18 | 19 | export default { 20 | input: "src/main.js", 21 | plugins: [workz0r()] 22 | }; 23 | ``` 24 | 25 | ## The modules-in-workers problems 26 | 27 | At the time of writing, no browser has support for ES6 modules in workers. Until browsers have caught up, I wrote [`rollup-plugin-loadz0r`](https://github.com/surma/rollup-plugin-loadz0r) to make modules in workers “just work”. If you want to use these two plugins in conjunction, some extra plumbing is needed to let `loadz0r` know which chunks are worker chunks, as they need the loader code, too: 28 | 29 | ```js 30 | // rollup.config.js 31 | import loadz0r from "rollup-plugin-loadz0r"; 32 | import workz0r from "rollup-plugin-workz0r"; 33 | 34 | const workerModules = new Set(); 35 | export default { 36 | input: "input.js", 37 | output: { 38 | dir: "./dist", 39 | format: "amd" 40 | }, 41 | plugins: [ 42 | workz0r({ 43 | onWorkerModule: id => workerModules.add(id) 44 | }), 45 | loadz0r({ 46 | // `prependLoader` will be called for every chunk. If it returns `true`, 47 | // the loader code will be prepended. 48 | prependLoader: (chunk, inputs) => { 49 | // If the chunk contains one of the worker modules, prepend a loader. 50 | if (Object.keys(chunk.modules).some(mod => workerModules.has(mod))) { 51 | return true; 52 | } 53 | // If not, fall back to the default behavior. 54 | return loadz0r.isEntryModule(chunk, inputs); 55 | } 56 | }) 57 | ] 58 | }; 59 | ``` 60 | 61 | [rollup]: https://rollupjs.org/ 62 | [loadz0r]: https://github.com/surma/loadz0r 63 | 64 | --- 65 | 66 | License Apache-2.0 67 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 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 walker = require("acorn-walk"); 15 | const MagicString = require("magic-string"); 16 | 17 | const defaultOpts = { 18 | // Unique marker that temporarily injected to mark Worker imports. Should be 19 | // unique enough to not appear in (minified) code accidentally. 20 | marker: "_____TROLOLOLOL", 21 | // Regexp that finds the new chunk filename in between the markers after 22 | // Rollup has done its thing. 23 | filenameRegexp: /["'][^"']+\.js["']/, 24 | // A callback that will be called with each worker module id 25 | onWorkerModule: () => {} 26 | }; 27 | 28 | module.exports = function(opts) { 29 | opts = { ...defaultOpts, ...opts }; 30 | return { 31 | transform(code, id) { 32 | if (!/new\s+Worker/.test(code)) return; 33 | 34 | const ast = this.parse(code); 35 | 36 | // The walker calls a method for each node type on a “base” before calling 37 | // the method on our visitor object. The default base doesn’t handle 38 | // dynamic import. Here we create a copy of the original base 39 | // using `make()` and put add an empty handler for dynamic imports 40 | // ourselves. Seems to work :shrug: 41 | const newBase = walker.make({ 42 | Import(node) {} 43 | }); 44 | 45 | const warn = this.warn.bind(this); 46 | // Collect all the worker calls in this array. 47 | const newWorkerCalls = []; 48 | walker.simple( 49 | ast, 50 | { 51 | NewExpression(node) { 52 | if (node.callee.name !== "Worker") { 53 | return; 54 | } 55 | const workerFile = node.arguments[0].value; 56 | if (!/^\.*\//.test(workerFile)) { 57 | warn( 58 | `For workz0r, worker file paths must be relative or absolute, i.e. start with /, ./ or ../ (just like dynamic import!). ` + 59 | `Ignoring "${workerFile}".` 60 | ); 61 | return; 62 | } 63 | newWorkerCalls.push(node.arguments[0]); 64 | } 65 | }, 66 | newBase 67 | ); 68 | 69 | if (newWorkerCalls.length === 0) return; 70 | 71 | // Surround the worker constructor call with markers so we can find it 72 | // later and inject a dynamic import so that Rollup has to create an edge 73 | // in the dependency graph. We have to use markers as the import might get 74 | // processed by Rollup for AMD/CommonJS or something and the file name 75 | // will be changed by Rollup as well. 76 | const ms = new MagicString(code); 77 | newWorkerCalls.forEach(node => { 78 | this.resolveId(node.value).then(id => opts.onWorkerModule(id)); 79 | // Insert marker 80 | ms.appendLeft(node.start, `"${opts.marker}_start" + import(`); 81 | ms.appendRight(node.end, `) + "${opts.marker}_end"`); 82 | }); 83 | return { 84 | code: ms.toString(), 85 | map: ms.generateMap({ hires: true }) 86 | }; 87 | }, 88 | renderChunk(code) { 89 | const magicCode = new MagicString(code); 90 | // Find all the markers in this file 91 | const matcher = new RegExp( 92 | `"${opts.marker}_start.+?${opts.marker}_end"`, 93 | "g" 94 | ); 95 | while (true) { 96 | const match = matcher.exec(code); 97 | if (!match) { 98 | break; 99 | } 100 | // Extract the new filename that has to be somewhere between these markers. 101 | const newFilename = opts.filenameRegexp.exec(match[0])[0]; 102 | // Replace the marked section with just the filename, which will 103 | // leave the file with a normal `new Worker()` call. 104 | magicCode.overwrite( 105 | match.index, 106 | match.index + match[0].length, 107 | newFilename 108 | ); 109 | } 110 | return { 111 | code: magicCode.toString(), 112 | map: magicCode.generateMap({ hires: true }) 113 | }; 114 | } 115 | }; 116 | }; 117 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rollup-plugin-workz0r", 3 | "version": "0.2.1", 4 | "description": "Rollup plugin to make workers “just work”", 5 | "main": "index.js", 6 | "scripts": { 7 | "fmt": "prettier --write *.js *.md *.json" 8 | }, 9 | "author": "Surma ", 10 | "license": "Apache-2.0", 11 | "devDependencies": { 12 | "prettier": "1.18.2", 13 | "rollup": "1.12.0" 14 | }, 15 | "repository": { 16 | "type": "git", 17 | "url": "https://github.com/surma/rollup-plugin-workz0r" 18 | }, 19 | "dependencies": { 20 | "acorn-walk": "^6.1.1", 21 | "magic-string": "^0.25.0" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["config:base"] 3 | } 4 | --------------------------------------------------------------------------------