@metamask/snaps-cli 0.34.0-flask.1 → 0.35.0-flask.1

package/dist/{utils → esm/utils}/misc.js

@@ -1,23 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trimPathString = exports.writeError = exports.logError = exports.sanitizeInputs = exports.booleanStringToBoolean = exports.setSnapGlobals = exports.CONFIG_FILE = exports.permRequestKeys = void 0;
-const snaps_utils_1 = require("@metamask/snaps-utils");
-const utils_1 = require("@metamask/utils");
-const fs_1 = require("fs");
-const path_1 = __importDefault(require("path"));
-exports.permRequestKeys = [
+import { logError as logErrorUtil } from '@metamask/snaps-utils';
+import { hasProperty } from '@metamask/utils';
+import { promises as filesystem } from 'fs';
+import path from 'path';
+export const permRequestKeys = [
     '@context',
     'id',
     'parentCapability',
     'invoker',
     'date',
     'caveats',
-    'proof',
+    'proof'
 ];
-exports.CONFIG_FILE = 'snap.config.js';
+export const CONFIG_FILE = 'snap.config.js';
 // CLI arguments whose values are file paths
 const pathArguments = new Set([
     'src',
@@ -27,7 +21,7 @@ const pathArguments = new Set([
     'bundle',
     'b',
     'root',
-    'r',
+    'r'
 ]);
 /**
  * Sets global variable snaps which tracks user settings:
@@ -35,22 +29,22 @@ const pathArguments = new Set([
  * warnings.
  *
  * @param argv - Arguments as an object generated by `yargs`.
- */
-function setSnapGlobals(argv) {
-    if (['w', 'watch'].includes(argv._[0])) {
+ */ export function setSnapGlobals(argv) {
+    if ([
+        'w',
+        'watch'
+    ].includes(argv._[0])) {
         global.snaps.isWatching = true;
-    }
-    else {
+    } else {
         global.snaps.isWatching = false;
     }
-    if ((0, utils_1.hasProperty)(argv, 'verboseErrors')) {
+    if (hasProperty(argv, 'verboseErrors')) {
         global.snaps.verboseErrors = booleanStringToBoolean(argv.verboseErrors);
     }
-    if ((0, utils_1.hasProperty)(argv, 'suppressWarnings')) {
+    if (hasProperty(argv, 'suppressWarnings')) {
         global.snaps.suppressWarnings = booleanStringToBoolean(argv.suppressWarnings);
     }
 }
-exports.setSnapGlobals = setSnapGlobals;
 /**
  * Attempts to convert a string to a boolean and throws if the value is invalid.
  *
@@ -58,59 +52,51 @@ exports.setSnapGlobals = setSnapGlobals;
  * @returns `true` if the value is the string `"true"`, `false` if it is the
  * string `"false"`, the value if it is already a boolean, or an error
  * otherwise.
- */
-function booleanStringToBoolean(value) {
+ */ export function booleanStringToBoolean(value) {
     if (typeof value === 'boolean') {
         return value;
-    }
-    else if (value === 'true') {
+    } else if (value === 'true') {
         return true;
-    }
-    else if (value === 'false') {
+    } else if (value === 'false') {
         return false;
     }
     throw new Error(`Expected a boolean or the strings "true" or "false". Received: "${String(value)}"`);
 }
-exports.booleanStringToBoolean = booleanStringToBoolean;
 /**
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.
  *
  * @param argv - Arguments as an object generated by yargs.
- */
-function sanitizeInputs(argv) {
-    Object.keys(argv).forEach((key) => {
+ */ export function sanitizeInputs(argv) {
+    Object.keys(argv).forEach((key)=>{
         if (typeof argv[key] === 'string') {
             // Node's path.normalize() does not do this
             if (argv[key] === './') {
                 argv[key] = '.';
             }
             if (pathArguments.has(key)) {
-                argv[key] = path_1.default.normalize(argv[key]);
+                argv[key] = path.normalize(argv[key]);
             }
         }
     });
 }
-exports.sanitizeInputs = sanitizeInputs;
 /**
  * Logs an error message to console. Logs original error if it exists and
  * the verboseErrors global is true.
  *
  * @param message - The error message.
  * @param error - The original error.
- */
-function logError(message, error) {
+ */ export function logError(message, error) {
     if (message !== null) {
-        (0, snaps_utils_1.logError)(message);
+        logErrorUtil(message);
     }
     if (error && global.snaps.verboseErrors) {
-        (0, snaps_utils_1.logError)(error);
+        logErrorUtil(error);
     }
-    if (message === null && (!error || (error && !global.snaps.verboseErrors))) {
-        (0, snaps_utils_1.logError)('Unknown error.');
+    if (message === null && (!error || error && !global.snaps.verboseErrors)) {
+        logErrorUtil('Unknown error.');
     }
 }
-exports.logError = logError;
 /**
  * Logs an error, attempts to unlink the destination file, and kills the
  * process.
@@ -119,8 +105,7 @@ exports.logError = logError;
  * @param message - The error message.
  * @param error - The original error.
  * @param destFilePath - The output file path.
- */
-async function writeError(prefix, message, error, destFilePath) {
+ */ export async function writeError(prefix, message, error, destFilePath) {
     let processedPrefix = prefix;
     if (!prefix.endsWith(' ')) {
         processedPrefix += ' ';
@@ -128,10 +113,9 @@ async function writeError(prefix, message, error, destFilePath) {
     logError(processedPrefix + message, error);
     try {
         if (destFilePath) {
-            await fs_1.promises.unlink(destFilePath);
+            await filesystem.unlink(destFilePath);
         }
-    }
-    catch (unlinkError) {
+    } catch (unlinkError) {
         logError(`${processedPrefix}Failed to unlink mangled file.`, unlinkError);
     }
     // unless the watcher is active, exit
@@ -141,16 +125,14 @@ async function writeError(prefix, message, error, destFilePath) {
         process.exit(1);
     }
 }
-exports.writeError = writeError;
 /**
  * Trims leading and trailing periods "." and forward slashes "/" from the
  * given path string.
  *
  * @param pathString - The path string to trim.
  * @returns The trimmed path string.
- */
-function trimPathString(pathString) {
+ */ export function trimPathString(pathString) {
     return pathString.replace(/^[./]+|[./]+$/gu, '');
 }
-exports.trimPathString = trimPathString;
+
 //# sourceMappingURL=misc.js.map

package/dist/esm/utils/misc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/misc.ts"],"sourcesContent":["import { logError as logErrorUtil } from '@metamask/snaps-utils';\nimport { hasProperty } from '@metamask/utils';\nimport { promises as filesystem } from 'fs';\nimport path from 'path';\nimport { Arguments } from 'yargs';\n\nexport const permRequestKeys = [\n  '@context',\n  'id',\n  'parentCapability',\n  'invoker',\n  'date',\n  'caveats',\n  'proof',\n];\n\nexport const CONFIG_FILE = 'snap.config.js';\n\n// CLI arguments whose values are file paths\nconst pathArguments = new Set([\n  'src',\n  's',\n  'dist',\n  'd',\n  'bundle',\n  'b',\n  'root',\n  'r',\n]);\n\n/**\n * Sets global variable snaps which tracks user settings:\n * watch mode activation, verbose errors messages, and whether to suppress\n * warnings.\n *\n * @param argv - Arguments as an object generated by `yargs`.\n */\nexport function setSnapGlobals(argv: Arguments) {\n  if (['w', 'watch'].includes(argv._[0] as string)) {\n    global.snaps.isWatching = true;\n  } else {\n    global.snaps.isWatching = false;\n  }\n\n  if (hasProperty(argv, 'verboseErrors')) {\n    global.snaps.verboseErrors = booleanStringToBoolean(argv.verboseErrors);\n  }\n\n  if (hasProperty(argv, 'suppressWarnings')) {\n    global.snaps.suppressWarnings = booleanStringToBoolean(\n      argv.suppressWarnings,\n    );\n  }\n}\n\n/**\n * Attempts to convert a string to a boolean and throws if the value is invalid.\n *\n * @param value - The value to convert to a boolean.\n * @returns `true` if the value is the string `\"true\"`, `false` if it is the\n * string `\"false\"`, the value if it is already a boolean, or an error\n * otherwise.\n */\nexport function booleanStringToBoolean(value: unknown): boolean {\n  if (typeof value === 'boolean') {\n    return value;\n  } else if (value === 'true') {\n    return true;\n  } else if (value === 'false') {\n    return false;\n  }\n\n  throw new Error(\n    `Expected a boolean or the strings \"true\" or \"false\". Received: \"${String(\n      value,\n    )}\"`,\n  );\n}\n\n/**\n * Sanitizes inputs. Currently normalizes \"./\" paths to \".\".\n * Yargs handles other path normalization as specified in builders.\n *\n * @param argv - Arguments as an object generated by yargs.\n */\nexport function sanitizeInputs(argv: Arguments) {\n  Object.keys(argv).forEach((key) => {\n    if (typeof argv[key] === 'string') {\n      // Node's path.normalize() does not do this\n      if (argv[key] === './') {\n        argv[key] = '.';\n      }\n\n      if (pathArguments.has(key)) {\n        argv[key] = path.normalize(argv[key] as string);\n      }\n    }\n  });\n}\n\n/**\n * Logs an error message to console. Logs original error if it exists and\n * the verboseErrors global is true.\n *\n * @param message - The error message.\n * @param error - The original error.\n */\nexport function logError(message: string | null, error?: Error): void {\n  if (message !== null) {\n    logErrorUtil(message);\n  }\n\n  if (error && global.snaps.verboseErrors) {\n    logErrorUtil(error);\n  }\n\n  if (message === null && (!error || (error && !global.snaps.verboseErrors))) {\n    logErrorUtil('Unknown error.');\n  }\n}\n\n/**\n * Logs an error, attempts to unlink the destination file, and kills the\n * process.\n *\n * @param prefix - The message prefix.\n * @param message - The error message.\n * @param error - The original error.\n * @param destFilePath - The output file path.\n */\nexport async function writeError(\n  prefix: string,\n  message: string,\n  error: Error,\n  destFilePath?: string,\n): Promise<void> {\n  let processedPrefix = prefix;\n  if (!prefix.endsWith(' ')) {\n    processedPrefix += ' ';\n  }\n\n  logError(processedPrefix + message, error);\n  try {\n    if (destFilePath) {\n      await filesystem.unlink(destFilePath);\n    }\n  } catch (unlinkError) {\n    logError(`${processedPrefix}Failed to unlink mangled file.`, unlinkError);\n  }\n\n  // unless the watcher is active, exit\n  if (!global.snaps.isWatching) {\n    // TODO(ritave): Remove process exit and change into collapse of functions\n    //               https://github.com/MetaMask/snaps-monorepo/issues/81\n    process.exit(1);\n  }\n}\n\n/**\n * Trims leading and trailing periods \".\" and forward slashes \"/\" from the\n * given path string.\n *\n * @param pathString - The path string to trim.\n * @returns The trimmed path string.\n */\nexport function trimPathString(pathString: string): string {\n  return pathString.replace(/^[./]+|[./]+$/gu, '');\n}\n"],"names":["logError","logErrorUtil","hasProperty","promises","filesystem","path","permRequestKeys","CONFIG_FILE","pathArguments","Set","setSnapGlobals","argv","includes","_","global","snaps","isWatching","verboseErrors","booleanStringToBoolean","suppressWarnings","value","Error","String","sanitizeInputs","Object","keys","forEach","key","has","normalize","message","error","writeError","prefix","destFilePath","processedPrefix","endsWith","unlink","unlinkError","process","exit","trimPathString","pathString","replace"],"mappings":"AAAA,SAASA,YAAYC,YAAY,QAAQ,wBAAwB;AACjE,SAASC,WAAW,QAAQ,kBAAkB;AAC9C,SAASC,YAAYC,UAAU,QAAQ,KAAK;AAC5C,OAAOC,UAAU,OAAO;AAGxB,OAAO,MAAMC,kBAAkB;IAC7B;IACA;IACA;IACA;IACA;IACA;IACA;CACD,CAAC;AAEF,OAAO,MAAMC,cAAc,iBAAiB;AAE5C,4CAA4C;AAC5C,MAAMC,gBAAgB,IAAIC,IAAI;IAC5B;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD;AAED;;;;;;CAMC,GACD,OAAO,SAASC,eAAeC,IAAe;IAC5C,IAAI;QAAC;QAAK;KAAQ,CAACC,QAAQ,CAACD,KAAKE,CAAC,CAAC,EAAE,GAAa;QAChDC,OAAOC,KAAK,CAACC,UAAU,GAAG;IAC5B,OAAO;QACLF,OAAOC,KAAK,CAACC,UAAU,GAAG;IAC5B;IAEA,IAAId,YAAYS,MAAM,kBAAkB;QACtCG,OAAOC,KAAK,CAACE,aAAa,GAAGC,uBAAuBP,KAAKM,aAAa;IACxE;IAEA,IAAIf,YAAYS,MAAM,qBAAqB;QACzCG,OAAOC,KAAK,CAACI,gBAAgB,GAAGD,uBAC9BP,KAAKQ,gBAAgB;IAEzB;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,SAASD,uBAAuBE,KAAc;IACnD,IAAI,OAAOA,UAAU,WAAW;QAC9B,OAAOA;IACT,OAAO,IAAIA,UAAU,QAAQ;QAC3B,OAAO;IACT,OAAO,IAAIA,UAAU,SAAS;QAC5B,OAAO;IACT;IAEA,MAAM,IAAIC,MACR,CAAC,gEAAgE,EAAEC,OACjEF,OACA,CAAC,CAAC;AAER;AAEA;;;;;CAKC,GACD,OAAO,SAASG,eAAeZ,IAAe;IAC5Ca,OAAOC,IAAI,CAACd,MAAMe,OAAO,CAAC,CAACC;QACzB,IAAI,OAAOhB,IAAI,CAACgB,IAAI,KAAK,UAAU;YACjC,2CAA2C;YAC3C,IAAIhB,IAAI,CAACgB,IAAI,KAAK,MAAM;gBACtBhB,IAAI,CAACgB,IAAI,GAAG;YACd;YAEA,IAAInB,cAAcoB,GAAG,CAACD,MAAM;gBAC1BhB,IAAI,CAACgB,IAAI,GAAGtB,KAAKwB,SAAS,CAAClB,IAAI,CAACgB,IAAI;YACtC;QACF;IACF;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAAS3B,SAAS8B,OAAsB,EAAEC,KAAa;IAC5D,IAAID,YAAY,MAAM;QACpB7B,aAAa6B;IACf;IAEA,IAAIC,SAASjB,OAAOC,KAAK,CAACE,aAAa,EAAE;QACvChB,aAAa8B;IACf;IAEA,IAAID,YAAY,QAAS,CAAA,CAACC,SAAUA,SAAS,CAACjB,OAAOC,KAAK,CAACE,aAAa,GAAI;QAC1EhB,aAAa;IACf;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAe+B,WACpBC,MAAc,EACdH,OAAe,EACfC,KAAY,EACZG,YAAqB;IAErB,IAAIC,kBAAkBF;IACtB,IAAI,CAACA,OAAOG,QAAQ,CAAC,MAAM;QACzBD,mBAAmB;IACrB;IAEAnC,SAASmC,kBAAkBL,SAASC;IACpC,IAAI;QACF,IAAIG,cAAc;YAChB,MAAM9B,WAAWiC,MAAM,CAACH;QAC1B;IACF,EAAE,OAAOI,aAAa;QACpBtC,SAAS,CAAC,EAAEmC,gBAAgB,8BAA8B,CAAC,EAAEG;IAC/D;IAEA,qCAAqC;IACrC,IAAI,CAACxB,OAAOC,KAAK,CAACC,UAAU,EAAE;QAC5B,0EAA0E;QAC1E,qEAAqE;QACrEuB,QAAQC,IAAI,CAAC;IACf;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,eAAeC,UAAkB;IAC/C,OAAOA,WAAWC,OAAO,CAAC,mBAAmB;AAC/C"}

package/dist/{utils → esm/utils}/snap-config.js

@@ -1,18 +1,12 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyConfig = exports.loadConfig = exports.isSnapConfig = exports.SnapConfigStruct = void 0;
-const utils_1 = require("@metamask/utils");
-const path_1 = __importDefault(require("path"));
-const superstruct_1 = require("superstruct");
-const yargs_parser_1 = __importDefault(require("yargs-parser"));
-const builders_1 = __importDefault(require("../builders"));
-const misc_1 = require("./misc");
-exports.SnapConfigStruct = (0, superstruct_1.object)({
-    cliOptions: (0, superstruct_1.optional)((0, superstruct_1.object)()),
-    bundlerCustomizer: (0, superstruct_1.optional)((0, superstruct_1.func)()),
+import { hasProperty } from '@metamask/utils';
+import path from 'path';
+import { object, optional, func, is } from 'superstruct';
+import yargsParse from 'yargs-parser';
+import builders from '../builders';
+import { CONFIG_FILE, logError } from './misc';
+export const SnapConfigStruct = object({
+    cliOptions: optional(object()),
+    bundlerCustomizer: optional(func())
 });
 /**
  * Check if the given value is a {@link SnapConfig} object. Note that this
@@ -22,11 +16,9 @@ exports.SnapConfigStruct = (0, superstruct_1.object)({
  * @param value - The value to check.
  * @returns `true` if the value is a valid {@link SnapConfig} object, `false`
  * otherwise.
- */
-function isSnapConfig(value) {
-    return (0, superstruct_1.is)(value, exports.SnapConfigStruct);
+ */ export function isSnapConfig(value) {
+    return is(value, SnapConfigStruct);
 }
-exports.isSnapConfig = isSnapConfig;
 let snapConfigCache;
 /**
  * Attempt to load the snap config file (`snap.config.js`). By default will use
@@ -36,32 +28,29 @@ let snapConfigCache;
  *
  * @param cached - Whether to use the cached config. Defaults to `true`.
  * @returns The snap config.
- */
-function loadConfig(cached = true) {
+ */ export function loadConfig(cached = true) {
     if (snapConfigCache !== undefined && cached) {
         return snapConfigCache;
     }
     let config;
     try {
         // eslint-disable-next-line node/global-require, import/no-dynamic-require, @typescript-eslint/no-require-imports
-        config = require(path_1.default.resolve(process.cwd(), misc_1.CONFIG_FILE));
-    }
-    catch (error) {
+        config = require(path.resolve(process.cwd(), CONFIG_FILE));
+    } catch (error) {
         if (error.code === 'MODULE_NOT_FOUND') {
             snapConfigCache = {};
             return snapConfigCache;
         }
-        (0, misc_1.logError)(`Error during parsing of ${misc_1.CONFIG_FILE}`, error);
+        logError(`Error during parsing of ${CONFIG_FILE}`, error);
         return process.exit(1);
     }
     if (!isSnapConfig(config)) {
-        (0, misc_1.logError)(`Can't validate ${misc_1.CONFIG_FILE}. Ensure it's a proper javascript file and abides with the structure of a snap configuration file`);
+        logError(`Can't validate ${CONFIG_FILE}. Ensure it's a proper javascript file and abides with the structure of a snap configuration file`);
         return process.exit(1);
     }
     snapConfigCache = config;
     return config;
 }
-exports.loadConfig = loadConfig;
 // Note that the below function is necessary because yargs' .config() function
 // leaves much to be desired.
 //
@@ -78,8 +67,7 @@ exports.loadConfig = loadConfig;
  * @param processArgv - The command line arguments, i.e., `process.argv`.
  * @param yargsArgv - The processed `yargs` arguments.
  * @param yargsInstance - An instance of `yargs`.
- */
-function applyConfig(snapConfig, processArgv, yargsArgv, yargsInstance) {
+ */ export function applyConfig(snapConfig, processArgv, yargsArgv, yargsInstance) {
     // Instances of yargs has a number of undocumented functions, including
     // getOptions. This function returns an object with properties "key" and
     // "alias", which specify the options associated with the current command and
@@ -92,26 +80,25 @@ function applyConfig(snapConfig, processArgv, yargsArgv, yargsInstance) {
     // If we set args that aren't valid for the current command, yargs will error
     // during validation.
     const { alias: aliases, key: options } = yargsInstance.getOptions();
-    const parsedProcessArgv = (0, yargs_parser_1.default)(processArgv, {
-        alias: aliases,
+    const parsedProcessArgv = yargsParse(processArgv, {
+        alias: aliases
     });
     delete parsedProcessArgv._; // irrelevant yargs parser artifact
     const commandOptions = new Set(Object.keys(options));
-    const shouldSetArg = (key) => {
-        return commandOptions.has(key) && !(0, utils_1.hasProperty)(parsedProcessArgv, key);
+    const shouldSetArg = (key)=>{
+        return commandOptions.has(key) && !hasProperty(parsedProcessArgv, key);
     };
     const config = snapConfig.cliOptions ?? {};
-    for (const key of Object.keys(config)) {
-        if ((0, utils_1.hasProperty)(builders_1.default, key)) {
+    for (const key of Object.keys(config)){
+        if (hasProperty(builders, key)) {
             if (shouldSetArg(key)) {
                 yargsArgv[key] = config[key];
             }
-        }
-        else {
-            (0, misc_1.logError)(`Error: Encountered unrecognized config property "options.${key}" in config file "${misc_1.CONFIG_FILE}". Remove the property and try again.`);
+        } else {
+            logError(`Error: Encountered unrecognized config property "options.${key}" in config file "${CONFIG_FILE}". Remove the property and try again.`);
             process.exit(1);
         }
     }
 }
-exports.applyConfig = applyConfig;
+
 //# sourceMappingURL=snap-config.js.map

package/dist/esm/utils/snap-config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/snap-config.ts"],"sourcesContent":["import { hasProperty } from '@metamask/utils';\nimport type browserify from 'browserify';\nimport path from 'path';\nimport { object, optional, func, Infer, is } from 'superstruct';\nimport { Arguments } from 'yargs';\nimport yargsParse from 'yargs-parser';\nimport yargs from 'yargs/yargs';\n\nimport builders from '../builders';\nimport { CONFIG_FILE, logError } from './misc';\n\nexport type BundleCustomizer = (bundler: browserify.BrowserifyObject) => void;\n\nexport const SnapConfigStruct = object({\n  cliOptions: optional(object()),\n  bundlerCustomizer: optional(func()),\n});\n\nexport type SnapConfig = Omit<\n  Infer<typeof SnapConfigStruct>,\n  'bundlerCustomizer'\n> & {\n  bundlerCustomizer?: BundleCustomizer;\n};\n\n/**\n * Check if the given value is a {@link SnapConfig} object. Note that this\n * function does not check the validity of the `bundleCustomizer` property, as\n * it is not possible to check the validity of a function in JavaScript.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a valid {@link SnapConfig} object, `false`\n * otherwise.\n */\nexport function isSnapConfig(value: unknown): value is SnapConfig {\n  return is(value, SnapConfigStruct);\n}\n\nlet snapConfigCache: SnapConfig | undefined;\n\n/**\n * Attempt to load the snap config file (`snap.config.js`). By default will use\n * the cached config, if it was loaded before, and `cached` is `true`. If the\n * config file is not found, or the config is invalid, this function will kill\n * the process.\n *\n * @param cached - Whether to use the cached config. Defaults to `true`.\n * @returns The snap config.\n */\nexport function loadConfig(cached = true): SnapConfig {\n  if (snapConfigCache !== undefined && cached) {\n    return snapConfigCache;\n  }\n\n  let config: any;\n  try {\n    // eslint-disable-next-line node/global-require, import/no-dynamic-require, @typescript-eslint/no-require-imports\n    config = require(path.resolve(process.cwd(), CONFIG_FILE));\n  } catch (error: any) {\n    if (error.code === 'MODULE_NOT_FOUND') {\n      snapConfigCache = {};\n      return snapConfigCache;\n    }\n    logError(`Error during parsing of ${CONFIG_FILE}`, error);\n    return process.exit(1);\n  }\n\n  if (!isSnapConfig(config)) {\n    logError(\n      `Can't validate ${CONFIG_FILE}. Ensure it's a proper javascript file and abides with the structure of a snap configuration file`,\n    );\n    return process.exit(1);\n  }\n  snapConfigCache = config;\n  return config;\n}\n\n// Note that the below function is necessary because yargs' .config() function\n// leaves much to be desired.\n//\n// In particular, it will set all properties included in the config file\n// regardless of the command, which fails during validation.\n\n/**\n * Attempts to read configuration options for package.json and the config file,\n * and apply them to argv if they weren't already set.\n *\n * Arguments are only set per the snap-cli config file if they were not specified\n * on the command line.\n *\n * @param snapConfig - The snap config.\n * @param processArgv - The command line arguments, i.e., `process.argv`.\n * @param yargsArgv - The processed `yargs` arguments.\n * @param yargsInstance - An instance of `yargs`.\n */\nexport function applyConfig(\n  snapConfig: SnapConfig,\n  processArgv: string[],\n  yargsArgv: Arguments,\n  yargsInstance: typeof yargs,\n): void {\n  // Instances of yargs has a number of undocumented functions, including\n  // getOptions. This function returns an object with properties \"key\" and\n  // \"alias\", which specify the options associated with the current command and\n  // their aliases, respectively.\n  //\n  // We leverage this to ensure that the config is only applied to args that are\n  // valid for the current command, and that weren't specified by the user on\n  // the command line.\n  //\n  // If we set args that aren't valid for the current command, yargs will error\n  // during validation.\n  const { alias: aliases, key: options } = (\n    yargsInstance as any\n  ).getOptions() as {\n    alias: Record<string, string[]>;\n    key: Record<string, unknown>;\n  };\n\n  const parsedProcessArgv = yargsParse(processArgv, {\n    alias: aliases,\n  }) as Record<string, unknown>;\n  delete parsedProcessArgv._; // irrelevant yargs parser artifact\n\n  const commandOptions = new Set(Object.keys(options));\n\n  const shouldSetArg = (key: string): boolean => {\n    return commandOptions.has(key) && !hasProperty(parsedProcessArgv, key);\n  };\n\n  const config: Record<string, unknown> = snapConfig.cliOptions ?? {};\n  for (const key of Object.keys(config)) {\n    if (hasProperty(builders, key)) {\n      if (shouldSetArg(key)) {\n        yargsArgv[key] = config[key];\n      }\n    } else {\n      logError(\n        `Error: Encountered unrecognized config property \"options.${key}\" in config file \"${CONFIG_FILE}\". Remove the property and try again.`,\n      );\n      process.exit(1);\n    }\n  }\n}\n"],"names":["hasProperty","path","object","optional","func","is","yargsParse","builders","CONFIG_FILE","logError","SnapConfigStruct","cliOptions","bundlerCustomizer","isSnapConfig","value","snapConfigCache","loadConfig","cached","undefined","config","require","resolve","process","cwd","error","code","exit","applyConfig","snapConfig","processArgv","yargsArgv","yargsInstance","alias","aliases","key","options","getOptions","parsedProcessArgv","_","commandOptions","Set","Object","keys","shouldSetArg","has"],"mappings":"AAAA,SAASA,WAAW,QAAQ,kBAAkB;AAE9C,OAAOC,UAAU,OAAO;AACxB,SAASC,MAAM,EAAEC,QAAQ,EAAEC,IAAI,EAASC,EAAE,QAAQ,cAAc;AAEhE,OAAOC,gBAAgB,eAAe;AAGtC,OAAOC,cAAc,cAAc;AACnC,SAASC,WAAW,EAAEC,QAAQ,QAAQ,SAAS;AAI/C,OAAO,MAAMC,mBAAmBR,OAAO;IACrCS,YAAYR,SAASD;IACrBU,mBAAmBT,SAASC;AAC9B,GAAG;AASH;;;;;;;;CAQC,GACD,OAAO,SAASS,aAAaC,KAAc;IACzC,OAAOT,GAAGS,OAAOJ;AACnB;AAEA,IAAIK;AAEJ;;;;;;;;CAQC,GACD,OAAO,SAASC,WAAWC,SAAS,IAAI;IACtC,IAAIF,oBAAoBG,aAAaD,QAAQ;QAC3C,OAAOF;IACT;IAEA,IAAII;IACJ,IAAI;QACF,iHAAiH;QACjHA,SAASC,QAAQnB,KAAKoB,OAAO,CAACC,QAAQC,GAAG,IAAIf;IAC/C,EAAE,OAAOgB,OAAY;QACnB,IAAIA,MAAMC,IAAI,KAAK,oBAAoB;YACrCV,kBAAkB,CAAC;YACnB,OAAOA;QACT;QACAN,SAAS,CAAC,wBAAwB,EAAED,YAAY,CAAC,EAAEgB;QACnD,OAAOF,QAAQI,IAAI,CAAC;IACtB;IAEA,IAAI,CAACb,aAAaM,SAAS;QACzBV,SACE,CAAC,eAAe,EAAED,YAAY,iGAAiG,CAAC;QAElI,OAAOc,QAAQI,IAAI,CAAC;IACtB;IACAX,kBAAkBI;IAClB,OAAOA;AACT;AAEA,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;;;;;;CAWC,GACD,OAAO,SAASQ,YACdC,UAAsB,EACtBC,WAAqB,EACrBC,SAAoB,EACpBC,aAA2B;IAE3B,uEAAuE;IACvE,wEAAwE;IACxE,6EAA6E;IAC7E,+BAA+B;IAC/B,EAAE;IACF,8EAA8E;IAC9E,2EAA2E;IAC3E,oBAAoB;IACpB,EAAE;IACF,6EAA6E;IAC7E,qBAAqB;IACrB,MAAM,EAAEC,OAAOC,OAAO,EAAEC,KAAKC,OAAO,EAAE,GAAG,AACvCJ,cACAK,UAAU;IAKZ,MAAMC,oBAAoB/B,WAAWuB,aAAa;QAChDG,OAAOC;IACT;IACA,OAAOI,kBAAkBC,CAAC,EAAE,mCAAmC;IAE/D,MAAMC,iBAAiB,IAAIC,IAAIC,OAAOC,IAAI,CAACP;IAE3C,MAAMQ,eAAe,CAACT;QACpB,OAAOK,eAAeK,GAAG,CAACV,QAAQ,CAAClC,YAAYqC,mBAAmBH;IACpE;IAEA,MAAMf,SAAkCS,WAAWjB,UAAU,IAAI,CAAC;IAClE,KAAK,MAAMuB,OAAOO,OAAOC,IAAI,CAACvB,QAAS;QACrC,IAAInB,YAAYO,UAAU2B,MAAM;YAC9B,IAAIS,aAAaT,MAAM;gBACrBJ,SAAS,CAACI,IAAI,GAAGf,MAAM,CAACe,IAAI;YAC9B;QACF,OAAO;YACLzB,SACE,CAAC,yDAAyD,EAAEyB,IAAI,kBAAkB,EAAE1B,YAAY,qCAAqC,CAAC;YAExIc,QAAQI,IAAI,CAAC;QACf;IACF;AACF"}

package/dist/{cmds → types/cmds}/build/bundle.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="watchify" />
 import { BrowserifyObject } from 'browserify';
 import { YargsArgs } from '../../types/yargs';
 /**

package/dist/{cmds/serve → types/cmds/build}/index.d.ts

@@ -1,9 +1,9 @@
 import yargs from 'yargs';
 import { YargsArgs } from '../../types/yargs';
-declare const _default: {
+declare const command: {
     command: string[];
     desc: string;
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
-export = _default;
+export default command;

package/dist/{cmds/build → types/cmds/eval}/index.d.ts

@@ -1,9 +1,9 @@
 import yargs from 'yargs';
 import { YargsArgs } from '../../types/yargs';
-declare const _default: {
+declare const command: {
     command: string[];
     desc: string;
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
-export = _default;
+export default command;

package/dist/{cmds → types/cmds}/manifest/index.d.ts

@@ -1,9 +1,9 @@
 import yargs from 'yargs';
 import { YargsArgs } from '../../types/yargs';
-declare const _default: {
+declare const command: {
     command: string[];
     desc: string;
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
-export = _default;
+export default command;

package/dist/{cmds/eval → types/cmds/serve}/index.d.ts

@@ -1,9 +1,9 @@
 import yargs from 'yargs';
 import { YargsArgs } from '../../types/yargs';
-declare const _default: {
+declare const command: {
     command: string[];
     desc: string;
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
-export = _default;
+export default command;

package/dist/types/cmds/watch/index.d.ts

@@ -0,0 +1,9 @@
+import yargs from 'yargs';
+import { YargsArgs } from '../../types/yargs';
+declare const command: {
+    command: string[];
+    desc: string;
+    builder: (yarg: yargs.Argv) => void;
+    handler: (argv: YargsArgs) => Promise<void>;
+};
+export default command;

package/dist/{utils → types/utils}/snap-config.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="watchify" />
 import type browserify from 'browserify';
 import { Infer } from 'superstruct';
 import { Arguments } from 'yargs';

package/package.json

@@ -1,26 +1,61 @@
 {
   "name": "@metamask/snaps-cli",
-  "version": "0.34.0-flask.1",
+  "version": "0.35.0-flask.1",
   "description": "A CLI for developing MetaMask Snaps.",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "license": "ISC",
-  "main": "dist/index.js",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./dist/cjs/*": {
+      "require": "./dist/cjs/*.js",
+      "types": "./dist/types/*.d.ts"
+    },
+    "./dist/esm/*": {
+      "import": "./dist/esm/*.js",
+      "types": "./dist/types/*.d.ts"
+    }
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/types/*"
+      ],
+      "./dist/cjs/*": [
+        "./dist/types/*"
+      ],
+      "./dist/esm/*": [
+        "./dist/types/*"
+      ]
+    }
+  },
   "bin": {
-    "mm-snap": "./dist/main.js"
+    "mm-snap": "./dist/cjs/main.js"
   },
   "files": [
-    "dist/"
+    "dist/cjs/**",
+    "dist/esm/**",
+    "dist/types/**"
   ],
   "scripts": {
-    "shasum": "node ./scripts/computeSnapShasum.js",
-    "build:tsc": "tsc --project ./tsconfig.build.json",
-    "build:chmod": "chmod +x ./dist/main.js",
-    "build:readme": "node ./scripts/updateReadme.js",
-    "build": "yarn build:tsc && yarn build:post-tsc",
+    "build": "yarn build:source && yarn build:types",
+    "build:source": "yarn build:esm && yarn build:cjs",
+    "build:types": "tsc --project tsconfig.build.json",
+    "build:esm": "swc src --out-dir dist/esm --config-file ../../.swcrc.build.json --config module.type=es6",
+    "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:post-tsc": "yarn build:chmod && yarn build:readme",
+    "build:chmod": "chmod +x ./dist/esm/main.js && chmod +x ./dist/cjs/main.js",
+    "build:readme": "node ./scripts/updateReadme.js",
     "build:clean": "yarn clean && yarn build",
     "build:watch": "tsc-watch --onSuccess 'yarn build:chmod'",
     "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
@@ -29,12 +64,13 @@
     "test:watch": "yarn test --watch",
     "test:ci": "yarn test",
     "lint:changelog": "yarn auto-changelog validate",
-    "lint:eslint": "eslint . --cache --ext js,ts",
-    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
-    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
+    "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
-    "publish:preview": "yarn npm publish --tag preview"
+    "publish:preview": "yarn npm publish --tag preview",
+    "lint:ci": "yarn lint"
   },
   "dependencies": {
     "@babel/core": "^7.20.12",
@@ -45,9 +81,9 @@
     "@babel/plugin-transform-runtime": "^7.16.7",
     "@babel/preset-env": "^7.20.12",
     "@babel/preset-typescript": "^7.20.12",
-    "@metamask/snaps-browserify-plugin": "^0.34.0-flask.1",
-    "@metamask/snaps-utils": "^0.34.0-flask.1",
-    "@metamask/utils": "^6.0.0",
+    "@metamask/snaps-browserify-plugin": "^0.35.0-flask.1",
+    "@metamask/snaps-utils": "^0.35.0-flask.1",
+    "@metamask/utils": "^6.0.1",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
     "chokidar": "^3.5.2",
@@ -65,10 +101,13 @@
     "@metamask/eslint-config-jest": "^11.0.0",
     "@metamask/eslint-config-nodejs": "^11.0.1",
     "@metamask/eslint-config-typescript": "^11.0.0",
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "^1.3.66",
+    "@swc/jest": "^0.2.26",
     "@types/browserify": "^12.0.37",
     "@types/is-url": "^1.2.28",
     "@types/jest": "^27.5.1",
-    "@types/node": "^17.0.36",
+    "@types/node": "^20.3.1",
     "@types/rimraf": "^3.0.0",
     "@types/serve-handler": "^6.1.0",
     "@types/yargs": "^17.0.24",
@@ -92,7 +131,6 @@
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
-    "ts-jest": "^29.0.2",
     "ts-node": "^10.9.1",
     "tsc-watch": "^4.5.0",
     "typescript": "~4.8.4"

package/dist/cli.js

@@ -1,51 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cli = void 0;
-const yargs_1 = __importDefault(require("yargs"));
-const builders_1 = __importDefault(require("./builders"));
-const utils_1 = require("./utils");
-/**
- * The main CLI entry point function. This processes the command line args, and
- * runs the appropriate function.
- *
- * @param argv - The raw command line arguments, i.e., `process.argv`.
- * @param commands - The list of commands to use.
- */
-function cli(argv, commands) {
-    const rawArgv = argv.slice(2);
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions, @typescript-eslint/no-floating-promises
-    (0, yargs_1.default)(rawArgv)
-        .scriptName('mm-snap')
-        .usage('Usage: $0 <command> [options]')
-        .example('$0 init', `\tInitialize a snap project in the current directory`)
-        .example('$0 init my-snap', `\tInitialize a snap project in the 'my-snap' 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`)
-        .example('$0 serve -r out -p 9000', `\tServe files in './out' on port 9000`)
-        .example('$0 watch -s src/index.js -d out', `\tRebuild './out/bundle.js' on changes to files in 'src/index.js' parent and child directories`)
-        .command(commands)
-        .option('verboseErrors', builders_1.default.verboseErrors)
-        .option('suppressWarnings', builders_1.default.suppressWarnings)
-        .strict()
-        // Typecast: The @types/yargs type for .middleware is incorrect.
-        // yargs middleware functions receive the yargs instance as a second parameter.
-        // ref: https://yargs.js.org/docs/#api-reference-middlewarecallbacks-applybeforevalidation
-        .middleware(((yargsArgv, yargsInstance) => {
-        (0, utils_1.applyConfig)((0, utils_1.loadConfig)(), rawArgv, yargsArgv, yargsInstance);
-        (0, utils_1.setSnapGlobals)(yargsArgv);
-        (0, utils_1.sanitizeInputs)(yargsArgv);
-    }), true)
-        .fail((message, error, _yargs) => {
-        (0, utils_1.logError)(message, error);
-        process.exitCode = 1;
-    })
-        .demandCommand(1, 'You must specify at least one command.')
-        .help()
-        .alias('help', 'h').argv;
-}
-exports.cli = cli;
-//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyC;AAGzC,0DAAkC;AAClC,mCAMiB;AAEjB;;;;;;GAMG;AACH,SAAgB,GAAG,CAAC,IAAc,EAAE,QAAa;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,6GAA6G;IAC7G,IAAA,eAAK,EAAC,OAAO,CAAC;SACX,UAAU,CAAC,SAAS,CAAC;SACrB,KAAK,CAAC,+BAA+B,CAAC;SAEtC,OAAO,CAAC,SAAS,EAAE,sDAAsD,CAAC;SAC1E,OAAO,CACN,iBAAiB,EACjB,wDAAwD,CACzD;SACA,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,IAAA,mBAAW,EAAC,IAAA,kBAAU,GAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;QAC1B,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAC;IAC5B,CAAC,CAAQ,EACT,IAAI,CACL;SAEA,IAAI,CAAC,CAAC,OAAe,EAAE,KAAY,EAAE,MAAM,EAAE,EAAE;QAC9C,IAAA,gBAAQ,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACzB,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;AAxDD,kBAwDC","sourcesContent":["import yargs, { Arguments } from 'yargs';\nimport yargsType from 'yargs/yargs';\n\nimport builders from './builders';\nimport {\n  applyConfig,\n  loadConfig,\n  sanitizeInputs,\n  setSnapGlobals,\n  logError,\n} from './utils';\n\n/**\n * The main CLI entry point function. This processes the command line args, and\n * runs the appropriate function.\n *\n * @param argv - The raw command line arguments, i.e., `process.argv`.\n * @param commands - The list of commands to use.\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, @typescript-eslint/no-floating-promises\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 init my-snap',\n      `\\tInitialize a snap project in the 'my-snap' directory`,\n    )\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((message: string, error: Error, _yargs) => {\n      logError(message, error);\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"]}