@metamask/snaps-cli 0.8.0 → 0.10.1

package/CHANGELOG.md

@@ -6,6 +6,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.10.1]
+### Fixed
+- Comment stripping will no longer remove empty block comments in strings ([#276](https://github.com/MetaMask/snaps-skunkworks/pull/276))
+
+## [0.10.0]
+### Added
+- **BREAKING:** Transform HTML comments by default ([#237](https://github.com/MetaMask/snaps-skunkworks/pull/237))
+  - The strings `<!--` and `-->` will be transformed into `< !--` and `-- >` respectively by default. If these strings appear as operands in an expression or in a string literal, this transform will change the behavior of your program. This behavior was added because these strings are rejected by SES. The behavior can be toggled using the `--transformHtmlComments` option.
+- `--transpiledDeps` flag to `build` and `watch` commands ([#221](https://github.com/MetaMask/snaps-skunkworks/pull/221))
+  - This flag allows the user to specify which dependencies will be transpiled at build time if the `--transpilationMode` is `--localAndDeps`.
+- Add CLI usage instructions to readme ([#228](https://github.com/MetaMask/snaps-skunkworks/pull/228))
+- Build process customization ([#251](https://github.com/MetaMask/snaps-skunkworks/pull/251))
+  - Builds can now be customized by adding a `bundlerCustomizer` function to `snap.config.js`. See the README for details.
+
+### Changed
+- **BREAKING:** Change Snap config file format ([#251](https://github.com/MetaMask/snaps-skunkworks/pull/251))
+  - The CLI now expects a file `snap.config.js` instead of `snap.config.json`, with a different structure. See the README for details.
+- **BREAKING:** Strip comments in source code by default ([#243](https://github.com/MetaMask/snaps-skunkworks/pull/243))
+  - All comments will now be stripped from snap source code (including dependencies) by default.
+- Enable `--verboseErrors` by default ([#249](https://github.com/MetaMask/snaps-skunkworks/pull/249))
+
+### Fixed
+- Comment stripping bug ([#270](https://github.com/MetaMask/snaps-skunkworks/pull/270))
+  - Prior to this change, if the `--strip-comments` option was provided to `mm-snap build` and an empty block comment of the form `/**/` appeared anywhere in the source code (including dependencies), the remainder of the string after the empty block comment would be truncated. This was resolved by removing all instances of the string `/**/` from the raw bundle string.
+  - In an upcoming release, the string `/**/` will only be removed if it is in fact an empty block comment, and not if it e.g. appears in a string literal.
+- `watch` command parity with `build` command ([#241](https://github.com/MetaMask/snaps-skunkworks/pull/241))
+  - The `build` command had received a number of options that were not made available to the `watch` command. They now have the same options.
+- Update dead link in readme ([#240](https://github.com/MetaMask/snaps-skunkworks/pull/240))
+
+## [0.9.0]
+### Added
+- Transpilation configuration ([#213](https://github.com/MetaMask/snaps-skunkworks/pull/213))
+  - `mm-snap build` now takes a `--transpilationMode` argument which determines what will be transpiled by Babel during building: all source code (including dependencies), local source code only, or nothing.
+
+### Fixed
+- `mm-snap build` command when CLI is installed globally ([#216](https://github.com/MetaMask/snaps-skunkworks/pull/216))
+- Update installation command in readme ([#205](https://github.com/MetaMask/snaps-skunkworks/pull/205))
+
 ## [0.8.0]
 ### Changed
 - Update template snap created by `mm-snap init` ([#195](https://github.com/MetaMask/snaps-skunkworks/pull/195))
@@ -89,7 +127,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Example snaps ([#72](https://github.com/MetaMask/snaps-skunkworks/pull/72))
   - The examples now live in their own package, [`@metamask/snap-examples`](https://npmjs.com/package/@metamask/snap-examples).
 
-[Unreleased]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.8.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.10.1...HEAD
+[0.10.1]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.10.0...v0.10.1
+[0.10.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.8.0...v0.9.0
 [0.8.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.6.3...v0.7.0
 [0.6.3]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.6.2...v0.6.3

package/README.md

@@ -7,14 +7,42 @@ A CLI for developing MetaMask Snaps.
 Use Node.js `12.11.0` or later.
 We recommend [nvm](https://github.com/nvm-sh/nvm) for managing Node.js versions.
 
-- `yarn global add snaps-cli`
+Install a dev dependency in your snap project or globally using `yarn` or `npm`:
 
-## Basic Usage
+- `npm install -g @metamask/snaps-cli`
+- `yarn global add @metamask/snaps-cli`
 
-```bash
-mkdir mySnap
-cd mySnap
-mm-snap init
+## Usage
+
+```text
+Usage: mm-snap <command> [options]
+
+Commands:
+  mm-snap build     Build Snap from source                          [aliases: b]
+  mm-snap eval      Attempt to evaluate Snap bundle in SES          [aliases: e]
+  mm-snap init      Initialize Snap package                         [aliases: i]
+  mm-snap manifest  Validate the snap.manifest.json file            [aliases: m]
+  mm-snap serve     Locally serve Snap file(s) for testing          [aliases: s]
+  mm-snap watch     Build Snap on change                            [aliases: w]
+
+Options:
+      --version           Show version number                          [boolean]
+      --verboseErrors     Display original errors      [boolean] [default: true]
+      --suppressWarnings  Whether to suppress warnings[boolean] [default: false]
+  -h, --help              Show help                                    [boolean]
+
+Examples:
+  mm-snap init                              Initialize a snap project in the
+                                            current directory
+  mm-snap build -s src/index.js -d out      Build 'src/index.js' as
+                                            './out/bundle.js'
+  mm-snap build -s src/index.js -d out -n   Build 'src/index.js' as
+  snap.js                                   './out/snap.js'
+  mm-snap serve -r out                      Serve files in './out' on port 8080
+  mm-snap serve -r out -p 9000              Serve files in './out' on port 9000
+  mm-snap watch -s src/index.js -d out      Rebuild './out/bundle.js' on changes
+                                            to files in 'src/index.js' parent
+                                            and child directories
 ```
 
 ## MetaMask Snaps
@@ -60,7 +88,7 @@ Here's an example manifest:
 }
 ```
 
-Refer to [the Snaps publishing specification](https://github.com/MetaMask/specifications/blob/main/snaps/publishing.md) and the [manifest JSON schema](https://github.com/MetaMask/specifications/blob/main/snaps/schemas/snap-manifest.schema.json) for details.
+Refer to [the Snaps publishing specification](https://github.com/MetaMask/specifications/blob/main/snaps/publishing.md) and the [manifest JSON schema](https://github.com/MetaMask/snaps-skunkworks/blob/main/packages/controllers/src/snaps/json-schemas/snap-manifest.schema.json) for details.
 
 > **ATTN:** If your Snap is not compatible with the publishing specification, your Snap may not work properly or install at all.
 
@@ -80,25 +108,39 @@ snap-project/
 ```
 
 Source files other than `index.js` are located through its imports.
-The defaults can be overwritten using the `snap.config.json` config file,
-[see below](#configuration-file).
+The defaults can be overwritten using the `snap.config.json` [config file](#configuration-file).
 
-## Usage
+### Configuration File
 
-Run `mm-snap --help` for usage instructions.
+`snap.config.js` can be placed in the project root directory. It can override cli options - the property `cliOptions` should have string keys matching command arguments. Values become argument defaults, which can still be overriden on the command line.
 
-### Configuration File
+Example:
+
+```javascript
+module.exports = {
+  cliOptions: {
+    src: 'lib/index.js',
+    dist: 'out',
+    port: 9000,
+  },
+};
+```
+
+Should you want to customize your build process, you can provide `bundlerCustomizer` property. It's a function that takes one argument - [browserify object](https://github.com/browserify/browserify#api-example) which we use internally to bundle the snap. You can transform it in any way you want, for example adding plugins.
 
-`snap.config.json` can be placed in the project root directory. It should have string keys matching command arguments.
-Values become argument defaults, which can still be overriden on the command line.
 Example:
 
-```json
-{
-  "src": "lib",
-  "dist": "out",
-  "port": 9000
-}
+```javascript
+const brfs = require('brfs');
+
+module.exports = {
+  cliOptions: {
+    /* ... */
+  },
+  bundlerCustomizer: (bundler) => {
+    bundler.transform(brfs);
+  },
+};
 ```
 
 The configuration file should not be published.

package/dist/builders.d.ts

@@ -1,18 +1,26 @@
 import { Options } from 'yargs';
 export declare type SnapsCliBuilders = {
-    readonly src: Readonly<Options>;
-    readonly dist: Readonly<Options>;
     readonly bundle: Readonly<Options>;
-    readonly root: Readonly<Options>;
+    readonly dist: Readonly<Options>;
+    readonly eval: Readonly<Options>;
+    readonly manifest: Readonly<Options>;
+    readonly outfileName: Readonly<Options>;
     readonly port: Readonly<Options>;
+    readonly root: Readonly<Options>;
     readonly sourceMaps: Readonly<Options>;
+    readonly src: Readonly<Options>;
     readonly stripComments: Readonly<Options>;
-    readonly outfileName: Readonly<Options>;
-    readonly manifest: Readonly<Options>;
-    readonly writeManifest: Readonly<Options>;
-    readonly eval: Readonly<Options>;
-    readonly verboseErrors: Readonly<Options>;
     readonly suppressWarnings: Readonly<Options>;
+    readonly transpilationMode: Readonly<Options>;
+    readonly transformHtmlComments: Readonly<Options>;
+    readonly depsToTranspile: Readonly<Options>;
+    readonly verboseErrors: Readonly<Options>;
+    readonly writeManifest: Readonly<Options>;
 };
+export declare enum TranspilationModes {
+    localAndDeps = "localAndDeps",
+    localOnly = "localOnly",
+    none = "none"
+}
 declare const builders: SnapsCliBuilders;
 export default builders;

package/dist/builders.js

@@ -1,13 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranspilationModes = void 0;
+var TranspilationModes;
+(function (TranspilationModes) {
+    TranspilationModes["localAndDeps"] = "localAndDeps";
+    TranspilationModes["localOnly"] = "localOnly";
+    TranspilationModes["none"] = "none";
+})(TranspilationModes = exports.TranspilationModes || (exports.TranspilationModes = {}));
 const builders = {
-    src: {
-        alias: 's',
-        describe: 'Source file',
+    bundle: {
+        alias: 'b',
+        describe: 'Snap bundle file',
         type: 'string',
         demandOption: true,
         normalize: true,
-        default: 'src/index.js',
+        default: 'dist/bundle.js',
     },
     dist: {
         alias: 'd',
@@ -17,21 +24,19 @@ const builders = {
         normalize: true,
         default: 'dist',
     },
-    bundle: {
-        alias: 'b',
-        describe: 'Snap bundle file',
-        type: 'string',
-        demandOption: true,
-        normalize: true,
-        default: 'dist/bundle.js',
+    eval: {
+        alias: 'e',
+        describe: 'Attempt to evaluate Snap bundle in SES',
+        type: 'boolean',
+        demandOption: false,
+        default: true,
     },
-    root: {
-        alias: 'r',
-        describe: 'Server root directory',
-        type: 'string',
-        demandOption: true,
-        normalize: true,
-        default: '.',
+    manifest: {
+        alias: 'm',
+        describe: 'Validate snap.manifest.json',
+        type: 'boolean',
+        demandOption: false,
+        default: true,
     },
     port: {
         alias: 'p',
@@ -47,57 +52,77 @@ const builders = {
             return port;
         },
     },
+    outfileName: {
+        alias: 'n',
+        describe: 'Output file name',
+        type: 'string',
+        demandOption: false,
+        default: 'bundle.js',
+    },
+    root: {
+        alias: 'r',
+        describe: 'Server root directory',
+        type: 'string',
+        demandOption: true,
+        normalize: true,
+        default: '.',
+    },
     sourceMaps: {
         describe: 'Whether builds include sourcemaps',
         type: 'boolean',
         demandOption: false,
         default: false,
     },
+    src: {
+        alias: 's',
+        describe: 'Source file',
+        type: 'string',
+        demandOption: true,
+        normalize: true,
+        default: 'src/index.js',
+    },
     stripComments: {
         alias: 'strip',
         describe: 'Whether to remove code comments from the build output',
         type: 'boolean',
         demandOption: false,
-        default: false,
+        default: true,
     },
-    outfileName: {
-        alias: 'n',
-        describe: 'Output file name',
-        type: 'string',
+    suppressWarnings: {
+        type: 'boolean',
+        describe: 'Whether to suppress warnings',
         demandOption: false,
-        default: 'bundle.js',
+        default: false,
     },
-    manifest: {
-        alias: 'm',
-        describe: 'Validate snap.manifest.json',
-        type: 'boolean',
+    transpilationMode: {
+        type: 'string',
+        describe: 'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',
         demandOption: false,
-        default: true,
+        default: TranspilationModes.localOnly,
+        choices: Object.values(TranspilationModes),
     },
-    writeManifest: {
-        describe: 'Make necessary changes to the Snap manifest file',
+    transformHtmlComments: {
         type: 'boolean',
-        demandOption: false,
+        describe: 'Whether to break up HTML comment tokens wherever they appear in your source code.',
+        demandOption: true,
         default: true,
     },
-    eval: {
-        alias: 'e',
-        describe: 'Attempt to evaluate Snap bundle in SES',
-        type: 'boolean',
+    depsToTranspile: {
+        type: 'array',
+        describe: 'Transpile only the listed dependencies.',
         demandOption: false,
-        default: true,
     },
     verboseErrors: {
         type: 'boolean',
         describe: 'Display original errors',
         demandOption: false,
-        default: false,
+        default: true,
     },
-    suppressWarnings: {
+    writeManifest: {
+        describe: 'Make necessary changes to the Snap manifest file',
         type: 'boolean',
-        describe: 'Suppress warnings',
         demandOption: false,
-        default: false,
+        default: true,
     },
 };
 exports.default = builders;

package/dist/builders.js.map

@@ -1 +1 @@
-{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;AAkBA,MAAM,QAAQ,GAAqB;IACjC,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,mBAAmB;QAC7B,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly src: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly bundle: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n};\n\nconst builders: SnapsCliBuilders = {\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: false,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n};\n\nexport default builders;\n"]}
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAqBA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,MAAM,QAAQ,GAAqB;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,gBAAgB;KAC1B;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAC;aACzC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,WAAW;KACrB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,GAAG;KACb;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,cAAc;KACxB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,KAAK;KACf;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,iHAAiH;QACnH,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,kBAAkB,CAAC,SAAS;QACrC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;KAC3C;IAED,qBAAqB,EAAE;QACrB,IAAI,EAAE,SAAS;QACf,QAAQ,EACN,mFAAmF;QACrF,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,IAAI;KACd;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,YAAY,EAAE,KAAK;KACpB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,kBAAe,QAAQ,CAAC","sourcesContent":["import { Options } from 'yargs';\n\nexport type SnapsCliBuilders = {\n  readonly bundle: Readonly<Options>;\n  readonly dist: Readonly<Options>;\n  readonly eval: Readonly<Options>;\n  readonly manifest: Readonly<Options>;\n  readonly outfileName: Readonly<Options>;\n  readonly port: Readonly<Options>;\n  readonly root: Readonly<Options>;\n  readonly sourceMaps: Readonly<Options>;\n  readonly src: Readonly<Options>;\n  readonly stripComments: Readonly<Options>;\n  readonly suppressWarnings: Readonly<Options>;\n  readonly transpilationMode: Readonly<Options>;\n  readonly transformHtmlComments: Readonly<Options>;\n  readonly depsToTranspile: Readonly<Options>;\n  readonly verboseErrors: Readonly<Options>;\n  readonly writeManifest: Readonly<Options>;\n};\n\nexport enum TranspilationModes {\n  localAndDeps = 'localAndDeps',\n  localOnly = 'localOnly',\n  none = 'none',\n}\n\nconst builders: SnapsCliBuilders = {\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist/bundle.js',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'dist',\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    demandOption: true,\n    default: 8081,\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: ${arg}`);\n      }\n      return port;\n    },\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    demandOption: false,\n    default: 'bundle.js',\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: '.',\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    demandOption: false,\n    default: false,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    demandOption: true,\n    normalize: true,\n    default: 'src/index.js',\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    demandOption: false,\n    default: false,\n  },\n\n  transpilationMode: {\n    type: 'string',\n    describe:\n      'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing.',\n    demandOption: false,\n    default: TranspilationModes.localOnly,\n    choices: Object.values(TranspilationModes),\n  },\n\n  transformHtmlComments: {\n    type: 'boolean',\n    describe:\n      'Whether to break up HTML comment tokens wherever they appear in your source code.',\n    demandOption: true,\n    default: true,\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    demandOption: false,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    demandOption: false,\n    default: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the Snap manifest file',\n    type: 'boolean',\n    demandOption: false,\n    default: true,\n  },\n};\n\nexport default builders;\n"]}

package/dist/cli.js

@@ -11,8 +11,9 @@ function cli(argv, commands) {
     const rawArgv = argv.slice(2);
     // eslint-disable-next-line @typescript-eslint/no-unused-expressions
     yargs_1.default(rawArgv)
+        .scriptName('mm-snap')
         .usage('Usage: $0 <command> [options]')
-        .example('$0 init', `\tInitialize Snap package from scratch`)
+        .example('$0 init', `\tInitialize a snap project in the current directory`)
         .example('$0 build -s src/index.js -d out', `\tBuild 'src/index.js' as './out/bundle.js'`)
         .example('$0 build -s src/index.js -d out -n snap.js', `\tBuild 'src/index.js' as './out/snap.js'`)
         .example('$0 serve -r out', `\tServe files in './out' on port 8080`)
@@ -26,7 +27,7 @@ function cli(argv, commands) {
         // yargs middleware functions receive the yargs instance as a second parameter.
         // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation
         .middleware(((yargsArgv, yargsInstance) => {
-        utils_1.applyConfig(rawArgv, yargsArgv, yargsInstance);
+        utils_1.applyConfig(utils_1.loadConfig(), rawArgv, yargsArgv, yargsInstance);
         utils_1.setSnapGlobals(yargsArgv);
         utils_1.sanitizeInputs(yargsArgv);
     }), true)

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AAEzC,0DAAkC;AAClC,mCAAsE;AAEtE,SAAgB,GAAG,CAAC,IAAc,EAAE,QAAa;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,oEAAoE;IACpE,eAAK,CAAC,OAAO,CAAC;SACX,KAAK,CAAC,+BAA+B,CAAC;SAEtC,OAAO,CAAC,SAAS,EAAE,wCAAwC,CAAC;SAC5D,OAAO,CACN,iCAAiC,EACjC,6CAA6C,CAC9C;SACA,OAAO,CACN,4CAA4C,EAC5C,2CAA2C,CAC5C;SACA,OAAO,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;SACnE,OAAO,CAAC,yBAAyB,EAAE,uCAAuC,CAAC;SAC3E,OAAO,CACN,iCAAiC,EACjC,gGAAgG,CACjG;SAEA,OAAO,CAAC,QAAQ,CAAC;SAEjB,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;SAE/C,MAAM,CAAC,kBAAkB,EAAE,kBAAQ,CAAC,gBAAgB,CAAC;SAErD,MAAM,EAAE;QAET,gEAAgE;QAChE,+EAA+E;QAC/E,0FAA0F;SACzF,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,aAA+B,EAAE,EAAE;QACzD,mBAAW,CAAC,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC/C,sBAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,sBAAc,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,CAAQ,EACT,IAAI,CACL;SAEA,IAAI,CAAC,CAAC,GAAW,EAAE,GAAU,EAAE,MAAM,EAAE,EAAE;QACxC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,KAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;YAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAC1B;QACD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC;SAED,aAAa,CAAC,CAAC,EAAE,wCAAwC,CAAC;SAE1D,IAAI,EAAE;SACN,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;AAC7B,CAAC;AAtDD,kBAsDC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport yargsType from 'yargs/yargs';\nimport builders from './builders';\nimport { applyConfig, sanitizeInputs, setSnapGlobals } from './utils';\n\nexport function cli(argv: string[], commands: any): void {\n  const rawArgv = argv.slice(2);\n  // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n  yargs(rawArgv)\n    .usage('Usage: $0 <command> [options]')\n\n    .example('$0 init', `\\tInitialize Snap package from scratch`)\n    .example(\n      '$0 build -s src/index.js -d out',\n      `\\tBuild 'src/index.js' as './out/bundle.js'`,\n    )\n    .example(\n      '$0 build -s src/index.js -d out -n snap.js',\n      `\\tBuild 'src/index.js' as './out/snap.js'`,\n    )\n    .example('$0 serve -r out', `\\tServe files in './out' on port 8080`)\n    .example('$0 serve -r out -p 9000', `\\tServe files in './out' on port 9000`)\n    .example(\n      '$0 watch -s src/index.js -d out',\n      `\\tRebuild './out/bundle.js' on changes to files in 'src/index.js' parent and child directories`,\n    )\n\n    .command(commands)\n\n    .option('verboseErrors', builders.verboseErrors)\n\n    .option('suppressWarnings', builders.suppressWarnings)\n\n    .strict()\n\n    // Typecast: The @types/yargs type for .middleware is incorrect.\n    // yargs middleware functions receive the yargs instance as a second parameter.\n    // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation\n    .middleware(\n      ((yargsArgv: Arguments, yargsInstance: typeof yargsType) => {\n        applyConfig(rawArgv, yargsArgv, yargsInstance);\n        setSnapGlobals(yargsArgv);\n        sanitizeInputs(yargsArgv);\n      }) as any,\n      true,\n    )\n\n    .fail((msg: string, err: Error, _yargs) => {\n      console.error(msg || err.message);\n      if (err?.stack && global.snaps.verboseErrors) {\n        console.error(err.stack);\n      }\n      process.exitCode = 1;\n    })\n\n    .demandCommand(1, 'You must specify at least one command.')\n\n    .help()\n    .alias('help', 'h').argv;\n}\n"]}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AAEzC,0DAAkC;AAClC,mCAKiB;AAEjB,SAAgB,GAAG,CAAC,IAAc,EAAE,QAAa;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,oEAAoE;IACpE,eAAK,CAAC,OAAO,CAAC;SACX,UAAU,CAAC,SAAS,CAAC;SACrB,KAAK,CAAC,+BAA+B,CAAC;SAEtC,OAAO,CAAC,SAAS,EAAE,sDAAsD,CAAC;SAC1E,OAAO,CACN,iCAAiC,EACjC,6CAA6C,CAC9C;SACA,OAAO,CACN,4CAA4C,EAC5C,2CAA2C,CAC5C;SACA,OAAO,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;SACnE,OAAO,CAAC,yBAAyB,EAAE,uCAAuC,CAAC;SAC3E,OAAO,CACN,iCAAiC,EACjC,gGAAgG,CACjG;SAEA,OAAO,CAAC,QAAQ,CAAC;SAEjB,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;SAE/C,MAAM,CAAC,kBAAkB,EAAE,kBAAQ,CAAC,gBAAgB,CAAC;SAErD,MAAM,EAAE;QAET,gEAAgE;QAChE,+EAA+E;QAC/E,0FAA0F;SACzF,UAAU,CACT,CAAC,CAAC,SAAoB,EAAE,aAA+B,EAAE,EAAE;QACzD,mBAAW,CAAC,kBAAU,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC7D,sBAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,sBAAc,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,CAAQ,EACT,IAAI,CACL;SAEA,IAAI,CAAC,CAAC,GAAW,EAAE,GAAU,EAAE,MAAM,EAAE,EAAE;QACxC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,KAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;YAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAC1B;QACD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC;SAED,aAAa,CAAC,CAAC,EAAE,wCAAwC,CAAC;SAE1D,IAAI,EAAE;SACN,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;AAC7B,CAAC;AAvDD,kBAuDC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport yargsType from 'yargs/yargs';\nimport builders from './builders';\nimport {\n  applyConfig,\n  loadConfig,\n  sanitizeInputs,\n  setSnapGlobals,\n} from './utils';\n\nexport function cli(argv: string[], commands: any): void {\n  const rawArgv = argv.slice(2);\n  // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n  yargs(rawArgv)\n    .scriptName('mm-snap')\n    .usage('Usage: $0 <command> [options]')\n\n    .example('$0 init', `\\tInitialize a snap project in the current directory`)\n    .example(\n      '$0 build -s src/index.js -d out',\n      `\\tBuild 'src/index.js' as './out/bundle.js'`,\n    )\n    .example(\n      '$0 build -s src/index.js -d out -n snap.js',\n      `\\tBuild 'src/index.js' as './out/snap.js'`,\n    )\n    .example('$0 serve -r out', `\\tServe files in './out' on port 8080`)\n    .example('$0 serve -r out -p 9000', `\\tServe files in './out' on port 9000`)\n    .example(\n      '$0 watch -s src/index.js -d out',\n      `\\tRebuild './out/bundle.js' on changes to files in 'src/index.js' parent and child directories`,\n    )\n\n    .command(commands)\n\n    .option('verboseErrors', builders.verboseErrors)\n\n    .option('suppressWarnings', builders.suppressWarnings)\n\n    .strict()\n\n    // Typecast: The @types/yargs type for .middleware is incorrect.\n    // yargs middleware functions receive the yargs instance as a second parameter.\n    // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation\n    .middleware(\n      ((yargsArgv: Arguments, yargsInstance: typeof yargsType) => {\n        applyConfig(loadConfig(), rawArgv, yargsArgv, yargsInstance);\n        setSnapGlobals(yargsArgv);\n        sanitizeInputs(yargsArgv);\n      }) as any,\n      true,\n    )\n\n    .fail((msg: string, err: Error, _yargs) => {\n      console.error(msg || err.message);\n      if (err?.stack && global.snaps.verboseErrors) {\n        console.error(err.stack);\n      }\n      process.exitCode = 1;\n    })\n\n    .demandCommand(1, 'You must specify at least one command.')\n\n    .help()\n    .alias('help', 'h').argv;\n}\n"]}

package/dist/cmds/build/buildHandler.js

@@ -24,7 +24,7 @@ async function build(argv) {
     await utils_1.validateFilePath(src);
     await utils_1.validateDirPath(dist, true);
     const outfilePath = utils_1.getOutfilePath(dist, outfileName);
-    const result = await bundle_1.bundle(src, outfilePath, argv);
+    const result = await bundle_1.bundle(src, outfilePath, argv, utils_1.loadConfig().bundlerCustomizer);
     if (result && argv.eval) {
         await evalHandler_1.snapEval(Object.assign(Object.assign({}, argv), { bundle: outfilePath }));
     }

package/dist/cmds/build/buildHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildHandler.js","sourceRoot":"","sources":["../../../src/cmds/build/buildHandler.ts"],"names":[],"mappings":";;;AAAA,uCAKqB;AACrB,qDAA+C;AAC/C,iEAA8D;AAE9D,qCAAkC;AAElC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,MAAM,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACpD,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QACvB,MAAM,sBAAQ,iCAAM,IAAI,KAAE,MAAM,EAAE,WAAW,IAAG,CAAC;KAClD;IAED,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,MAAM,iCAAe,CAAC,IAAI,CAAC,CAAC;KAC7B;AACH,CAAC;AAjBD,sBAiBC","sourcesContent":["import {\n  getOutfilePath,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\nimport { snapEval } from '../eval/evalHandler';\nimport { manifestHandler } from '../manifest/manifestHandler';\nimport { YargsArgs } from '../../types/yargs';\nimport { bundle } from './bundle';\n\n/**\n * Builds all files in the given source directory to the given destination\n * directory.\n *\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - argv from Yargs\n * @param argv.src - The source file path\n * @param argv.dist - The output directory path\n * @param argv.outfileName - The output file name\n */\nexport async function build(argv: YargsArgs): Promise<void> {\n  const { src, dist, outfileName } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n  const result = await bundle(src, outfilePath, argv);\n  if (result && argv.eval) {\n    await snapEval({ ...argv, bundle: outfilePath });\n  }\n\n  if (argv.manifest) {\n    await manifestHandler(argv);\n  }\n}\n"]}
+{"version":3,"file":"buildHandler.js","sourceRoot":"","sources":["../../../src/cmds/build/buildHandler.ts"],"names":[],"mappings":";;;AACA,uCAMqB;AACrB,qDAA+C;AAC/C,iEAA8D;AAC9D,qCAAkC;AAElC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,MAAM,eAAM,CACzB,GAAG,EACH,WAAW,EACX,IAAI,EACJ,kBAAU,EAAE,CAAC,iBAAiB,CAC/B,CAAC;IACF,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE;QACvB,MAAM,sBAAQ,iCAAM,IAAI,KAAE,MAAM,EAAE,WAAW,IAAG,CAAC;KAClD;IAED,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,MAAM,iCAAe,CAAC,IAAI,CAAC,CAAC;KAC7B;AACH,CAAC;AAtBD,sBAsBC","sourcesContent":["import { YargsArgs } from '../../types/yargs';\nimport {\n  getOutfilePath,\n  loadConfig,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\nimport { snapEval } from '../eval/evalHandler';\nimport { manifestHandler } from '../manifest/manifestHandler';\nimport { bundle } from './bundle';\n\n/**\n * Builds all files in the given source directory to the given destination\n * directory.\n *\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - argv from Yargs\n * @param argv.src - The source file path\n * @param argv.dist - The output directory path\n * @param argv.outfileName - The output file name\n */\nexport async function build(argv: YargsArgs): Promise<void> {\n  const { src, dist, outfileName } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n  const result = await bundle(\n    src,\n    outfilePath,\n    argv,\n    loadConfig().bundlerCustomizer,\n  );\n  if (result && argv.eval) {\n    await snapEval({ ...argv, bundle: outfilePath });\n  }\n\n  if (argv.manifest) {\n    await manifestHandler(argv);\n  }\n}\n"]}

package/dist/cmds/build/bundle.d.ts

@@ -1,11 +1,13 @@
+import { BrowserifyObject } from 'browserify';
 import { YargsArgs } from '../../types/yargs';
 /**
- * Builds a Snap bundle JSON file from its JavaScript source.
+ * Builds a Snap bundle JS file from its JavaScript source.
  *
- * @param src - The source file path
- * @param dest - The destination file path
- * @param argv - arguments as an object generated by yargs
- * @param argv.sourceMaps - Whether to output sourcemaps
- * @param argv.stripComments - Whether to remove comments from code
+ * @param src - The source file path.
+ * @param dest - The destination file path.
+ * @param argv - arguments as an object generated by yargs.
+ * @param argv.sourceMaps - Whether to output sourcemaps.
+ * @param argv.stripComments - Whether to remove comments from code.
+ * @param argv.transpilationMode - The Babel transpilation mode.
  */
-export declare function bundle(src: string, dest: string, argv: YargsArgs): Promise<boolean>;
+export declare function bundle(src: string, dest: string, argv: YargsArgs, bundlerTransform?: (bundler: BrowserifyObject) => void): Promise<boolean>;

package/dist/cmds/build/bundle.js

@@ -5,44 +5,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bundle = void 0;
 const browserify_1 = __importDefault(require("browserify"));
-const bundleUtils_1 = require("./bundleUtils");
+const builders_1 = require("../../builders");
+const utils_1 = require("./utils");
+// We need to statically import all Browserify transforms and all Babel presets
+// and plugins, and calling `require` is the sanest way to do that.
+/* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */
 /**
- * Builds a Snap bundle JSON file from its JavaScript source.
+ * Builds a Snap bundle JS file from its JavaScript source.
  *
- * @param src - The source file path
- * @param dest - The destination file path
- * @param argv - arguments as an object generated by yargs
- * @param argv.sourceMaps - Whether to output sourcemaps
- * @param argv.stripComments - Whether to remove comments from code
+ * @param src - The source file path.
+ * @param dest - The destination file path.
+ * @param argv - arguments as an object generated by yargs.
+ * @param argv.sourceMaps - Whether to output sourcemaps.
+ * @param argv.stripComments - Whether to remove comments from code.
+ * @param argv.transpilationMode - The Babel transpilation mode.
  */
-function bundle(src, dest, argv) {
-    const { sourceMaps: debug } = argv;
+function bundle(src, dest, argv, bundlerTransform) {
+    const { sourceMaps: debug, transpilationMode } = argv;
+    const babelifyOptions = utils_1.processDependencies(argv);
     return new Promise((resolve, _reject) => {
-        const bundleStream = bundleUtils_1.createBundleStream(dest);
-        browserify_1.default(src, { debug })
-            .transform('babelify', {
-            presets: [
-                [
-                    '@babel/preset-env',
-                    {
-                        targets: {
-                            browsers: ['chrome >= 66', 'firefox >= 68'],
+        const bundler = browserify_1.default(src, { debug });
+        if (transpilationMode !== builders_1.TranspilationModes.none) {
+            bundler.transform(require('babelify'), Object.assign({ global: transpilationMode === builders_1.TranspilationModes.localAndDeps, presets: [
+                    [
+                        require('@babel/preset-env'),
+                        {
+                            targets: {
+                                browsers: ['chrome >= 66', 'firefox >= 68'],
+                            },
                         },
-                    },
-                ],
-            ],
-            plugins: [
-                '@babel/plugin-transform-runtime',
-                '@babel/plugin-proposal-class-properties',
-                '@babel/plugin-proposal-object-rest-spread',
-                '@babel/plugin-proposal-optional-chaining',
-                '@babel/plugin-proposal-nullish-coalescing-operator',
-            ],
-        })
-            .bundle(async (bundleError, bundleBuffer) => await bundleUtils_1.closeBundleStream({
+                    ],
+                ], plugins: [
+                    require('@babel/plugin-transform-runtime'),
+                    require('@babel/plugin-proposal-class-properties'),
+                    require('@babel/plugin-proposal-object-rest-spread'),
+                    require('@babel/plugin-proposal-optional-chaining'),
+                    require('@babel/plugin-proposal-nullish-coalescing-operator'),
+                ] }, babelifyOptions));
+        }
+        bundlerTransform === null || bundlerTransform === void 0 ? void 0 : bundlerTransform(bundler);
+        bundler.bundle(async (bundleError, bundleBuffer) => await utils_1.writeBundleFile({
             bundleError,
             bundleBuffer,
-            bundleStream,
             src,
             dest,
             resolve,

package/dist/cmds/build/bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../../../src/cmds/build/bundle.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAEpC,+CAAsE;AAEtE;;;;;;;;GAQG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAe;IAEf,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAEnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,MAAM,YAAY,GAAG,gCAAkB,CAAC,IAAI,CAAC,CAAC;QAC9C,oBAAU,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC;aACvB,SAAS,CAAC,UAAU,EAAE;YACrB,OAAO,EAAE;gBACP;oBACE,mBAAmB;oBACnB;wBACE,OAAO,EAAE;4BACP,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;yBAC5C;qBACF;iBACF;aACF;YACD,OAAO,EAAE;gBACP,iCAAiC;gBACjC,yCAAyC;gBACzC,2CAA2C;gBAC3C,0CAA0C;gBAC1C,oDAAoD;aACrD;SACF,CAAC;aACD,MAAM,CACL,KAAK,EAAE,WAAW,EAAE,YAAoB,EAAE,EAAE,CAC1C,MAAM,+BAAiB,CAAC;YACtB,WAAW;YACX,YAAY;YACZ,YAAY;YACZ,GAAG;YACH,IAAI;YACJ,OAAO;YACP,IAAI;SACL,CAAC,CACL,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AA1CD,wBA0CC","sourcesContent":["import browserify from 'browserify';\nimport { YargsArgs } from '../../types/yargs';\nimport { createBundleStream, closeBundleStream } from './bundleUtils';\n\n/**\n * Builds a Snap bundle JSON file from its JavaScript source.\n *\n * @param src - The source file path\n * @param dest - The destination file path\n * @param argv - arguments as an object generated by yargs\n * @param argv.sourceMaps - Whether to output sourcemaps\n * @param argv.stripComments - Whether to remove comments from code\n */\nexport function bundle(\n  src: string,\n  dest: string,\n  argv: YargsArgs,\n): Promise<boolean> {\n  const { sourceMaps: debug } = argv;\n\n  return new Promise((resolve, _reject) => {\n    const bundleStream = createBundleStream(dest);\n    browserify(src, { debug })\n      .transform('babelify', {\n        presets: [\n          [\n            '@babel/preset-env',\n            {\n              targets: {\n                browsers: ['chrome >= 66', 'firefox >= 68'],\n              },\n            },\n          ],\n        ],\n        plugins: [\n          '@babel/plugin-transform-runtime',\n          '@babel/plugin-proposal-class-properties',\n          '@babel/plugin-proposal-object-rest-spread',\n          '@babel/plugin-proposal-optional-chaining',\n          '@babel/plugin-proposal-nullish-coalescing-operator',\n        ],\n      })\n      .bundle(\n        async (bundleError, bundleBuffer: Buffer) =>\n          await closeBundleStream({\n            bundleError,\n            bundleBuffer,\n            bundleStream,\n            src,\n            dest,\n            resolve,\n            argv,\n          }),\n      );\n  });\n}\n"]}
+{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../../../src/cmds/build/bundle.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA0D;AAC1D,6CAAoD;AAEpD,mCAA+D;AAE/D,+EAA+E;AAC/E,mEAAmE;AACnE,mHAAmH;AAEnH;;;;;;;;;GASG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAe,EACf,gBAAsD;IAEtD,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACtD,MAAM,eAAe,GAAG,2BAAmB,CAAC,IAAW,CAAC,CAAC;IACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,MAAM,OAAO,GAAG,oBAAU,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3C,IAAI,iBAAiB,KAAK,6BAAkB,CAAC,IAAI,EAAE;YACjD,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,kBACnC,MAAM,EAAE,iBAAiB,KAAK,6BAAkB,CAAC,YAAY,EAC7D,OAAO,EAAE;oBACP;wBACE,OAAO,CAAC,mBAAmB,CAAC;wBAC5B;4BACE,OAAO,EAAE;gCACP,QAAQ,EAAE,CAAC,cAAc,EAAE,eAAe,CAAC;6BAC5C;yBACF;qBACF;iBACF,EACD,OAAO,EAAE;oBACP,OAAO,CAAC,iCAAiC,CAAC;oBAC1C,OAAO,CAAC,yCAAyC,CAAC;oBAClD,OAAO,CAAC,2CAA2C,CAAC;oBACpD,OAAO,CAAC,0CAA0C,CAAC;oBACnD,OAAO,CAAC,oDAAoD,CAAC;iBAC9D,IACG,eAAuB,EAC3B,CAAC;SACJ;QAED,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAG,OAAO,CAAC,CAAC;QAE5B,OAAO,CAAC,MAAM,CACZ,KAAK,EAAE,WAAW,EAAE,YAAoB,EAAE,EAAE,CAC1C,MAAM,uBAAe,CAAC;YACpB,WAAW;YACX,YAAY;YACZ,GAAG;YACH,IAAI;YACJ,OAAO;YACP,IAAI;SACL,CAAC,CACL,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAhDD,wBAgDC","sourcesContent":["import browserify, { BrowserifyObject } from 'browserify';\nimport { TranspilationModes } from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { writeBundleFile, processDependencies } from './utils';\n\n// We need to statically import all Browserify transforms and all Babel presets\n// and plugins, and calling `require` is the sanest way to do that.\n/* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires, node/global-require */\n\n/**\n * Builds a Snap bundle JS file from its JavaScript source.\n *\n * @param src - The source file path.\n * @param dest - The destination file path.\n * @param argv - arguments as an object generated by yargs.\n * @param argv.sourceMaps - Whether to output sourcemaps.\n * @param argv.stripComments - Whether to remove comments from code.\n * @param argv.transpilationMode - The Babel transpilation mode.\n */\nexport function bundle(\n  src: string,\n  dest: string,\n  argv: YargsArgs,\n  bundlerTransform?: (bundler: BrowserifyObject) => void,\n): Promise<boolean> {\n  const { sourceMaps: debug, transpilationMode } = argv;\n  const babelifyOptions = processDependencies(argv as any);\n  return new Promise((resolve, _reject) => {\n    const bundler = browserify(src, { debug });\n    if (transpilationMode !== TranspilationModes.none) {\n      bundler.transform(require('babelify'), {\n        global: transpilationMode === TranspilationModes.localAndDeps,\n        presets: [\n          [\n            require('@babel/preset-env'),\n            {\n              targets: {\n                browsers: ['chrome >= 66', 'firefox >= 68'],\n              },\n            },\n          ],\n        ],\n        plugins: [\n          require('@babel/plugin-transform-runtime'),\n          require('@babel/plugin-proposal-class-properties'),\n          require('@babel/plugin-proposal-object-rest-spread'),\n          require('@babel/plugin-proposal-optional-chaining'),\n          require('@babel/plugin-proposal-nullish-coalescing-operator'),\n        ],\n        ...(babelifyOptions as any),\n      });\n    }\n\n    bundlerTransform?.(bundler);\n\n    bundler.bundle(\n      async (bundleError, bundleBuffer: Buffer) =>\n        await writeBundleFile({\n          bundleError,\n          bundleBuffer,\n          src,\n          dest,\n          resolve,\n          argv,\n        }),\n    );\n  });\n}\n"]}

package/dist/cmds/build/index.js

@@ -4,20 +4,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const builders_1 = __importDefault(require("../../builders"));
 const buildHandler_1 = require("./buildHandler");
+const utils_1 = require("./utils");
 module.exports = {
     command: ['build', 'b'],
     desc: 'Build Snap from source',
     builder: (yarg) => {
         yarg
-            .option('src', builders_1.default.src)
             .option('dist', builders_1.default.dist)
+            .option('eval', builders_1.default.eval)
+            .option('manifest', builders_1.default.manifest)
             .option('outfileName', builders_1.default.outfileName)
             .option('sourceMaps', builders_1.default.sourceMaps)
+            .option('src', builders_1.default.src)
             .option('stripComments', builders_1.default.stripComments)
-            .option('eval', builders_1.default.eval)
-            .option('manifest', builders_1.default.manifest)
+            .option('transpilationMode', builders_1.default.transpilationMode)
+            .option('depsToTranspile', builders_1.default.depsToTranspile)
+            .option('transformHtmlComments', builders_1.default.transformHtmlComments)
             .option('writeManifest', builders_1.default.writeManifest)
-            .implies('writeManifest', 'manifest');
+            .implies('writeManifest', 'manifest')
+            .implies('depsToTranspile', 'transpilationMode')
+            .middleware((argv) => utils_1.processInvalidTranspilation(argv));
     },
     handler: (argv) => buildHandler_1.build(argv),
 };