@metamask/snaps-cli 6.7.0 → 7.1.0

package/CHANGELOG.md

@@ -7,6 +7,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.1.0]
+
+### Added
+
+- Add `sandbox` command to run sandbox tool ([#3306](https://github.com/MetaMask/snaps/pull/3306))
+  - This command allows you to run the Snaps sandbox tool, which is useful for
+    quickly testing and debugging Snaps.
+
+### Changed
+
+- Bump `@metamask/utils` from `11.2.0` to `11.4.0` ([#3232](https://github.com/MetaMask/snaps/pull/3232))
+
+## [7.0.0]
+
+### Changed
+
+- **BREAKING:** Remove deprecated Browserify configuration ([#3313](https://github.com/MetaMask/snaps/pull/3313))
+  - The Browserify bundler is no longer supported. Snaps using the Browserify
+    bundler will need to be migrated to the new configuration format based on
+    Webpack.
+  - The `bundler` option in the Snap configuration file was removed, and the CLI
+    will show an error if it's used in config.
+  - Several command line flags that were used to configure the Browserify
+    bundler were removed.
+    - Use the config file to provide these options instead.
+    - The removed options are:
+      - `--bundle`
+      - `--dist`
+      - `--eval`
+      - `--manifest`
+      - `--outfileName`
+      - `--root`
+      - `--sourceMaps`
+      - `--src`
+      - `--stripComments`
+      - `--suppressWarnings`
+      - `--transpilationMode`
+      - `--depsToTranspile`
+      - `--verboseErrors`
+      - `--writeManifest`
+      - `--serve`
+
 ## [6.7.0]
 
 ### Added
@@ -320,7 +362,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@6.7.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@7.1.0...HEAD
+[7.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@7.0.0...@metamask/snaps-cli@7.1.0
+[7.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@6.7.0...@metamask/snaps-cli@7.0.0
 [6.7.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@6.6.1...@metamask/snaps-cli@6.7.0
 [6.6.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@6.6.0...@metamask/snaps-cli@6.6.1
 [6.6.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-cli@6.5.4...@metamask/snaps-cli@6.6.0

package/README.md

@@ -4,7 +4,7 @@ A CLI for developing MetaMask Snaps.
 
 ## Installation
 
-Use Node.js `16.0.0` or later.
+Use Node.js `18.16.0` or later.
 We recommend [nvm](https://github.com/nvm-sh/nvm) for managing Node.js versions.
 
 Install a dev dependency in your snap project using `yarn` or `npm`:
@@ -21,26 +21,25 @@ Commands:
   mm-snap build     Build snap from source                          [aliases: b]
   mm-snap eval      Attempt to evaluate snap bundle in SES          [aliases: e]
   mm-snap manifest  Validate the snap.manifest.json file            [aliases: m]
+  mm-snap sandbox   Start a sandbox server to interact with the Snap
   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]
-  -c, --config            Path to config file                           [string]
-      --verboseErrors     Display original errors         [deprecated] [boolean]
-      --suppressWarnings  Whether to suppress warnings    [deprecated] [boolean]
-  -h, --help              Show help                                    [boolean]
+      --version  Show version number                                   [boolean]
+  -c, --config   Path to config file                                    [string]
+  -h, --help     Show help                                             [boolean]
 
 Examples:
-  mm-snap build                             Build './src/index.js' as
-                                            './dist/bundle.js'
-  mm-snap build --config                    Build './src/index.js' as
-  ./snap.config.build.ts                    './dist/bundle.js' using the config
-                                            in './snap.config.build.ts'
+  mm-snap build                             Build './src/index.js' as './dist/bu
+                                            ndle.js'
+  mm-snap build --config ./snap.config.bui  Build './src/index.js' as './dist/bu
+  ld.ts                                     ndle.js' using the config in './snap
+                                            .config.build.ts'
   mm-snap manifest --fix                    Check the snap manifest, and fix any
-                                            errors
+                                             errors
   mm-snap watch --port 8000                 The snap input file for changes, and
-                                            serve it on port 8000
+                                             serve it on port 8000
   mm-snap serve --port 8000                 Serve the snap bundle on port 8000
 ```
 
@@ -134,7 +133,6 @@ The file should be placed in the project root directory.
 
 ```javascript
 module.exports = {
-  bundler: 'webpack', // default: 'browserify'
   input: 'src/index.js',
   output: {
     path: 'dist',
@@ -154,7 +152,6 @@ exports a `SnapConfig` type that can be used to type the configuration object.
 import type { SnapConfig } from '@metamask/snaps-cli';
 
 const config: SnapConfig = {
-  bundler: 'webpack', // default: 'browserify'
   input: 'src/index.js',
   output: {
     path: 'dist',
@@ -171,7 +168,6 @@ The configuration file should not be published.
 
 ### Options
 
-- [`bundler`](#bundler)
 - [`input`](#input)
 - [`output`](#output)
   - [`output.path`](#outputpath)
@@ -191,18 +187,6 @@ The configuration file should not be published.
 - [`experimental`](#experimental)
   - [`experimental.wasm`](#experimentalwasm)
 
-#### `bundler`
-
-- Type: `"browserify"` | `"webpack"`
-- Default: `"browserify"`
-
-The bundler to use. The MetaMask Snaps CLI supports both Browserify and
-Webpack. For backwards compatibility, Browserify is the default, but we
-recommend using Webpack. Browserify support will be removed in the future.
-
-This section describes the options for the Webpack bundler. For Browserify,
-refer to the [legacy options](#legacy-options) section.
-
 #### `input`
 
 - Type: `string`
@@ -425,219 +409,3 @@ import program from './program.wasm';
 // Program is initialised synchronously.
 // ...
 ```
-
-### Legacy Options
-
-> **Warning**: Using the Browserify-based build system is deprecated, and will
-> be removed in a future version. Please migrate to the Webpack-based build
-> system.
-
-- [`bundler`](#bundler)
-- [`cliOptions`](#clioptions)
-  - [`cliOptions.bundle`](#clioptionsbundle)
-  - [`cliOptions.dist`](#clioptionsdist)
-  - [`cliOptions.eval`](#clioptionseval)
-  - [`cliOptions.manifest`](#clioptionsmanifest)
-  - [`cliOptions.outfileName`](#clioptionsoutfilename)
-  - [`cliOptions.port`](#clioptionsport)
-  - [`cliOptions.root`](#clioptionsroot)
-  - [`cliOptions.sourceMaps`](#clioptionssourcemaps)
-  - [`cliOptions.src`](#clioptionssrc)
-  - [`cliOptions.stripComments`](#clioptionsstripcomments)
-  - [`cliOptions.transpilationMode`](#clioptionstranspilationmode)
-  - [`cliOptions.depsToTranspile`](#clioptionsdepstotranspile)
-  - [`cliOptions.writeManifest`](#clioptionswritemanifest)
-  - [`cliOptions.serve`](#clioptionsserve)
-  - [`cliOptions.verboseErrors`](#clioptionsverboseerrors)
-  - [`cliOptions.suppressWarnings`](#clioptionssuppresswarnings)
-- [`bundlerCustomizer`](#bundlercustomizer)
-
-#### `bundler`
-
-- Type: `"browserify"` | `"webpack"`
-- Default: `"browserify"`
-
-The bundler to use. The MetaMask Snaps CLI supports both Browserify and
-Webpack. For backwards compatibility, Browserify is the default, but we
-recommend using Webpack. Browserify support will be removed in the future.
-
-This section describes the options for the Browserify bundler. For Webpack,
-refer to the [options](#options) section.
-
-#### `cliOptions`
-
-- Type: `object`
-
-The CLI options. These can be specified using the CLI, but can also be
-specified in the configuration file. For example, the `--port` option can be
-specified in the configuration file as follows:
-
-```ts
-export default {
-  cliOptions: {
-    port: 8081,
-  },
-};
-```
-
-But can also be specified using the CLI:
-
-```bash
-$ mm-snap serve --port 8081
-```
-
-If the same option is specified in both the configuration file and the CLI,
-the CLI option takes precedence.
-
-##### `cliOptions.bundle`
-
-- Type: `string`
-- Default: `dist/bundle.js`
-
-The path to the bundle file. This is where the bundle will be written to.
-
-##### `cliOptions.dist`
-
-- Type: `string`
-- Default: `dist`
-
-The path to the distribution directory. This is where the bundle file will be
-written to, if the `bundle` option is not specified.
-
-##### `cliOptions.eval`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to evaluate the bundle. If `true`, the bundle will be evaluated in the
-MetaMask Snaps runtime, to check for any compatibility issues.
-
-##### `cliOptions.manifest`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to validate the snap manifest. If `true`, the snap manifest will be
-validated, and any errors or warnings will be shown.
-
-##### `cliOptions.outfileName`
-
-- Type: `string`
-- Default: `bundle.js`
-
-The name of the bundle file. This is used to generate the bundle file path,
-using the `dist` option. For example, if `dist` is `dist`, and `outfileName`
-is `bundle.js`, the bundle file path will be `dist/bundle.js`. This option is
-ignored if the `bundle` option is specified.
-
-##### `cliOptions.port`
-
-- Type: `number`
-- Default: `8081`
-
-The port to use for the development server.
-
-##### `cliOptions.root`
-
-- Type: `string`
-- Default: `.`
-
-The root directory. This should be the directory that contains the snap
-manifest, and the `dist` directory. This will be served by the development
-server.
-
-##### `cliOptions.sourceMaps`
-
-- Type: `boolean`
-- Default: `false`
-
-Whether to generate source maps. If `true`, source maps will be generated for
-the bundle.
-
-##### `cliOptions.src`
-
-- Type: `string`
-- Default: `src/index.js`
-
-The path to the entry file. This is the file that will be bundled.
-
-##### `cliOptions.stripComments`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to strip comments from the bundle. If `true`, comments will be stripped
-from the bundle, and the bundle will be minified.
-
-##### `cliOptions.transpilationMode`
-
-- Type: `'localAndDeps' | 'localOnly' | 'none'`
-- Default: `'localOnly'`
-
-The transpilation mode to use. This determines which files will be transpiled
-by Babel. The possible values are:
-
-- `'localAndDeps'`: Transpile all files, including dependencies.
-- `'localOnly'`: Transpile only local files.
-- `'none'`: Do not transpile any files.
-
-##### `cliOptions.depsToTranspile`
-
-- Type: `string[]`
-- Default: `[]`
-
-If `transpilationMode` is `'localAndDeps'`, this option can be used to specify
-which dependencies should be transpiled. This is useful if you want to transpile
-a limited set of dependencies, but not all of them.
-
-##### `cliOptions.writeManifest`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to write the snap manifest. If `true`, the snap manifest will be written
-with any changes made by the CLI, if the manifest is invalid.
-
-##### `cliOptions.serve`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to serve the snap. If `true`, the snap will be served by the development
-server, when running `mm-snap watch`.
-
-##### `cliOptions.suppressWarnings`
-
-- Type: `boolean`
-- Default: `false`
-
-This option exists for backwards compatibility, and is ignored.
-
-##### `cliOptions.verboseErrors`
-
-- Type: `boolean`
-- Default: `false`
-
-This option exists for backwards compatibility, and is ignored.
-
-#### `bundlerCustomizer`
-
-- Type: `(bundler: BrowserifyObject) => void`
-
-A function that customizes the bundler. This function is called after the
-bundler is created, but before the bundle is written to disk. This can be used
-to customize the bundler, for example to add plugins or transforms.
-
-```typescript
-import type { SnapConfig } from '@metamask/snaps-cli';
-import type { BrowserifyObject } from 'browserify';
-
-const config: SnapConfig = {
-  bundlerCustomizer: (bundler: BrowserifyObject) => {
-    // Add the BRFS transform to Browserify.
-    bundler.transform('brfs');
-  },
-};
-
-export default config;
-```

package/dist/builders.cjs

@@ -1,17 +1,15 @@
 "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 = TranspilationModes = {}));
 const builders = {
     analyze: {
         describe: 'Analyze the Snap bundle',
         type: 'boolean',
     },
+    build: {
+        describe: 'Build the Snap bundle',
+        type: 'boolean',
+        default: true,
+    },
     config: {
         alias: 'c',
         describe: 'Path to config file',
@@ -28,33 +26,6 @@ const builders = {
         type: 'string',
         normalize: true,
     },
-    // Deprecated Browserify options.
-    bundle: {
-        alias: 'b',
-        describe: 'Snap bundle file',
-        type: 'string',
-        normalize: true,
-        deprecated: 'Use --input instead.',
-    },
-    dist: {
-        alias: 'd',
-        describe: 'Output directory',
-        type: 'string',
-        normalize: true,
-        deprecated: true,
-    },
-    eval: {
-        alias: 'e',
-        describe: 'Attempt to evaluate Snap bundle in SES',
-        type: 'boolean',
-        deprecated: true,
-    },
-    manifest: {
-        alias: 'm',
-        describe: 'Validate snap.manifest.json',
-        type: 'boolean',
-        deprecated: true,
-    },
     port: {
         alias: 'p',
         describe: 'Local server port for testing',
@@ -66,69 +37,6 @@ const builders = {
             }
             return port;
         },
-        deprecated: true,
-    },
-    outfileName: {
-        alias: 'n',
-        describe: 'Output file name',
-        type: 'string',
-        deprecated: true,
-    },
-    root: {
-        alias: 'r',
-        describe: 'Server root directory',
-        type: 'string',
-        normalize: true,
-        deprecated: true,
-    },
-    sourceMaps: {
-        describe: 'Whether builds include sourcemaps',
-        type: 'boolean',
-        deprecated: true,
-    },
-    src: {
-        alias: 's',
-        describe: 'Source file',
-        type: 'string',
-        normalize: true,
-        deprecated: true,
-    },
-    stripComments: {
-        alias: 'strip',
-        describe: 'Whether to remove code comments from the build output',
-        type: 'boolean',
-        deprecated: true,
-    },
-    suppressWarnings: {
-        type: 'boolean',
-        describe: 'Whether to suppress warnings',
-        deprecated: true,
-    },
-    transpilationMode: {
-        type: 'string',
-        describe: 'Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing',
-        choices: Object.values(TranspilationModes),
-        deprecated: true,
-    },
-    depsToTranspile: {
-        type: 'array',
-        describe: 'Transpile only the listed dependencies.',
-        deprecated: true,
-    },
-    verboseErrors: {
-        type: 'boolean',
-        describe: 'Display original errors',
-        deprecated: true,
-    },
-    writeManifest: {
-        describe: 'Make necessary changes to the snap manifest file',
-        type: 'boolean',
-        deprecated: true,
-    },
-    serve: {
-        describe: 'Serve snap file(s) locally for testing',
-        type: 'boolean',
-        deprecated: true,
     },
 };
 exports.default = builders;

package/dist/builders.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"builders.cjs","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;;AAEA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,mCAAa,CAAA;AACf,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,MAAM,QAAQ,GAAG;IACf,OAAO,EAAE;QACP,QAAQ,EAAE,yBAAyB;QACnC,IAAI,EAAE,SAAS;KAChB;IAED,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,qBAAqB;QAC/B,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IAED,GAAG,EAAE;QACH,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;KAChB;IAED,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,8BAA8B;QACxC,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IAED,iCAAiC;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,sBAAsB;KACnC;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;KACjB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;IAED,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,6BAA6B;QACvC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,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,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QACD,UAAU,EAAE,IAAI;KACjB;IAED,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,kBAAkB;QAC5B,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,IAAI;KACjB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;KACjB;IAED,UAAU,EAAE;QACV,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;IAED,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;KACjB;IAED,aAAa,EAAE;QACb,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,uDAAuD;QACjE,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,8BAA8B;QACxC,UAAU,EAAE,IAAI;KACjB;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EACN,gHAAgH;QAClH,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC;QAC1C,UAAU,EAAE,IAAI;KACjB;IAED,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,yCAAyC;QACnD,UAAU,EAAE,IAAI;KACjB;IAED,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,yBAAyB;QACnC,UAAU,EAAE,IAAI;KACjB;IAED,aAAa,EAAE;QACb,QAAQ,EAAE,kDAAkD;QAC5D,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;IAED,KAAK,EAAE;QACL,QAAQ,EAAE,wCAAwC;QAClD,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI;KACjB;CACmD,CAAC;AAEvD,kBAAe,QAAQ,CAAC","sourcesContent":["import type { Options } from 'yargs';\n\nexport enum TranspilationModes {\n  LocalAndDeps = 'localAndDeps',\n  LocalOnly = 'localOnly',\n  None = 'none',\n}\n\nconst builders = {\n  analyze: {\n    describe: 'Analyze the Snap bundle',\n    type: 'boolean',\n  },\n\n  config: {\n    alias: 'c',\n    describe: 'Path to config file',\n    type: 'string',\n    normalize: true,\n  },\n\n  fix: {\n    describe: 'Attempt to fix snap.manifest.json',\n    type: 'boolean',\n  },\n\n  input: {\n    alias: 'i',\n    describe: 'Snap bundle file to evaluate',\n    type: 'string',\n    normalize: true,\n  },\n\n  // Deprecated Browserify options.\n  bundle: {\n    alias: 'b',\n    describe: 'Snap bundle file',\n    type: 'string',\n    normalize: true,\n    deprecated: 'Use --input instead.',\n  },\n\n  dist: {\n    alias: 'd',\n    describe: 'Output directory',\n    type: 'string',\n    normalize: true,\n    deprecated: true,\n  },\n\n  eval: {\n    alias: 'e',\n    describe: 'Attempt to evaluate Snap bundle in SES',\n    type: 'boolean',\n    deprecated: true,\n  },\n\n  manifest: {\n    alias: 'm',\n    describe: 'Validate snap.manifest.json',\n    type: 'boolean',\n    deprecated: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: \"${String(arg)}\".`);\n      }\n\n      return port;\n    },\n    deprecated: true,\n  },\n\n  outfileName: {\n    alias: 'n',\n    describe: 'Output file name',\n    type: 'string',\n    deprecated: true,\n  },\n\n  root: {\n    alias: 'r',\n    describe: 'Server root directory',\n    type: 'string',\n    normalize: true,\n    deprecated: true,\n  },\n\n  sourceMaps: {\n    describe: 'Whether builds include sourcemaps',\n    type: 'boolean',\n    deprecated: true,\n  },\n\n  src: {\n    alias: 's',\n    describe: 'Source file',\n    type: 'string',\n    normalize: true,\n    deprecated: true,\n  },\n\n  stripComments: {\n    alias: 'strip',\n    describe: 'Whether to remove code comments from the build output',\n    type: 'boolean',\n    deprecated: true,\n  },\n\n  suppressWarnings: {\n    type: 'boolean',\n    describe: 'Whether to suppress warnings',\n    deprecated: true,\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    choices: Object.values(TranspilationModes),\n    deprecated: true,\n  },\n\n  depsToTranspile: {\n    type: 'array',\n    describe: 'Transpile only the listed dependencies.',\n    deprecated: true,\n  },\n\n  verboseErrors: {\n    type: 'boolean',\n    describe: 'Display original errors',\n    deprecated: true,\n  },\n\n  writeManifest: {\n    describe: 'Make necessary changes to the snap manifest file',\n    type: 'boolean',\n    deprecated: true,\n  },\n\n  serve: {\n    describe: 'Serve snap file(s) locally for testing',\n    type: 'boolean',\n    deprecated: true,\n  },\n} as const satisfies Record<string, Readonly<Options>>;\n\nexport default builders;\n"]}
+{"version":3,"file":"builders.cjs","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":";;AAEA,MAAM,QAAQ,GAAG;IACf,OAAO,EAAE;QACP,QAAQ,EAAE,yBAAyB;QACnC,IAAI,EAAE,SAAS;KAChB;IAED,KAAK,EAAE;QACL,QAAQ,EAAE,uBAAuB;QACjC,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IAED,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,qBAAqB;QAC/B,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IAED,GAAG,EAAE;QACH,QAAQ,EAAE,mCAAmC;QAC7C,IAAI,EAAE,SAAS;KAChB;IAED,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,8BAA8B;QACxC,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,+BAA+B;QACzC,IAAI,EAAE,QAAQ;QACd,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,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF;CACmD,CAAC;AAEvD,kBAAe,QAAQ,CAAC","sourcesContent":["import type { Options } from 'yargs';\n\nconst builders = {\n  analyze: {\n    describe: 'Analyze the Snap bundle',\n    type: 'boolean',\n  },\n\n  build: {\n    describe: 'Build the Snap bundle',\n    type: 'boolean',\n    default: true,\n  },\n\n  config: {\n    alias: 'c',\n    describe: 'Path to config file',\n    type: 'string',\n    normalize: true,\n  },\n\n  fix: {\n    describe: 'Attempt to fix snap.manifest.json',\n    type: 'boolean',\n  },\n\n  input: {\n    alias: 'i',\n    describe: 'Snap bundle file to evaluate',\n    type: 'string',\n    normalize: true,\n  },\n\n  port: {\n    alias: 'p',\n    describe: 'Local server port for testing',\n    type: 'number',\n    coerce: (arg: unknown) => {\n      const port = Number.parseInt(String(arg), 10);\n      if (Number.isNaN(port)) {\n        throw new Error(`Invalid port: \"${String(arg)}\".`);\n      }\n\n      return port;\n    },\n  },\n} as const satisfies Record<string, Readonly<Options>>;\n\nexport default builders;\n"]}

package/dist/builders.d.cts

@@ -1,13 +1,13 @@
-export declare enum TranspilationModes {
-    LocalAndDeps = "localAndDeps",
-    LocalOnly = "localOnly",
-    None = "none"
-}
 declare const builders: {
     readonly analyze: {
         readonly describe: "Analyze the Snap bundle";
         readonly type: "boolean";
     };
+    readonly build: {
+        readonly describe: "Build the Snap bundle";
+        readonly type: "boolean";
+        readonly default: true;
+    };
     readonly config: {
         readonly alias: "c";
         readonly describe: "Path to config file";
@@ -24,100 +24,11 @@ declare const builders: {
         readonly type: "string";
         readonly normalize: true;
     };
-    readonly bundle: {
-        readonly alias: "b";
-        readonly describe: "Snap bundle file";
-        readonly type: "string";
-        readonly normalize: true;
-        readonly deprecated: "Use --input instead.";
-    };
-    readonly dist: {
-        readonly alias: "d";
-        readonly describe: "Output directory";
-        readonly type: "string";
-        readonly normalize: true;
-        readonly deprecated: true;
-    };
-    readonly eval: {
-        readonly alias: "e";
-        readonly describe: "Attempt to evaluate Snap bundle in SES";
-        readonly type: "boolean";
-        readonly deprecated: true;
-    };
-    readonly manifest: {
-        readonly alias: "m";
-        readonly describe: "Validate snap.manifest.json";
-        readonly type: "boolean";
-        readonly deprecated: true;
-    };
     readonly port: {
         readonly alias: "p";
         readonly describe: "Local server port for testing";
         readonly type: "number";
         readonly coerce: (arg: unknown) => number;
-        readonly deprecated: true;
-    };
-    readonly outfileName: {
-        readonly alias: "n";
-        readonly describe: "Output file name";
-        readonly type: "string";
-        readonly deprecated: true;
-    };
-    readonly root: {
-        readonly alias: "r";
-        readonly describe: "Server root directory";
-        readonly type: "string";
-        readonly normalize: true;
-        readonly deprecated: true;
-    };
-    readonly sourceMaps: {
-        readonly describe: "Whether builds include sourcemaps";
-        readonly type: "boolean";
-        readonly deprecated: true;
-    };
-    readonly src: {
-        readonly alias: "s";
-        readonly describe: "Source file";
-        readonly type: "string";
-        readonly normalize: true;
-        readonly deprecated: true;
-    };
-    readonly stripComments: {
-        readonly alias: "strip";
-        readonly describe: "Whether to remove code comments from the build output";
-        readonly type: "boolean";
-        readonly deprecated: true;
-    };
-    readonly suppressWarnings: {
-        readonly type: "boolean";
-        readonly describe: "Whether to suppress warnings";
-        readonly deprecated: true;
-    };
-    readonly transpilationMode: {
-        readonly type: "string";
-        readonly describe: "Whether to use Babel to transpile all source code (including dependencies), local source code only, or nothing";
-        readonly choices: TranspilationModes[];
-        readonly deprecated: true;
-    };
-    readonly depsToTranspile: {
-        readonly type: "array";
-        readonly describe: "Transpile only the listed dependencies.";
-        readonly deprecated: true;
-    };
-    readonly verboseErrors: {
-        readonly type: "boolean";
-        readonly describe: "Display original errors";
-        readonly deprecated: true;
-    };
-    readonly writeManifest: {
-        readonly describe: "Make necessary changes to the snap manifest file";
-        readonly type: "boolean";
-        readonly deprecated: true;
-    };
-    readonly serve: {
-        readonly describe: "Serve snap file(s) locally for testing";
-        readonly type: "boolean";
-        readonly deprecated: true;
     };
 };
 export default builders;

package/dist/builders.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"builders.d.cts","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB;IAC5B,YAAY,iBAAiB;IAC7B,SAAS,cAAc;IACvB,IAAI,SAAS;CACd;AAED,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BA4DI,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoF6B,CAAC;AAEvD,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"builders.d.cts","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAmCI,OAAO;;CAS6B,CAAC;AAEvD,eAAe,QAAQ,CAAC"}