@metamask/snaps-cli 0.22.3 → 0.24.0

package/dist/utils/misc.js.map

@@ -1 +1 @@
-{"version":3,"file":"misc.js","sourceRoot":"","sources":["../../src/utils/misc.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA4C;AAC5C,gDAAwB;AACxB,2CAA8C;AAGjC,QAAA,eAAe,GAAG;IAC7B,UAAU;IACV,IAAI;IACJ,kBAAkB;IAClB,SAAS;IACT,MAAM;IACN,SAAS;IACT,OAAO;CACR,CAAC;AAEW,QAAA,WAAW,GAAG,gBAAgB,CAAC;AAE5C,4CAA4C;AAC5C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,KAAK;IACL,GAAG;IACH,MAAM;IACN,GAAG;IACH,QAAQ;IACR,GAAG;IACH,MAAM;IACN,GAAG;CACJ,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,IAAe;IAC5C,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC,EAAE;QAChD,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;KAChC;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;KACjC;IAED,IAAI,IAAA,mBAAW,EAAC,IAAI,EAAE,eAAe,CAAC,EAAE;QACtC,MAAM,CAAC,KAAK,CAAC,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACzE;IAED,IAAI,IAAA,mBAAW,EAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE;QACzC,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,sBAAsB,CACpD,IAAI,CAAC,gBAAgB,CACtB,CAAC;KACH;AACH,CAAC;AAhBD,wCAgBC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,KAAc;IACnD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC9B,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,KAAK,KAAK,MAAM,EAAE;QAC3B,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,KAAK,KAAK,OAAO,EAAE;QAC5B,OAAO,KAAK,CAAC;KACd;IAED,MAAM,IAAI,KAAK,CACb,mEAAmE,KAAK,GAAG,CAC5E,CAAC;AACJ,CAAC;AAZD,wDAYC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAe;IAC5C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAChC,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YACjC,2CAA2C;YAC3C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACtB,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;aACjB;YAED,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC1B,IAAI,CAAC,GAAG,CAAC,GAAG,cAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAW,CAAC,CAAC;aACjD;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAbD,wCAaC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,GAAW,EAAE,GAAW;IAC/C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;QACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KACpB;AACH,CAAC;AALD,4BAKC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,GAAW,EAAE,KAAa;IACnD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;QACzC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,IAAI,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;YACvC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACtB;KACF;AACH,CAAC;AAPD,gCAOC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,GAAW,EACX,GAAU,EACV,YAAqB;IAErB,IAAI,eAAe,GAAG,MAAM,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACzB,eAAe,IAAI,GAAG,CAAC;KACxB;IAED,QAAQ,CAAC,eAAe,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;IACrC,IAAI;QACF,IAAI,YAAY,EAAE;YAChB,MAAM,aAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;SACvC;KACF;IAAC,OAAO,WAAW,EAAE;QACpB,QAAQ,CAAC,GAAG,eAAe,gCAAgC,EAAE,WAAW,CAAC,CAAC;KAC3E;IAED,qCAAqC;IACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE;QAC5B,0EAA0E;QAC1E,qEAAqE;QACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AA1BD,gCA0BC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAC/C,OAAO,UAAU,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAFD,wCAEC","sourcesContent":["import { promises as filesystem } from 'fs';\nimport path from 'path';\nimport { hasProperty } from '@metamask/utils';\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: \"${value}\"`,\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 msg - The error message.\n * @param err - The original error.\n */\nexport function logError(msg: string, err?: Error): void {\n  console.error(msg);\n  if (err && global.snaps.verboseErrors) {\n    console.error(err);\n  }\n}\n\n/**\n * Logs a warning message to console.\n *\n * @param msg - The warning message.\n * @param error - The original error.\n */\nexport function logWarning(msg: string, error?: Error): void {\n  if (msg && !global.snaps.suppressWarnings) {\n    console.warn(msg);\n    if (error && global.snaps.verboseErrors) {\n      console.error(error);\n    }\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 msg - The error message.\n * @param err - The original error.\n * @param destFilePath - The output file path.\n */\nexport async function writeError(\n  prefix: string,\n  msg: string,\n  err: Error,\n  destFilePath?: string,\n): Promise<void> {\n  let processedPrefix = prefix;\n  if (!prefix.endsWith(' ')) {\n    processedPrefix += ' ';\n  }\n\n  logError(processedPrefix + msg, err);\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"]}
+{"version":3,"file":"misc.js","sourceRoot":"","sources":["../../src/utils/misc.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA4C;AAC5C,gDAAwB;AAExB,2CAA8C;AAGjC,QAAA,eAAe,GAAG;IAC7B,UAAU;IACV,IAAI;IACJ,kBAAkB;IAClB,SAAS;IACT,MAAM;IACN,SAAS;IACT,OAAO;CACR,CAAC;AAEW,QAAA,WAAW,GAAG,gBAAgB,CAAC;AAE5C,4CAA4C;AAC5C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,KAAK;IACL,GAAG;IACH,MAAM;IACN,GAAG;IACH,QAAQ;IACR,GAAG;IACH,MAAM;IACN,GAAG;CACJ,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,IAAe;IAC5C,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC,EAAE;QAChD,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;KAChC;SAAM;QACL,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC;KACjC;IAED,IAAI,IAAA,mBAAW,EAAC,IAAI,EAAE,eAAe,CAAC,EAAE;QACtC,MAAM,CAAC,KAAK,CAAC,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACzE;IAED,IAAI,IAAA,mBAAW,EAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE;QACzC,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,sBAAsB,CACpD,IAAI,CAAC,gBAAgB,CACtB,CAAC;KACH;AACH,CAAC;AAhBD,wCAgBC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,KAAc;IACnD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC9B,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,KAAK,KAAK,MAAM,EAAE;QAC3B,OAAO,IAAI,CAAC;KACb;SAAM,IAAI,KAAK,KAAK,OAAO,EAAE;QAC5B,OAAO,KAAK,CAAC;KACd;IAED,MAAM,IAAI,KAAK,CACb,mEAAmE,KAAK,GAAG,CAC5E,CAAC;AACJ,CAAC;AAZD,wDAYC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAe;IAC5C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAChC,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YACjC,2CAA2C;YAC3C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACtB,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;aACjB;YAED,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC1B,IAAI,CAAC,GAAG,CAAC,GAAG,cAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAW,CAAC,CAAC;aACjD;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAbD,wCAaC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,GAAkB,EAAE,GAAW;IACtD,IAAI,GAAG,KAAK,IAAI,EAAE;QAChB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KACpB;IAED,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;QACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KACpB;IAED,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE;QAClE,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACjC;AACH,CAAC;AAZD,4BAYC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,GAAW,EAAE,KAAa;IACnD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE;QACzC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,IAAI,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE;YACvC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACtB;KACF;AACH,CAAC;AAPD,gCAOC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAC9B,MAAc,EACd,GAAW,EACX,GAAU,EACV,YAAqB;IAErB,IAAI,eAAe,GAAG,MAAM,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACzB,eAAe,IAAI,GAAG,CAAC;KACxB;IAED,QAAQ,CAAC,eAAe,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;IACrC,IAAI;QACF,IAAI,YAAY,EAAE;YAChB,MAAM,aAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;SACvC;KACF;IAAC,OAAO,WAAW,EAAE;QACpB,QAAQ,CAAC,GAAG,eAAe,gCAAgC,EAAE,WAAW,CAAC,CAAC;KAC3E;IAED,qCAAqC;IACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE;QAC5B,0EAA0E;QAC1E,qEAAqE;QACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AA1BD,gCA0BC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,UAAkB;IAC/C,OAAO,UAAU,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;AACnD,CAAC;AAFD,wCAEC","sourcesContent":["import { promises as filesystem } from 'fs';\nimport path from 'path';\n\nimport { hasProperty } from '@metamask/utils';\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: \"${value}\"`,\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 msg - The error message.\n * @param err - The original error.\n */\nexport function logError(msg: string | null, err?: Error): void {\n  if (msg !== null) {\n    console.error(msg);\n  }\n\n  if (err && global.snaps.verboseErrors) {\n    console.error(err);\n  }\n\n  if (msg === null && (!err || (err && !global.snaps.verboseErrors))) {\n    console.error('Unknown error.');\n  }\n}\n\n/**\n * Logs a warning message to console.\n *\n * @param msg - The warning message.\n * @param error - The original error.\n */\nexport function logWarning(msg: string, error?: Error): void {\n  if (msg && !global.snaps.suppressWarnings) {\n    console.warn(msg);\n    if (error && global.snaps.verboseErrors) {\n      console.error(error);\n    }\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 msg - The error message.\n * @param err - The original error.\n * @param destFilePath - The output file path.\n */\nexport async function writeError(\n  prefix: string,\n  msg: string,\n  err: Error,\n  destFilePath?: string,\n): Promise<void> {\n  let processedPrefix = prefix;\n  if (!prefix.endsWith(' ')) {\n    processedPrefix += ' ';\n  }\n\n  logError(processedPrefix + msg, err);\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"]}

package/dist/utils/snap-config.d.ts

@@ -2,11 +2,28 @@
 import type browserify from 'browserify';
 import { Arguments } from 'yargs';
 import yargs from 'yargs/yargs';
-/** @see {isSnapConfig} ts-auto-guard:type-guard */
-export declare type SnapConfig = {
-    cliOptions?: Record<string, unknown>;
-    bundlerCustomizer?: (bundler: browserify.BrowserifyObject) => void;
+import { Infer } from 'superstruct';
+export declare type BundleCustomizer = (bundler: browserify.BrowserifyObject) => void;
+export declare const SnapConfigStruct: import("superstruct").Struct<{
+    cliOptions?: Record<string, unknown> | undefined;
+    bundlerCustomizer?: Function | undefined;
+}, {
+    cliOptions: import("superstruct").Struct<Record<string, unknown> | undefined, null>;
+    bundlerCustomizer: import("superstruct").Struct<Function | undefined, null>;
+}>;
+export declare type SnapConfig = Omit<Infer<typeof SnapConfigStruct>, 'bundlerCustomizer'> & {
+    bundlerCustomizer?: BundleCustomizer;
 };
+/**
+ * Check if the given value is a {@link SnapConfig} object. Note that this
+ * function does not check the validity of the `bundleCustomizer` property, as
+ * it is not possible to check the validity of a function in JavaScript.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid {@link SnapConfig} object, `false`
+ * otherwise.
+ */
+export declare function isSnapConfig(value: unknown): value is SnapConfig;
 /**
  * Attempt to load the snap config file (`snap.config.js`). By default will use
  * the cached config, if it was loaded before, and `cached` is `true`. If the

package/dist/utils/snap-config.js

@@ -3,13 +3,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyConfig = exports.loadConfig = void 0;
+exports.applyConfig = exports.loadConfig = exports.isSnapConfig = exports.SnapConfigStruct = void 0;
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@metamask/utils");
 const yargs_parser_1 = __importDefault(require("yargs-parser"));
+const superstruct_1 = require("superstruct");
 const builders_1 = __importDefault(require("../builders"));
 const misc_1 = require("./misc");
-const snap_config___GENERATED__1 = require("./snap-config.__GENERATED__");
+exports.SnapConfigStruct = (0, superstruct_1.object)({
+    cliOptions: (0, superstruct_1.optional)((0, superstruct_1.object)()),
+    bundlerCustomizer: (0, superstruct_1.optional)((0, superstruct_1.func)()),
+});
+/**
+ * Check if the given value is a {@link SnapConfig} object. Note that this
+ * function does not check the validity of the `bundleCustomizer` property, as
+ * it is not possible to check the validity of a function in JavaScript.
+ *
+ * @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);
+}
+exports.isSnapConfig = isSnapConfig;
 let snapConfigCache;
 /**
  * Attempt to load the snap config file (`snap.config.js`). By default will use
@@ -37,7 +54,7 @@ function loadConfig(cached = true) {
         (0, misc_1.logError)(`Error during parsing of ${misc_1.CONFIG_FILE}`, err);
         return process.exit(1);
     }
-    if (!(0, snap_config___GENERATED__1.isSnapConfig)(config)) {
+    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`);
         return process.exit(1);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"snap-config.js","sourceRoot":"","sources":["../../src/utils/snap-config.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2CAA8C;AAG9C,gEAAsC;AAEtC,2DAAmC;AACnC,iCAA+C;AAC/C,0EAA2D;AAQ3D,IAAI,eAAuC,CAAC;AAE5C;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,MAAM,GAAG,IAAI;IACtC,IAAI,eAAe,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE;QACpD,OAAO,eAAe,CAAC;KACxB;IAED,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,iHAAiH;QACjH,MAAM,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAW,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,GAAQ,EAAE;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE;YACnC,eAAe,GAAG,EAAE,CAAC;YACrB,OAAO,eAAe,CAAC;SACxB;QACD,IAAA,eAAQ,EAAC,2BAA2B,kBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,IAAI,CAAC,IAAA,uCAAY,EAAC,MAAM,CAAC,EAAE;QACzB,IAAA,eAAQ,EACN,kBAAkB,kBAAW,mGAAmG,CACjI,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,eAAe,GAAG,MAAM,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AA1BD,gCA0BC;AAED,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,UAAsB,EACtB,WAAqB,EACrB,SAAoB,EACpB,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,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GACpC,aACD,CAAC,UAAU,EAGX,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAA,sBAAU,EAAC,WAAW,EAAE;QAChD,KAAK,EAAE,OAAO;KACf,CAA4B,CAAC;IAC9B,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,mCAAmC;IAE/D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAErD,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE;QAC5C,OAAO,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,GAAG,GAA4B,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;IACjE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,IAAI,IAAA,mBAAW,EAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;YAC9B,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;aAAM;YACL,IAAA,eAAQ,EACN,4DAA4D,GAAG,qBAAqB,kBAAW,uCAAuC,CACvI,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC;AAhDD,kCAgDC","sourcesContent":["import path from 'path';\nimport { hasProperty } from '@metamask/utils';\nimport type browserify from 'browserify';\nimport { Arguments } from 'yargs';\nimport yargsParse from 'yargs-parser';\nimport yargs from 'yargs/yargs';\nimport builders from '../builders';\nimport { CONFIG_FILE, logError } from './misc';\nimport { isSnapConfig } from './snap-config.__GENERATED__';\n\n/** @see {isSnapConfig} ts-auto-guard:type-guard */\nexport type SnapConfig = {\n  cliOptions?: Record<string, unknown>;\n  bundlerCustomizer?: (bundler: browserify.BrowserifyObject) => void;\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 === true) {\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 (err: any) {\n    if (err.code === 'MODULE_NOT_FOUND') {\n      snapConfigCache = {};\n      return snapConfigCache;\n    }\n    logError(`Error during parsing of ${CONFIG_FILE}`, err);\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 cfg: Record<string, unknown> = snapConfig.cliOptions || {};\n  for (const key of Object.keys(cfg)) {\n    if (hasProperty(builders, key)) {\n      if (shouldSetArg(key)) {\n        yargsArgv[key] = cfg[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"]}
+{"version":3,"file":"snap-config.js","sourceRoot":"","sources":["../../src/utils/snap-config.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2CAA8C;AAG9C,gEAAsC;AAEtC,6CAAgE;AAChE,2DAAmC;AACnC,iCAA+C;AAIlC,QAAA,gBAAgB,GAAG,IAAA,oBAAM,EAAC;IACrC,UAAU,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IAC9B,iBAAiB,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,GAAE,CAAC;CACpC,CAAC,CAAC;AASH;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,wBAAgB,CAAC,CAAC;AACrC,CAAC;AAFD,oCAEC;AAED,IAAI,eAAuC,CAAC;AAE5C;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,MAAM,GAAG,IAAI;IACtC,IAAI,eAAe,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE;QACpD,OAAO,eAAe,CAAC;KACxB;IAED,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,iHAAiH;QACjH,MAAM,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAW,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,GAAQ,EAAE;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE;YACnC,eAAe,GAAG,EAAE,CAAC;YACrB,OAAO,eAAe,CAAC;SACxB;QACD,IAAA,eAAQ,EAAC,2BAA2B,kBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;QACzB,IAAA,eAAQ,EACN,kBAAkB,kBAAW,mGAAmG,CACjI,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,eAAe,GAAG,MAAM,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AA1BD,gCA0BC;AAED,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,UAAsB,EACtB,WAAqB,EACrB,SAAoB,EACpB,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,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GACpC,aACD,CAAC,UAAU,EAGX,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAA,sBAAU,EAAC,WAAW,EAAE;QAChD,KAAK,EAAE,OAAO;KACf,CAA4B,CAAC;IAC9B,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,mCAAmC;IAE/D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAErD,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE;QAC5C,OAAO,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,GAAG,GAA4B,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;IACjE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,IAAI,IAAA,mBAAW,EAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;YAC9B,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;aAAM;YACL,IAAA,eAAQ,EACN,4DAA4D,GAAG,qBAAqB,kBAAW,uCAAuC,CACvI,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC;AAhDD,kCAgDC","sourcesContent":["import path from 'path';\nimport { hasProperty } from '@metamask/utils';\nimport type browserify from 'browserify';\nimport { Arguments } from 'yargs';\nimport yargsParse from 'yargs-parser';\nimport yargs from 'yargs/yargs';\nimport { object, optional, func, Infer, is } from 'superstruct';\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 === true) {\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 (err: any) {\n    if (err.code === 'MODULE_NOT_FOUND') {\n      snapConfigCache = {};\n      return snapConfigCache;\n    }\n    logError(`Error during parsing of ${CONFIG_FILE}`, err);\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 cfg: Record<string, unknown> = snapConfig.cliOptions || {};\n  for (const key of Object.keys(cfg)) {\n    if (hasProperty(builders, key)) {\n      if (shouldSetArg(key)) {\n        yargsArgv[key] = cfg[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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-cli",
-  "version": "0.22.3",
+  "version": "0.24.0",
   "description": "A CLI for developing MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -15,18 +15,15 @@
   ],
   "scripts": {
     "shasum": "node ./scripts/computeSnapShasum.js",
-    "build:init-template": "node ./scripts/createInitTemplate.js && yarn prettier --check src/cmds/init/init-template.json",
-    "build:guards": "ts-auto-guard --guard-file-name=__GENERATED__ ./src/utils/snap-config.ts",
-    "build:tsc": "tsc --project ./tsconfig.local.json",
+    "build:tsc": "tsc --project ./tsconfig.build.json",
     "build:chmod": "chmod +x ./dist/main.js",
     "build:readme": "node ./scripts/updateReadme.js",
-    "build": "yarn build:pre-tsc && yarn build:tsc && yarn build:post-tsc",
-    "build:pre-tsc": "yarn build:init-template && yarn build:guards",
+    "build": "yarn build:tsc && yarn build:post-tsc",
     "build:post-tsc": "yarn build:chmod && yarn build:readme",
     "build:clean": "yarn clean && yarn build",
     "build:watch": "tsc-watch --onSuccess 'yarn build:chmod'",
-    "clean": "rimraf '*.tsbuildinfo' 'dist/*' 'src/**/*__GENERATED__*'",
-    "test": "yarn build:init-template && jest",
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
+    "test": "jest && yarn posttest",
     "posttest": "jest-it-up",
     "test:watch": "yarn test --watch",
     "test:ci": "yarn test",
@@ -46,18 +43,16 @@
     "@babel/plugin-transform-runtime": "^7.16.7",
     "@babel/preset-env": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
-    "@metamask/snap-utils": "^0.22.3",
-    "@metamask/snaps-browserify-plugin": "^0.22.3",
-    "@metamask/utils": "^3.1.0",
+    "@metamask/snaps-browserify-plugin": "^0.24.0",
+    "@metamask/snaps-utils": "^0.24.0",
+    "@metamask/utils": "^3.3.1",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
     "chokidar": "^3.5.2",
-    "init-package-json": "^1.10.3",
     "is-url": "^1.2.4",
-    "mkdirp": "^1.0.4",
-    "serve-handler": "^6.1.1",
-    "ses": "^0.15.15",
-    "slash": "^3.0.0",
+    "serve-handler": "^6.1.5",
+    "ses": "^0.17.0",
+    "superstruct": "^0.16.7",
     "yargs": "^16.2.0",
     "yargs-parser": "^20.2.2"
   },
@@ -69,10 +64,8 @@
     "@metamask/eslint-config-nodejs": "^9.0.0",
     "@metamask/eslint-config-typescript": "^9.0.1",
     "@types/browserify": "^12.0.36",
-    "@types/init-package-json": "^1.10.0",
     "@types/is-url": "^1.2.28",
     "@types/jest": "^27.5.1",
-    "@types/mkdirp": "^1.0.2",
     "@types/node": "^14.14.25",
     "@types/rimraf": "^3.0.0",
     "@types/serve-handler": "^6.1.0",
@@ -80,6 +73,7 @@
     "@typescript-eslint/eslint-plugin": "^5.19.0",
     "@typescript-eslint/parser": "^5.19.0",
     "clipboardy": "^2.3.0",
+    "deepmerge": "^4.2.2",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",
@@ -90,10 +84,10 @@
     "execa": "^5.1.1",
     "jest": "^29.0.2",
     "jest-it-up": "^2.0.0",
+    "memfs": "^3.4.10",
     "prettier": "^2.3.2",
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^3.0.2",
-    "ts-auto-guard": "^2.3.0",
     "ts-jest": "^29.0.0",
     "ts-node": "^10.7.0",
     "tsc-watch": "^4.5.0",

package/dist/cmds/init/init-template.json

@@ -1,8 +0,0 @@
-{
-    "html": "<!doctype html>\n<html>\n  <head>\n    <title>Hello, Snaps!</title>\n    <link rel=\"icon\" type=\"image/svg\" href=\"./images/icon.svg\"/>\n  </head>\n\n  <body>\n    <h1>Hello, Snaps!</h1>\n    <details>\n      <summary>Instructions</summary>\n      <ul>\n        <li>First, click \"Connect\". Then, try out the other buttons!</li>\n        <li>Please note that:</li>\n        <ul>\n          <li>\n            The <code>snap.manifest.json</code> and <code>package.json</code> must be located in the server root directory..\n          </li>\n          <li>\n            The Snap bundle must be hosted at the location specified by the <code>location</code> field of <code>snap.manifest.json</code>.\n          </li>\n        </ul>\n      </ul>\n    </details>\n    <br/>\n\n    <button class=\"connect\">Connect</button>\n    <button class=\"sendHello\">Send Hello</button>\n  </body>\n\n  <script>\n    const snapId = `local:${window.location.href}`;\n\n    const connectButton = document.querySelector('button.connect')\n    const sendButton = document.querySelector('button.sendHello')\n\n    connectButton.addEventListener('click', connect)\n    sendButton.addEventListener('click', send)\n\n    // here we get permissions to interact with and install the snap\n    async function connect () {\n      await ethereum.request({\n        method: 'wallet_enable',\n        params: [{\n          wallet_snap: { [snapId]: {} },\n        }]\n      })\n    }\n\n    // here we call the snap's \"hello\" method\n    async function send () {\n      try {\n        const response = await ethereum.request({\n          method: 'wallet_invokeSnap',\n          params: [snapId, {\n            method: 'hello'\n          }]\n        })\n      } catch (err) {\n        console.error(err)\n        alert('Problem happened: ' + err.message || err)\n      }\n    }\n  </script>\n</html>\n",
-    "source": "module.exports.onRpcRequest = async ({ origin, request }) => {\n  switch (request.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${origin}!`,\n            description:\n              'This custom confirmation is just for display purposes.',\n            textAreaContent:\n              'But you can edit the snap source code to make it do something, if you want to!',\n          },\n        ],\n      });\n    default:\n      throw new Error('Method not found.');\n  }\n};\n",
-    "typescriptHtml": "<!doctype html>\n<html>\n  </head>\n    <title>Hello, Snaps!</title>\n    <link rel=\"icon\" type=\"image/svg\" href=\"./images/icon.svg\"/>\n  </head>\n\n  <body>\n    <h1>Hello, Snaps!</h1>\n    <details>\n      <summary>Instructions</summary>\n      <ul>\n        <li>First, click \"Connect\". Then, try out the other buttons!</li>\n        <li>Please note that:</li>\n        <ul>\n          <li>\n            The <code>snap.manifest.json</code> and <code>package.json</code> must be located in the server root directory...\n          </li>\n          <li>\n            The Snap bundle must be hosted at the location specified by the <code>location</code> field of <code>snap.manifest.json</code>.\n          </li>\n        </ul>\n      </ul>\n    </details>\n    <br/>\n\n    <button class=\"connect\">Connect</button>\n    <button class=\"sendHello\">Send Hello</button>\n  </body>\n\n  <script>\n    const snapId = `local:${window.location.href}`;\n\n    const connectButton = document.querySelector('button.connect')\n    const sendButton = document.querySelector('button.sendHello')\n\n    connectButton.addEventListener('click', connect)\n    sendButton.addEventListener('click', send)\n\n    // here we get permissions to interact with and install the snap\n    async function connect () {\n      await ethereum.request({\n        method: 'wallet_enable',\n        params: [{\n          wallet_snap: { [snapId]: {} },\n        }]\n      })\n    }\n\n    // here we call the snap's \"hello\" method\n    async function send () {\n      try {\n        await ethereum.request({\n          method: 'wallet_invokeSnap',\n          params: [snapId, {\n            method: 'hello'\n          }]\n        })\n      } catch (err) {\n        console.error(err)\n        alert('Problem happened: ' + err.message || err)\n      }\n    }\n  </script>\n</html>\n",
-    "typescriptSource": "import { OnRpcRequestHandler } from '@metamask/snap-types';\n\nexport const onRpcRequest: OnRpcRequestHandler = ({ origin, request }) => {\n  switch (request.method) {\n    case 'hello':\n      return wallet.request({\n        method: 'snap_confirm',\n        params: [\n          {\n            prompt: `Hello, ${origin}!`,\n            description:\n              'This custom confirmation is just for display purposes.',\n            textAreaContent:\n              'But you can edit the snap source code to make it do something, if you want to!',\n          },\n        ],\n      });\n    default:\n      throw new Error('Method not found.');\n  }\n};\n",
-    "typescriptConfig": "{\n  \"extends\": \"../../../../tsconfig.packages.json\",\n  \"compilerOptions\": {\n    \"typeRoots\": [\"../../../../node_modules/@types\"]\n  },\n  \"files\": [\"./node_modules/@metamask/snap-types/global.d.ts\"],\n  \"include\": [\"src\"]\n}\n",
-    "icon": "<svg width=\"24\" height=\"25\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M17.037 0H6.975C2.605 0 0 2.617 0 6.987v10.05c0 4.37 2.605 6.975 6.975 6.975h10.05c4.37 0 6.975-2.605 6.975-6.976V6.988C24.012 2.617 21.407 0 17.037 0ZM11.49 17.757c0 .36-.18.684-.492.876a.975.975 0 0 1-.54.156 1.11 1.11 0 0 1-.469-.108l-4.202-2.1a1.811 1.811 0 0 1-.985-1.61v-3.973c0-.36.18-.685.493-.877a1.04 1.04 0 0 1 1.008-.048l4.202 2.101a1.8 1.8 0 0 1 .997 1.609v3.974h-.012Zm-.252-6.423L6.723 8.896a1.045 1.045 0 0 1-.528-.924c0-.384.204-.744.528-.924l4.515-2.438a1.631 1.631 0 0 1 1.524 0l4.515 2.438c.324.18.528.528.528.924s-.204.744-.528.924l-4.515 2.438c-.24.132-.504.192-.768.192a1.54 1.54 0 0 1-.756-.192Zm7.972 3.638c0 .684-.385 1.308-.997 1.608l-4.202 2.101c-.144.072-.3.108-.468.108a.975.975 0 0 1-.54-.156 1.017 1.017 0 0 1-.493-.876v-3.974c0-.684.384-1.309.997-1.609l4.202-2.101a1.04 1.04 0 0 1 1.008.048c.313.192.493.516.493.877v3.974Z\" fill=\"#24272A\"/></svg>"
-}

package/dist/tsconfig.json

@@ -1,8 +0,0 @@
-{
-    "extends": "../tsconfig.test.json",
-    "references": [
-        {
-            "path": "../utils"
-        }
-    ]
-}

package/dist/utils/readline.d.ts

@@ -1,37 +0,0 @@
-/// <reference types="node" />
-import readline from 'readline';
-declare type PromptArgs = {
-    question: string;
-    defaultValue?: string;
-    shouldClose?: boolean;
-    readlineInterface?: readline.Interface;
-};
-/**
- * Open a readline interface, to prompt for user input. Avoid using this
- * function directly. Use the {@link prompt} function instead.
- */
-export declare function openPrompt(): void;
-/**
- * Prompt for user input on the command line. If the prompt isn't open, it will
- * be opened.
- *
- * @param args - The prompt arguments.
- * @param args.question - The question to ask.
- * @param args.defaultValue - The default value to use, if no answer is provided.
- * @param args.shouldClose - Whether to close the readline interface after
- * prompting.
- * @param args.readlineInterface - The readline interface to use. Uses the
- * global readline interface if none provided.
- * @returns The user's input, or the default value if none provided.
- */
-export declare function prompt({ question, defaultValue, shouldClose, readlineInterface, }: PromptArgs): Promise<string>;
-/**
- * Close the readline interface.
- *
- * @param readlineInterface - The readline interface to close. Uses the global
- * readline interface if none provided.
- * @throws If no readline interface is provided, and the global interface isn't
- * open.
- */
-export declare function closePrompt(readlineInterface?: readline.Interface): void;
-export {};

package/dist/utils/readline.js

@@ -1,75 +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.closePrompt = exports.prompt = exports.openPrompt = void 0;
-const readline_1 = __importDefault(require("readline"));
-let singletonReadlineInterface;
-/**
- * Open a readline interface, to prompt for user input. Avoid using this
- * function directly. Use the {@link prompt} function instead.
- */
-function openPrompt() {
-    singletonReadlineInterface = readline_1.default.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-}
-exports.openPrompt = openPrompt;
-/**
- * Prompt for user input on the command line. If the prompt isn't open, it will
- * be opened.
- *
- * @param args - The prompt arguments.
- * @param args.question - The question to ask.
- * @param args.defaultValue - The default value to use, if no answer is provided.
- * @param args.shouldClose - Whether to close the readline interface after
- * prompting.
- * @param args.readlineInterface - The readline interface to use. Uses the
- * global readline interface if none provided.
- * @returns The user's input, or the default value if none provided.
- */
-function prompt({ question, defaultValue, shouldClose, readlineInterface = singletonReadlineInterface, }) {
-    let _readlineInterface = readlineInterface;
-    if (!_readlineInterface) {
-        openPrompt();
-        _readlineInterface = singletonReadlineInterface;
-    }
-    return new Promise((resolve, _reject) => {
-        let queryString = `${question} `;
-        if (defaultValue) {
-            queryString += `(${defaultValue}) `;
-        }
-        _readlineInterface.question(queryString, (answer) => {
-            if (!answer || !answer.trim()) {
-                if (defaultValue !== undefined) {
-                    resolve(defaultValue);
-                }
-            }
-            resolve(answer.trim());
-            if (shouldClose) {
-                _readlineInterface.close();
-            }
-        });
-    });
-}
-exports.prompt = prompt;
-/**
- * Close the readline interface.
- *
- * @param readlineInterface - The readline interface to close. Uses the global
- * readline interface if none provided.
- * @throws If no readline interface is provided, and the global interface isn't
- * open.
- */
-function closePrompt(readlineInterface = singletonReadlineInterface) {
-    if (readlineInterface) {
-        readlineInterface.close();
-    }
-    else {
-        throw new Error('You are attempting to close a non existent prompt.');
-    }
-}
-exports.closePrompt = closePrompt;
-//# sourceMappingURL=readline.js.map

package/dist/utils/readline.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"readline.js","sourceRoot":"","sources":["../../src/utils/readline.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,IAAI,0BAA8C,CAAC;AASnD;;;GAGG;AACH,SAAgB,UAAU;IACxB,0BAA0B,GAAG,kBAAQ,CAAC,eAAe,CAAC;QACpD,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;AACL,CAAC;AALD,gCAKC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,MAAM,CAAC,EACrB,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,iBAAiB,GAAG,0BAA0B,GACnC;IACX,IAAI,kBAAkB,GAAG,iBAAiB,CAAC;IAC3C,IAAI,CAAC,kBAAkB,EAAE;QACvB,UAAU,EAAE,CAAC;QACb,kBAAkB,GAAG,0BAA0B,CAAC;KACjD;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACtC,IAAI,WAAW,GAAG,GAAG,QAAQ,GAAG,CAAC;QACjC,IAAI,YAAY,EAAE;YAChB,WAAW,IAAI,IAAI,YAAY,IAAI,CAAC;SACrC;QAED,kBAAkB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAc,EAAE,EAAE;YAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;gBAC7B,IAAI,YAAY,KAAK,SAAS,EAAE;oBAC9B,OAAO,CAAC,YAAY,CAAC,CAAC;iBACvB;aACF;YACD,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACvB,IAAI,WAAW,EAAE;gBACf,kBAAkB,CAAC,KAAK,EAAE,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA9BD,wBA8BC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,iBAAiB,GAAG,0BAA0B;IAE9C,IAAI,iBAAiB,EAAE;QACrB,iBAAiB,CAAC,KAAK,EAAE,CAAC;KAC3B;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;KACvE;AACH,CAAC;AARD,kCAQC","sourcesContent":["import readline from 'readline';\n\nlet singletonReadlineInterface: readline.Interface;\n\ntype PromptArgs = {\n  question: string;\n  defaultValue?: string;\n  shouldClose?: boolean;\n  readlineInterface?: readline.Interface;\n};\n\n/**\n * Open a readline interface, to prompt for user input. Avoid using this\n * function directly. Use the {@link prompt} function instead.\n */\nexport function openPrompt(): void {\n  singletonReadlineInterface = readline.createInterface({\n    input: process.stdin,\n    output: process.stdout,\n  });\n}\n\n/**\n * Prompt for user input on the command line. If the prompt isn't open, it will\n * be opened.\n *\n * @param args - The prompt arguments.\n * @param args.question - The question to ask.\n * @param args.defaultValue - The default value to use, if no answer is provided.\n * @param args.shouldClose - Whether to close the readline interface after\n * prompting.\n * @param args.readlineInterface - The readline interface to use. Uses the\n * global readline interface if none provided.\n * @returns The user's input, or the default value if none provided.\n */\nexport function prompt({\n  question,\n  defaultValue,\n  shouldClose,\n  readlineInterface = singletonReadlineInterface,\n}: PromptArgs): Promise<string> {\n  let _readlineInterface = readlineInterface;\n  if (!_readlineInterface) {\n    openPrompt();\n    _readlineInterface = singletonReadlineInterface;\n  }\n\n  return new Promise((resolve, _reject) => {\n    let queryString = `${question} `;\n    if (defaultValue) {\n      queryString += `(${defaultValue}) `;\n    }\n\n    _readlineInterface.question(queryString, (answer: string) => {\n      if (!answer || !answer.trim()) {\n        if (defaultValue !== undefined) {\n          resolve(defaultValue);\n        }\n      }\n      resolve(answer.trim());\n      if (shouldClose) {\n        _readlineInterface.close();\n      }\n    });\n  });\n}\n\n/**\n * Close the readline interface.\n *\n * @param readlineInterface - The readline interface to close. Uses the global\n * readline interface if none provided.\n * @throws If no readline interface is provided, and the global interface isn't\n * open.\n */\nexport function closePrompt(\n  readlineInterface = singletonReadlineInterface,\n): void {\n  if (readlineInterface) {\n    readlineInterface.close();\n  } else {\n    throw new Error('You are attempting to close a non existent prompt.');\n  }\n}\n"]}

package/dist/utils/snap-config.__GENERATED__.d.ts

@@ -1,2 +0,0 @@
-import { SnapConfig } from "./snap-config";
-export declare function isSnapConfig(obj: any, _argumentName?: string): obj is SnapConfig;

package/dist/utils/snap-config.__GENERATED__.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSnapConfig = void 0;
-function isSnapConfig(obj, _argumentName) {
-    return ((obj !== null &&
-        typeof obj === "object" ||
-        typeof obj === "function") &&
-        (typeof obj.cliOptions === "undefined" ||
-            (obj.cliOptions !== null &&
-                typeof obj.cliOptions === "object" ||
-                typeof obj.cliOptions === "function") &&
-                Object.entries(obj.cliOptions)
-                    .every(([key, _value]) => (typeof key === "string"))) &&
-        (typeof obj.bundlerCustomizer === "undefined" ||
-            typeof obj.bundlerCustomizer === "function"));
-}
-exports.isSnapConfig = isSnapConfig;
-//# sourceMappingURL=snap-config.__GENERATED__.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"snap-config.__GENERATED__.js","sourceRoot":"","sources":["../../src/utils/snap-config.__GENERATED__.ts"],"names":[],"mappings":";;;AAMA,SAAgB,YAAY,CAAC,GAAQ,EAAE,aAAsB;IACzD,OAAO,CACH,CAAC,GAAG,KAAK,IAAI;QACT,OAAO,GAAG,KAAK,QAAQ;QACvB,OAAO,GAAG,KAAK,UAAU,CAAC;QAC9B,CAAC,OAAO,GAAG,CAAC,UAAU,KAAK,WAAW;YAClC,CAAC,GAAG,CAAC,UAAU,KAAK,IAAI;gBACpB,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;gBAClC,OAAO,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC;gBACzC,MAAM,CAAC,OAAO,CAAM,GAAG,CAAC,UAAU,CAAC;qBAC9B,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC;QAC7D,CAAC,OAAO,GAAG,CAAC,iBAAiB,KAAK,WAAW;YACzC,OAAO,GAAG,CAAC,iBAAiB,KAAK,UAAU,CAAC,CACnD,CAAA;AACL,CAAC;AAdD,oCAcC","sourcesContent":["/*\n * Generated type guards for \"snap-config.ts\".\n * WARNING: Do not manually change this file.\n */\nimport { SnapConfig } from \"./snap-config\";\n\nexport function isSnapConfig(obj: any, _argumentName?: string): obj is SnapConfig {\n    return (\n        (obj !== null &&\n            typeof obj === \"object\" ||\n            typeof obj === \"function\") &&\n        (typeof obj.cliOptions === \"undefined\" ||\n            (obj.cliOptions !== null &&\n                typeof obj.cliOptions === \"object\" ||\n                typeof obj.cliOptions === \"function\") &&\n            Object.entries<any>(obj.cliOptions)\n                .every(([key, _value]) => (typeof key === \"string\"))) &&\n        (typeof obj.bundlerCustomizer === \"undefined\" ||\n            typeof obj.bundlerCustomizer === \"function\")\n    )\n}\n"]}