docs(bundle-source): Document no transforms mode (#2307)

Fills in the usage and NEWS for #2294.
endojs · Jun 21, 2024 · 7467efa · 7467efa
2 parents ad1706a + 3d50163
commit 7467efa
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/packages/bundle-source/NEWS.md b/packages/bundle-source/NEWS.md
@@ -1,4 +1,14 @@
 
+# Next version
+
+- Adds support for `--no-transforms` (`-T`) which generates bundles with
+  original sources.
+  A future version of `@endo/import-bundle` will be able to execute this
+  kind of bundle on XS and in Node.js, but will remain opt-in because
+  they cannot be made to run on the web without further work on module
+  virtualization in the platform without entraining a client-side
+  dependency on a JavaScript parser framework (namely Babel).
+
 # v3.2.1 (2024-03-20)
 
 - Fixes an install-time bug introduced in 3.2.0.

diff --git a/packages/bundle-source/src/main.js b/packages/bundle-source/src/main.js
@@ -3,7 +3,7 @@ import { parseArgs } from 'util';
 import { jsOpts, jsonOpts, makeNodeBundleCache } from '../cache.js';
 
 const USAGE =
-  'bundle-source [--cache-js | --cache-json] cache/ module1.js bundleName1 module2.js bundleName2 ...';
+  'bundle-source [-T,--no-transforms] [--cache-js | --cache-json] cache/ module1.js bundleName1 module2.js bundleName2 ...';
 
 const options = /** @type {const} */ ({
   'no-transforms': {