tw-plugin-webpack 1.0.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,198 @@
+# tw-plugin-webpack
+
+Write a [TurboWarp / Scratch extension](https://github.com/TurboWarp/docs/tree/master/docs/development/extensions) across **as many files as you like**, then let **webpack** or **Rspack** bundle it into the single self-contained file TurboWarp expects.
+
+A normal TurboWarp extension is one file wrapped in an IIFE that registers itself:
+
+```js
+(function (Scratch) {
+  'use strict';
+  class MyExtension {
+    /* getInfo() + block methods */
+  }
+  Scratch.extensions.register(new MyExtension());
+})(Scratch);
+```
+
+That's fine for a toy, but it means everything — every block, helper, and constant — has to live in one file. This plugin lets you split the extension into real ES modules and produces exactly that IIFE for you, with `Scratch.extensions.register(...)` wired up automatically.
+
+## How it works
+
+Point your bundler at an entry module that `export default`s the extension class (or instance). The plugin:
+
+1. Configures the build to emit a **single self-executing file** whose entry export is captured in a local variable.
+2. Wraps the whole bundle in the standard `(function (Scratch) { … })(Scratch)` template.
+3. Appends `Scratch.extensions.register(new YourExtension())`.
+
+Because the entire bundle lives **inside** the IIFE, every bare reference to the `Scratch` global in your code binds to the local parameter — the "personal copy of the Scratch API" the TurboWarp docs recommend. No `import` of `Scratch` is needed (or possible); it's a host global, just like in a hand-written extension.
+
+## Install
+
+```sh
+npm install -D tw-plugin-webpack
+# plus whichever bundler you use:
+npm install -D @rspack/core   # or: npm install -D webpack webpack-cli
+```
+
+## Usage
+
+Split your extension however you like:
+
+```js
+// src/blocks/greeting.js
+export const greet = (name) => `Hello, ${name}!`;
+```
+
+```js
+// src/index.js — the entry. Default-export the class; do NOT call register().
+import { greet } from './blocks/greeting.js';
+
+export default class MyExtension {
+  getInfo() {
+    return {
+      id: 'myextension',
+      name: 'My Extension',
+      blocks: [
+        {
+          opcode: 'hello',
+          blockType: Scratch.BlockType.REPORTER,
+          text: 'greet [WHO]',
+          arguments: {
+            WHO: { type: Scratch.ArgumentType.STRING, defaultValue: 'world' },
+          },
+        },
+      ],
+    };
+  }
+  hello(args) {
+    return greet(args.WHO);
+  }
+}
+```
+
+### Rspack
+
+```js
+// rspack.config.js
+import { TurboWarpExtensionPlugin } from 'tw-plugin-webpack';
+
+export default {
+  mode: 'production',
+  target: 'web',
+  devtool: false, // single pasteable file — source maps just bloat it
+  entry: './src/index.js',
+  output: {
+    path: new URL('./dist', import.meta.url).pathname,
+    filename: 'my-extension.js',
+  },
+  plugins: [new TurboWarpExtensionPlugin({ name: 'My Extension' })],
+};
+```
+
+### webpack
+
+Identical — it's a standard plugin. `const { TurboWarpExtensionPlugin } = require('tw-plugin-webpack')` and drop it in `plugins`. The plugin touches no bundler-specific internals (it goes through `compiler.webpack`), so the same config shape works for both.
+
+Build it, then load `dist/my-extension.js` in TurboWarp via **add extension → Custom Extension**, or serve it and use `?extension=<url>`.
+
+## Options
+
+| Option          | Type                 | Default                    | Description                                                                                                                                                          |
+| --------------- | -------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `metadata`      | `object`             | —                          | Registry header injected as `// Name:` / `// ID:` / … comment lines (see [below](#submitting-to-the-gallery)).                                                       |
+| `inlineAssets`  | `boolean \| RegExp`  | `true`                     | Inline imported assets (svg/png/…) as base64 `data:` URIs so `import icon from './icon.svg'` works (see [below](#icons)). `RegExp` to customize, `false` to disable. |
+| `register`      | `boolean`            | `true`                     | Append the `Scratch.extensions.register(...)` call. Set `false` to call `register()` yourself inside your code.                                                      |
+| `unsandboxed`   | `boolean`            | `false`                    | Emit a guard that throws unless the extension runs unsandboxed (`Scratch.extensions.unsandboxed`).                                                                   |
+| `name`          | `string`             | `metadata.name`            | Name used in the unsandboxed-guard error message. Falls back to `metadata.name`, then `"This extension"`.                                                            |
+| `libraryExport` | `string \| string[]` | `"default"`                | Which export of the entry module is the extension. Use a named export instead of the default if you prefer.                                                          |
+| `varName`       | `string`             | `"__turbowarpExtension__"` | Internal identifier the export is assigned to before registration. Change only on an unlucky name collision.                                                         |
+
+`register` accepts either a **class** (it's instantiated with `new`) or an already-constructed **instance** (registered as-is).
+
+## Submitting to the gallery
+
+The [TurboWarp extensions gallery](https://github.com/TurboWarp/extensions) requires a metadata header — a block of `// Key: Value` comments at the very top of the file. Pass `metadata` and the plugin emits it above the IIFE:
+
+```js
+new TurboWarpExtensionPlugin({
+  metadata: {
+    name: 'Consoles',
+    id: 'sipcconsole', // must match getInfo().id
+    description: 'Blocks that interact with the developer console.',
+    by: '-SIPC-', // or an array → one `// By:` line each
+    license: 'MIT',
+  },
+});
+```
+
+produces, at the top of the bundle:
+
+```js
+// Name: Consoles
+// ID: sipcconsole
+// Description: Blocks that interact with the developer console.
+// By: -SIPC-
+// License: MIT
+
+(function (Scratch) {
+  /* …your bundle… */
+})(Scratch);
+```
+
+Fields are emitted in the conventional order **Name → ID → Description → By → Original → License → Context**; `by`/`original` accept an array for multiple lines, and any extra keys you add are appended verbatim (`// extra: …`). The header is added _after_ minification, so it's never stripped.
+
+## Icons
+
+`menuIconURI` / `blockIconURI` expect a `data:` URI. With `inlineAssets` on (the default), just **import the image** — the plugin configures the bundler to inline it as a base64 `data:` URI string:
+
+```js
+import iconURI from './icon.svg'; // → "data:image/svg+xml;base64,…"
+
+export default class MyExtension {
+  getInfo() {
+    return {
+      id: 'myextension',
+      name: 'My Extension',
+      menuIconURI: iconURI,
+      blocks: [
+        /* … */
+      ],
+    };
+  }
+}
+```
+
+Details:
+
+- `svg`, `png`, `jpg`, `gif`, `webp`, and `avif` imports are inlined by default. Pass a `RegExp` to match your own set (`inlineAssets: /\.(svg|png)$/i`), or `inlineAssets: false` to leave asset handling to your own config.
+- Inlining (rather than emitting a separate file) is required: a TurboWarp extension is a **single file** and can't reference external assets.
+- **TypeScript:** add an asset module declaration so the import is typed, e.g. `declare module '*.svg' { const url: string; export default url; }`.
+- If you build with **Rsbuild/Rslib** (which already handle SVG imports), set `inlineAssets: false` to avoid a duplicate asset rule.
+
+## Notes & caveats
+
+- **One file only.** TurboWarp loads a single `<script>`, so don't use dynamic `import()` / code splitting — keep it one synchronous bundle.
+- **`Scratch` is a global**, not an import. Your editor/linter may flag it; declare it as a readonly global (e.g. in ESLint `languageOptions.globals`). For TypeScript, [`@turbowarp/types`](https://github.com/TurboWarp/types) provides the `Scratch` typings.
+- **Source maps:** prefer `devtool: false`. A trailing `//# sourceMappingURL=` comment would otherwise sit in the middle of the wrapped file.
+
+## Is a plugin the best way to do this?
+
+For the common case, **yes** — it's one import and zero config beyond a name. But it's worth knowing the alternatives:
+
+- **Plain banner/footer.** The wrapper is static text, so you can skip the plugin entirely and use two `BannerPlugin` instances (`{ raw: true }`, one with `footer: true`) around a `var`-library build. The plugin just packages that up, detects the entry chunk, and handles registration/guards for you.
+- **Rslib / Rsbuild `format`.** If you build libraries with Rslib, a `umd` build plus a custom `banner`/`footer` gets you most of the way. The downside is you still have to hand-write the register call and reach into the UMD export.
+
+The dedicated plugin wins when you want it to "just work" and stay bundler-agnostic (webpack **and** Rspack) — which is exactly what it's for.
+
+## Example
+
+A runnable multi-file example lives in [`examples/multi-file-extension`](./examples/multi-file-extension). Build it with:
+
+```sh
+pnpm build          # build the plugin first
+pnpm build:example  # bundles src/{index,blocks/*}.js -> dist/multi-file-example.js
+```
+
+## License
+
+MPL-2.0