@metamask/snaps-cli 0.7.0 → 0.10.0

package/dist/cmds/watch/index.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 const builders_1 = __importDefault(require("../../builders"));
+const utils_1 = require("../build/utils");
 const watchHandler_1 = require("./watchHandler");
 module.exports = {
     command: ['watch', 'w'],
@@ -10,10 +11,19 @@ module.exports = {
     builder: (yarg) => {
         yarg
             .option('src', builders_1.default.src)
+            .option('eval', builders_1.default.eval)
             .option('dist', builders_1.default.dist)
             .option('outfileName', builders_1.default.outfileName)
             .option('sourceMaps', builders_1.default.sourceMaps)
-            .option('stripComments', builders_1.default.stripComments);
+            .option('stripComments', builders_1.default.stripComments)
+            .option('transformHtmlComments', builders_1.default.transformHtmlComments)
+            .option('transpilationMode', builders_1.default.transpilationMode)
+            .option('depsToTranspile', builders_1.default.depsToTranspile)
+            .option('manifest', builders_1.default.manifest)
+            .option('writeManifest', builders_1.default.writeManifest)
+            .implies('writeManifest', 'manifest')
+            .implies('depsToTranspile', 'transpilationMode')
+            .middleware((argv) => utils_1.processInvalidTranspilation(argv));
     },
     handler: (argv) => watchHandler_1.watch(argv),
 };

package/dist/cmds/watch/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/watch/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,iDAAuC;AAEvC,iBAAS;IACP,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,IAAI,EAAE,sBAAsB;IAC5B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI;aACD,MAAM,CAAC,KAAK,EAAE,kBAAQ,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,aAAa,EAAE,kBAAQ,CAAC,WAAW,CAAC;aAC3C,MAAM,CAAC,YAAY,EAAE,kBAAQ,CAAC,UAAU,CAAC;aACzC,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,oBAAK,CAAC,IAAI,CAAC;CAC1C,CAAC","sourcesContent":["import yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { watch } from './watchHandler';\n\nexport = {\n  command: ['watch', 'w'],\n  desc: 'Build Snap on change',\n  builder: (yarg: yargs.Argv) => {\n    yarg\n      .option('src', builders.src)\n      .option('dist', builders.dist)\n      .option('outfileName', builders.outfileName)\n      .option('sourceMaps', builders.sourceMaps)\n      .option('stripComments', builders.stripComments);\n  },\n  handler: (argv: YargsArgs) => watch(argv),\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/watch/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,0CAA6D;AAC7D,iDAAuC;AAEvC,iBAAS;IACP,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,IAAI,EAAE,sBAAsB;IAC5B,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI;aACD,MAAM,CAAC,KAAK,EAAE,kBAAQ,CAAC,GAAG,CAAC;aAC3B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,aAAa,EAAE,kBAAQ,CAAC,WAAW,CAAC;aAC3C,MAAM,CAAC,YAAY,EAAE,kBAAQ,CAAC,UAAU,CAAC;aACzC,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;aAC/C,MAAM,CAAC,uBAAuB,EAAE,kBAAQ,CAAC,qBAAqB,CAAC;aAC/D,MAAM,CAAC,mBAAmB,EAAE,kBAAQ,CAAC,iBAAiB,CAAC;aACvD,MAAM,CAAC,iBAAiB,EAAE,kBAAQ,CAAC,eAAe,CAAC;aACnD,MAAM,CAAC,UAAU,EAAE,kBAAQ,CAAC,QAAQ,CAAC;aACrC,MAAM,CAAC,eAAe,EAAE,kBAAQ,CAAC,aAAa,CAAC;aAC/C,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC;aACpC,OAAO,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;aAC/C,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mCAA2B,CAAC,IAAW,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,oBAAK,CAAC,IAAI,CAAC;CAC1C,CAAC","sourcesContent":["import yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { processInvalidTranspilation } from '../build/utils';\nimport { watch } from './watchHandler';\n\nexport = {\n  command: ['watch', 'w'],\n  desc: 'Build Snap on change',\n  builder: (yarg: yargs.Argv) => {\n    yarg\n      .option('src', builders.src)\n      .option('eval', builders.eval)\n      .option('dist', builders.dist)\n      .option('outfileName', builders.outfileName)\n      .option('sourceMaps', builders.sourceMaps)\n      .option('stripComments', builders.stripComments)\n      .option('transformHtmlComments', builders.transformHtmlComments)\n      .option('transpilationMode', builders.transpilationMode)\n      .option('depsToTranspile', builders.depsToTranspile)\n      .option('manifest', builders.manifest)\n      .option('writeManifest', builders.writeManifest)\n      .implies('writeManifest', 'manifest')\n      .implies('depsToTranspile', 'transpilationMode')\n      .middleware((argv) => processInvalidTranspilation(argv as any));\n  },\n  handler: (argv: YargsArgs) => watch(argv),\n};\n"]}

package/dist/cmds/watch/watchHandler.js

@@ -5,8 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watch = void 0;
 const chokidar_1 = __importDefault(require("chokidar"));
-const bundle_1 = require("../build/bundle");
 const utils_1 = require("../../utils");
+const bundle_1 = require("../build/bundle");
+const evalHandler_1 = require("../eval/evalHandler");
+const manifestHandler_1 = require("../manifest/manifestHandler");
 /**
  * Watch a directory and its subdirectories for changes, and build when files
  * are added or changed.
@@ -20,7 +22,7 @@ const utils_1 = require("../../utils");
  * @param argv.'outfileName' - The output file name
  */
 async function watch(argv) {
-    const { src, dist, outfileName } = argv;
+    const { dist, eval: shouldEval, manifest, outfileName, src } = argv;
     if (outfileName) {
         utils_1.validateOutfileName(outfileName);
     }
@@ -28,7 +30,27 @@ async function watch(argv) {
     await utils_1.validateDirPath(dist, true);
     const rootDir = src.indexOf('/') === -1 ? '.' : src.substring(0, src.lastIndexOf('/') + 1);
     const outfilePath = utils_1.getOutfilePath(dist, outfileName);
-    const watcher = chokidar_1.default.watch(rootDir, {
+    const buildSnap = async (path, logMessage) => {
+        if (logMessage !== undefined) {
+            console.log(logMessage);
+        }
+        try {
+            await bundle_1.bundle(src, outfilePath, argv, utils_1.loadConfig().bundlerCustomizer);
+            if (manifest) {
+                await manifestHandler_1.manifestHandler(argv);
+            }
+            if (shouldEval) {
+                await evalHandler_1.snapEval(Object.assign(Object.assign({}, argv), { bundle: outfilePath }));
+            }
+        }
+        catch (error) {
+            utils_1.logError(`Error ${path === undefined
+                ? 'during initial build'
+                : `while processing "${path}"`}.`, error);
+        }
+    };
+    chokidar_1.default
+        .watch(rootDir, {
         ignoreInitial: true,
         ignored: [
             '**/node_modules/**',
@@ -40,24 +62,15 @@ async function watch(argv) {
             /* istanbul ignore next */
             (str) => str !== '.' && str.startsWith('.'),
         ],
-    });
-    watcher
-        .on('ready', () => {
-        bundle_1.bundle(src, outfilePath, argv);
-    })
-        .on('add', (path) => {
-        console.log(`File added: ${path}`);
-        bundle_1.bundle(src, outfilePath, argv);
-    })
-        .on('change', (path) => {
-        console.log(`File changed: ${path}`);
-        bundle_1.bundle(src, outfilePath, argv);
     })
+        .on('ready', buildSnap)
+        .on('add', (path) => buildSnap(path, `File added: ${path}`))
+        .on('change', (path) => buildSnap(path, `File changed: ${path}`))
         .on('unlink', (path) => console.log(`File removed: ${path}`))
-        .on('error', (err) => {
-        utils_1.logError(`Watcher error: ${err.message}`, err);
-    });
-    watcher.add(`${rootDir}`);
+        .on('error', (error) => {
+        utils_1.logError(`Watcher error: ${error.message}`, error);
+    })
+        .add(rootDir);
     console.log(`Watching '${rootDir}' for changes...`);
 }
 exports.watch = watch;

package/dist/cmds/watch/watchHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchHandler.js","sourceRoot":"","sources":["../../../src/cmds/watch/watchHandler.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,4CAAyC;AACzC,uCAMqB;AAErB;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACxC,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,kBAAQ,CAAC,KAAK,CAAC,OAAO,EAAE;QACtC,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,oBAAoB;YACpB,MAAM,IAAI,KAAK;YACf,YAAY;YACZ,aAAa;YACb,cAAc;YACd,cAAc;YACd,0BAA0B;YAC1B,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;SACpD;KACF,CAAC,CAAC;IAEH,OAAO;SACJ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QAChB,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;QAC1B,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC;QACnC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE;QAC7B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;QACrC,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC;SACD,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;SACpE,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;QAC1B,gBAAQ,CAAC,kBAAkB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEL,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1B,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,kBAAkB,CAAC,CAAC;AACtD,CAAC;AA5CD,sBA4CC","sourcesContent":["import chokidar from 'chokidar';\nimport { YargsArgs } from '../../types/yargs';\nimport { bundle } from '../build/bundle';\nimport {\n  logError,\n  getOutfilePath,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\n\n/**\n * Watch a directory and its subdirectories for changes, and build when files\n * are added or changed.\n *\n * Ignores 'node_modules' and dotfiles.\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - arguments as an object generated by yargs\n * @param argv.src - The source file path\n * @param argv.dist - The output directory path\n * @param argv.'outfileName' - The output file name\n */\nexport async function watch(argv: YargsArgs): Promise<void> {\n  const { src, dist, outfileName } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n  const rootDir =\n    src.indexOf('/') === -1 ? '.' : src.substring(0, src.lastIndexOf('/') + 1);\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n\n  const watcher = chokidar.watch(rootDir, {\n    ignoreInitial: true,\n    ignored: [\n      '**/node_modules/**',\n      `**/${dist}/**`,\n      `**/test/**`,\n      `**/tests/**`,\n      `**/*.test.js`,\n      `**/*.test.ts`,\n      /* istanbul ignore next */\n      (str: string) => str !== '.' && str.startsWith('.'),\n    ],\n  });\n\n  watcher\n    .on('ready', () => {\n      bundle(src, outfilePath, argv);\n    })\n    .on('add', (path: string) => {\n      console.log(`File added: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('change', (path: string) => {\n      console.log(`File changed: ${path}`);\n      bundle(src, outfilePath, argv);\n    })\n    .on('unlink', (path: string) => console.log(`File removed: ${path}`))\n    .on('error', (err: Error) => {\n      logError(`Watcher error: ${err.message}`, err);\n    });\n\n  watcher.add(`${rootDir}`);\n  console.log(`Watching '${rootDir}' for changes...`);\n}\n"]}
+{"version":3,"file":"watchHandler.js","sourceRoot":"","sources":["../../../src/cmds/watch/watchHandler.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAEhC,uCAOqB;AACrB,4CAAyC;AACzC,qDAA+C;AAC/C,iEAA8D;AAE9D;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACpE,IAAI,WAAW,EAAE;QACf,2BAAmB,CAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,wBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,uBAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,OAAO,GACX,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7E,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,EAAE,WAAqB,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG,KAAK,EAAE,IAAa,EAAE,UAAmB,EAAE,EAAE;QAC7D,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SACzB;QAED,IAAI;YACF,MAAM,eAAM,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,kBAAU,EAAE,CAAC,iBAAiB,CAAC,CAAC;YAErE,IAAI,QAAQ,EAAE;gBACZ,MAAM,iCAAe,CAAC,IAAI,CAAC,CAAC;aAC7B;YAED,IAAI,UAAU,EAAE;gBACd,MAAM,sBAAQ,iCAAM,IAAI,KAAE,MAAM,EAAE,WAAW,IAAG,CAAC;aAClD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,gBAAQ,CACN,SACE,IAAI,KAAK,SAAS;gBAChB,CAAC,CAAC,sBAAsB;gBACxB,CAAC,CAAC,qBAAqB,IAAI,GAC/B,GAAG,EACH,KAAK,CACN,CAAC;SACH;IACH,CAAC,CAAC;IAEF,kBAAQ;SACL,KAAK,CAAC,OAAO,EAAE;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,oBAAoB;YACpB,MAAM,IAAI,KAAK;YACf,YAAY;YACZ,aAAa;YACb,cAAc;YACd,cAAc;YACd,0BAA0B;YAC1B,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;SACpD;KACF,CAAC;SAED,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC;SACtB,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,IAAI,EAAE,CAAC,CAAC;SAC3D,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,IAAI,EAAE,CAAC,CAAC;SAChE,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;SAC5D,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;QAC5B,gBAAQ,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC,CAAC;SAED,GAAG,CAAC,OAAO,CAAC,CAAC;IAEhB,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,kBAAkB,CAAC,CAAC;AACtD,CAAC;AAhED,sBAgEC","sourcesContent":["import chokidar from 'chokidar';\nimport { YargsArgs } from '../../types/yargs';\nimport {\n  getOutfilePath,\n  loadConfig,\n  logError,\n  validateDirPath,\n  validateFilePath,\n  validateOutfileName,\n} from '../../utils';\nimport { bundle } from '../build/bundle';\nimport { snapEval } from '../eval/evalHandler';\nimport { manifestHandler } from '../manifest/manifestHandler';\n\n/**\n * Watch a directory and its subdirectories for changes, and build when files\n * are added or changed.\n *\n * Ignores 'node_modules' and dotfiles.\n * Creates destination directory if it doesn't exist.\n *\n * @param argv - arguments as an object generated by yargs\n * @param argv.src - The source file path\n * @param argv.dist - The output directory path\n * @param argv.'outfileName' - The output file name\n */\nexport async function watch(argv: YargsArgs): Promise<void> {\n  const { dist, eval: shouldEval, manifest, outfileName, src } = argv;\n  if (outfileName) {\n    validateOutfileName(outfileName as string);\n  }\n  await validateFilePath(src);\n  await validateDirPath(dist, true);\n  const rootDir =\n    src.indexOf('/') === -1 ? '.' : src.substring(0, src.lastIndexOf('/') + 1);\n  const outfilePath = getOutfilePath(dist, outfileName as string);\n\n  const buildSnap = async (path?: string, logMessage?: string) => {\n    if (logMessage !== undefined) {\n      console.log(logMessage);\n    }\n\n    try {\n      await bundle(src, outfilePath, argv, loadConfig().bundlerCustomizer);\n\n      if (manifest) {\n        await manifestHandler(argv);\n      }\n\n      if (shouldEval) {\n        await snapEval({ ...argv, bundle: outfilePath });\n      }\n    } catch (error) {\n      logError(\n        `Error ${\n          path === undefined\n            ? 'during initial build'\n            : `while processing \"${path}\"`\n        }.`,\n        error,\n      );\n    }\n  };\n\n  chokidar\n    .watch(rootDir, {\n      ignoreInitial: true,\n      ignored: [\n        '**/node_modules/**',\n        `**/${dist}/**`,\n        `**/test/**`,\n        `**/tests/**`,\n        `**/*.test.js`,\n        `**/*.test.ts`,\n        /* istanbul ignore next */\n        (str: string) => str !== '.' && str.startsWith('.'),\n      ],\n    })\n\n    .on('ready', buildSnap)\n    .on('add', (path) => buildSnap(path, `File added: ${path}`))\n    .on('change', (path) => buildSnap(path, `File changed: ${path}`))\n    .on('unlink', (path) => console.log(`File removed: ${path}`))\n    .on('error', (error: Error) => {\n      logError(`Watcher error: ${error.message}`, error);\n    })\n\n    .add(rootDir);\n\n  console.log(`Watching '${rootDir}' for changes...`);\n}\n"]}

package/dist/utils/fs.js

@@ -27,7 +27,7 @@ async function isDirectory(pathString, createDir) {
             }
             catch (mkdirError) {
                 misc_1.logError(`Directory '${pathString}' could not be created.`, mkdirError);
-                process.exit(1);
+                throw mkdirError;
             }
         }
         return false;

package/dist/utils/fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,iCAAkC;AAElC;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,IAAI;gBACF,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,UAAU,EAAE;gBACnB,eAAQ,CAAC,cAAc,UAAU,yBAAyB,EAAE,UAAU,CAAC,CAAC;gBACxE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACF;QACD,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAvBD,kCAuBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AAND,oCAMC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json } from '@metamask/snap-controllers';\nimport { logError } from './misc';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check\n * @param createDir - Whether to create the directory if it doesn't exist\n * @returns - Whether the given path is an existing directory\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      try {\n        await fs.mkdir(pathString);\n        return true;\n      } catch (mkdirError) {\n        logError(`Directory '${pathString}' could not be created.`, mkdirError);\n        process.exit(1);\n      }\n    }\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check\n * @returns Whether the given path is an existing file\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile(pathString: string): Promise<Json> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  return JSON.parse(await fs.readFile(pathString, 'utf8'));\n}\n"]}
+{"version":3,"file":"fs.js","sourceRoot":"","sources":["../../src/utils/fs.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AAEpC,iCAAkC;AAElC;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,UAAkB,EAClB,SAAkB;IAElB,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;KAC5B;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,KAAK,CAAC;aACd;YAED,IAAI;gBACF,MAAM,aAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,UAAU,EAAE;gBACnB,eAAQ,CAAC,cAAc,UAAU,yBAAyB,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,UAAU,CAAC;aAClB;SACF;QACD,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAvBD,kCAuBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,MAAM,CAAC,UAAkB;IAC7C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;KACvB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAAC,UAAkB;IACnD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,CAAC;AAND,oCAMC","sourcesContent":["import { promises as fs } from 'fs';\nimport type { Json } from '@metamask/snap-controllers';\nimport { logError } from './misc';\n\n/**\n * Checks whether the given path string resolves to an existing directory, and\n * optionally creates the directory if it doesn't exist.\n *\n * @param pathString - The path string to check\n * @param createDir - Whether to create the directory if it doesn't exist\n * @returns - Whether the given path is an existing directory\n */\nexport async function isDirectory(\n  pathString: string,\n  createDir: boolean,\n): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isDirectory();\n  } catch (error) {\n    if (error.code === 'ENOENT') {\n      if (!createDir) {\n        return false;\n      }\n\n      try {\n        await fs.mkdir(pathString);\n        return true;\n      } catch (mkdirError) {\n        logError(`Directory '${pathString}' could not be created.`, mkdirError);\n        throw mkdirError;\n      }\n    }\n    return false;\n  }\n}\n\n/**\n * Checks whether the given path string resolves to an existing file.\n *\n * @param pathString - The path string to check\n * @returns Whether the given path is an existing file\n */\nexport async function isFile(pathString: string): Promise<boolean> {\n  try {\n    const stats = await fs.stat(pathString);\n    return stats.isFile();\n  } catch (error) {\n    return false;\n  }\n}\n\n/**\n * Reads a `.json` file, parses its contents, and returns them.\n *\n * @param pathString - The path to the JSON file.\n * @returns The parsed contents of the JSON file.\n */\nexport async function readJsonFile(pathString: string): Promise<Json> {\n  if (!pathString.endsWith('.json')) {\n    throw new Error('The specified file must be a \".json\" file.');\n  }\n\n  return JSON.parse(await fs.readFile(pathString, 'utf8'));\n}\n"]}

package/dist/utils/misc.d.ts

@@ -1,7 +1,7 @@
 import { Arguments } from 'yargs';
 export declare const deepClone: <T>(input: T) => T;
 export declare const permRequestKeys: string[];
-export declare const CONFIG_FILE = "snap.config.json";
+export declare const CONFIG_FILE = "snap.config.js";
 /**
  * Sets global variable snaps which tracks user settings:
  * watch mode activation, verbose errors messages, and whether to suppress warnings.
@@ -9,6 +9,15 @@ export declare const CONFIG_FILE = "snap.config.json";
  * @param argv - arguments as an object generated by yargs
  */
 export declare function setSnapGlobals(argv: Arguments): void;
+/**
+ * Attempts to convert a string to a boolean and throws if the value is invalid.
+ *
+ * @param value - The value to convert to a boolean.
+ * @return `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.
+ */
+export declare function booleanStringToBoolean(value: unknown): boolean;
 /**
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.

package/dist/utils/misc.js

@@ -3,7 +3,7 @@ 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.logWarning = exports.logError = exports.sanitizeInputs = exports.setSnapGlobals = exports.CONFIG_FILE = exports.permRequestKeys = exports.deepClone = void 0;
+exports.trimPathString = exports.writeError = exports.logWarning = exports.logError = exports.sanitizeInputs = exports.booleanStringToBoolean = exports.setSnapGlobals = exports.CONFIG_FILE = exports.permRequestKeys = exports.deepClone = void 0;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const rfdc_1 = __importDefault(require("rfdc"));
@@ -17,7 +17,7 @@ exports.permRequestKeys = [
     'caveats',
     'proof',
 ];
-exports.CONFIG_FILE = 'snap.config.json';
+exports.CONFIG_FILE = 'snap.config.js';
 // CLI arguments whose values are file paths
 const pathArguments = new Set([
     'src',
@@ -43,13 +43,34 @@ function setSnapGlobals(argv) {
         global.snaps.isWatching = false;
     }
     if (Object.prototype.hasOwnProperty.call(argv, 'verboseErrors')) {
-        global.snaps.verboseErrors = Boolean(argv.verboseErrors);
+        global.snaps.verboseErrors = booleanStringToBoolean(argv.verboseErrors);
     }
     if (Object.prototype.hasOwnProperty.call(argv, 'suppressWarnings')) {
-        global.snaps.suppressWarnings = Boolean(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.
+ *
+ * @param value - The value to convert to a boolean.
+ * @return `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) {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    else if (value === 'true') {
+        return true;
+    }
+    else if (value === 'false') {
+        return false;
+    }
+    throw new Error(`Expected a boolean or the strings "true" or "false". Received: "${value}"`);
+}
+exports.booleanStringToBoolean = booleanStringToBoolean;
 /**
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.
@@ -122,6 +143,8 @@ async function writeError(prefix, msg, err, destFilePath) {
     }
     // unless the watcher is active, exit
     if (!global.snaps.isWatching) {
+        // TODO(ritave): Remove process exit and change into collapse of functions
+        //               https://github.com/MetaMask/snaps-skunkworks/issues/81
         process.exit(1);
     }
 }

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,gDAAwB;AAGX,QAAA,SAAS,GAAG,cAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAEnD,QAAA,eAAe,GAAG;IAC7B,UAAU;IACV,IAAI;IACJ,kBAAkB;IAClB,SAAS;IACT,MAAM;IACN,SAAS;IACT,OAAO;CACR,CAAC;AAEW,QAAA,WAAW,GAAG,kBAAkB,CAAC;AAE9C,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;;;;;GAKG;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,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE;QAC/D,MAAM,CAAC,KAAK,CAAC,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KAC1D;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE;QAClE,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;KAChE;AACH,CAAC;AAdD,wCAcC;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;;;;GAIG;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;;;;;;;GAOG;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,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AAxBD,gCAwBC;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 rfdc from 'rfdc';\nimport { Arguments } from 'yargs';\n\nexport const deepClone = rfdc({ proto: false, circles: false });\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.json';\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 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 (Object.prototype.hasOwnProperty.call(argv, 'verboseErrors')) {\n    global.snaps.verboseErrors = Boolean(argv.verboseErrors);\n  }\n\n  if (Object.prototype.hasOwnProperty.call(argv, 'suppressWarnings')) {\n    global.snaps.suppressWarnings = Boolean(argv.suppressWarnings);\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 */\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 exits.\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    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;AACxB,gDAAwB;AAGX,QAAA,SAAS,GAAG,cAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAEnD,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;;;;;GAKG;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,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE;QAC/D,MAAM,CAAC,KAAK,CAAC,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;KACzE;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE;QAClE,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;;;;GAIG;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;;;;;;;GAOG;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,uEAAuE;QACvE,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 rfdc from 'rfdc';\nimport { Arguments } from 'yargs';\n\nexport const deepClone = rfdc({ proto: false, circles: false });\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 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 (Object.prototype.hasOwnProperty.call(argv, 'verboseErrors')) {\n    global.snaps.verboseErrors = booleanStringToBoolean(argv.verboseErrors);\n  }\n\n  if (Object.prototype.hasOwnProperty.call(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 * @return `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 */\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 exits.\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-skunkworks/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.__GENERATED__.d.ts

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

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

@@ -0,0 +1,18 @@
+"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

@@ -0,0 +1 @@
+{"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"]}

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

@@ -1,5 +1,12 @@
+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;
+};
+export declare function loadConfig(cached?: boolean): SnapConfig;
 /**
  * Attempts to read configuration options for package.json and the config file,
  * and apply them to argv if they weren't already set.
@@ -7,4 +14,4 @@ import yargs from 'yargs/yargs';
  * Arguments are only set per the snap-cli config file if they were not specified
  * on the command line.
  */
-export declare function applyConfig(processArgv: string[], yargsArgv: Arguments, yargsInstance: typeof yargs): void;
+export declare function applyConfig(snapConfig: SnapConfig, processArgv: string[], yargsArgv: Arguments, yargsInstance: typeof yargs): void;

package/dist/utils/snap-config.js

@@ -3,12 +3,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyConfig = void 0;
-const fs_1 = require("fs");
+exports.applyConfig = exports.loadConfig = void 0;
+const path_1 = __importDefault(require("path"));
 const yargs_parser_1 = __importDefault(require("yargs-parser"));
 const builders_1 = __importDefault(require("../builders"));
 const misc_1 = require("./misc");
-const _1 = require(".");
+const snap_config___GENERATED__1 = require("./snap-config.__GENERATED__");
+let snapConfigCache;
+function loadConfig(cached = true) {
+    if (snapConfigCache !== undefined && cached === true) {
+        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 (err) {
+        if (err.code === 'MODULE_NOT_FOUND') {
+            snapConfigCache = {};
+            return snapConfigCache;
+        }
+        misc_1.logError(`Error during parsing of ${misc_1.CONFIG_FILE}`, err);
+        return process.exit(1);
+    }
+    if (!snap_config___GENERATED__1.isSnapConfig(config)) {
+        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);
+    }
+    snapConfigCache = config;
+    return config;
+}
+exports.loadConfig = loadConfig;
 // Note that the below function is necessary because yarg's .config() function
 // leaves much to be desired.
 //
@@ -21,7 +47,7 @@ const _1 = require(".");
  * Arguments are only set per the snap-cli config file if they were not specified
  * on the command line.
  */
-function applyConfig(processArgv, yargsArgv, yargsInstance) {
+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
@@ -43,36 +69,17 @@ function applyConfig(processArgv, yargsArgv, yargsInstance) {
         return (commandOptions.has(key) &&
             !Object.prototype.hasOwnProperty.call(parsedProcessArgv, key));
     };
-    // Now, we attempt to read and apply config from the config file, if any.
-    let cfg = {};
-    try {
-        cfg = JSON.parse(fs_1.readFileSync(_1.CONFIG_FILE, 'utf8'));
-    }
-    catch (err) {
-        if (err.code === 'ENOENT') {
-            // If there's no config file, we're done here.
-            return;
-        }
-        misc_1.logError(`Error: "${_1.CONFIG_FILE}" exists but could not be parsed. Ensure your config file is valid JSON and try again.`, err);
-        process.exit(1);
-    }
-    if (cfg && typeof cfg === 'object' && !Array.isArray(cfg)) {
-        for (const key of Object.keys(cfg)) {
-            if (Object.hasOwnProperty.call(builders_1.default, key)) {
-                if (shouldSetArg(key)) {
-                    yargsArgv[key] = cfg[key];
-                }
-            }
-            else {
-                misc_1.logError(`Error: Encountered unrecognized config property "${key}" in config file "${_1.CONFIG_FILE}". Remove the property and try again.`);
-                process.exit(1);
+    const cfg = snapConfig.cliOptions || {};
+    for (const key of Object.keys(cfg)) {
+        if (Object.hasOwnProperty.call(builders_1.default, key)) {
+            if (shouldSetArg(key)) {
+                yargsArgv[key] = cfg[key];
             }
         }
-    }
-    else {
-        const cfgType = cfg === null ? 'null' : typeof cfg;
-        misc_1.logError(`Error: The config file must consist of a top-level JSON object. Received "${cfgType}" from "${_1.CONFIG_FILE}". Fix your config file and try again.`);
-        process.exit(1);
+        else {
+            misc_1.logError(`Error: Encountered unrecognized config property "options.${key}" in config file "${misc_1.CONFIG_FILE}". Remove the property and try again.`);
+            process.exit(1);
+        }
     }
 }
 exports.applyConfig = applyConfig;

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,2BAAkC;AAGlC,gEAAsC;AACtC,2DAAmC;AACnC,iCAAkC;AAClC,wBAAgC;AAEhC,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;GAMG;AACH,SAAgB,WAAW,CACzB,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,sBAAU,CAAC,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,CACL,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YACvB,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC9D,CAAC;IACJ,CAAC,CAAC;IAEF,yEAAyE;IACzE,IAAI,GAAG,GAA4B,EAAE,CAAC;IACtC,IAAI;QACF,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAY,CAAC,cAAW,EAAE,MAAM,CAAC,CAAC,CAAC;KACrD;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;YACzB,8CAA8C;YAC9C,OAAO;SACR;QAED,eAAQ,CACN,WAAW,cAAW,wFAAwF,EAC9G,GAAG,CACJ,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACzD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,IAAI,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;gBAC7C,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;oBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;iBAC3B;aACF;iBAAM;gBACL,eAAQ,CACN,oDAAoD,GAAG,qBAAqB,cAAW,uCAAuC,CAC/H,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACF;KACF;SAAM;QACL,MAAM,OAAO,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC;QAEnD,eAAQ,CACN,6EAA6E,OAAO,WAAW,cAAW,wCAAwC,CACnJ,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC;AA3ED,kCA2EC","sourcesContent":["import { readFileSync } from 'fs';\nimport { Arguments } from 'yargs';\nimport yargs from 'yargs/yargs';\nimport yargsParse from 'yargs-parser';\nimport builders from '../builders';\nimport { logError } from './misc';\nimport { CONFIG_FILE } from '.';\n\n// Note that the below function is necessary because yarg's .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 */\nexport function applyConfig(\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 (\n      commandOptions.has(key) &&\n      !Object.prototype.hasOwnProperty.call(parsedProcessArgv, key)\n    );\n  };\n\n  // Now, we attempt to read and apply config from the config file, if any.\n  let cfg: Record<string, unknown> = {};\n  try {\n    cfg = JSON.parse(readFileSync(CONFIG_FILE, 'utf8'));\n  } catch (err) {\n    if (err.code === 'ENOENT') {\n      // If there's no config file, we're done here.\n      return;\n    }\n\n    logError(\n      `Error: \"${CONFIG_FILE}\" exists but could not be parsed. Ensure your config file is valid JSON and try again.`,\n      err,\n    );\n    process.exit(1);\n  }\n\n  if (cfg && typeof cfg === 'object' && !Array.isArray(cfg)) {\n    for (const key of Object.keys(cfg)) {\n      if (Object.hasOwnProperty.call(builders, key)) {\n        if (shouldSetArg(key)) {\n          yargsArgv[key] = cfg[key];\n        }\n      } else {\n        logError(\n          `Error: Encountered unrecognized config property \"${key}\" in config file \"${CONFIG_FILE}\". Remove the property and try again.`,\n        );\n        process.exit(1);\n      }\n    }\n  } else {\n    const cfgType = cfg === null ? 'null' : typeof cfg;\n\n    logError(\n      `Error: The config file must consist of a top-level JSON object. Received \"${cfgType}\" from \"${CONFIG_FILE}\". Fix your config file and try again.`,\n    );\n    process.exit(1);\n  }\n}\n"]}
+{"version":3,"file":"snap-config.js","sourceRoot":"","sources":["../../src/utils/snap-config.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAGxB,gEAAsC;AAEtC,2DAAmC;AACnC,iCAA+C;AAC/C,0EAA2D;AAQ3D,IAAI,eAAuC,CAAC;AAE5C,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,eAAQ,CAAC,2BAA2B,kBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,IAAI,CAAC,uCAAY,CAAC,MAAM,CAAC,EAAE;QACzB,eAAQ,CACN,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;;;;;;GAMG;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,sBAAU,CAAC,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,CACL,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YACvB,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAC9D,CAAC;IACJ,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,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;YAC7C,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;aAAM;YACL,eAAQ,CACN,4DAA4D,GAAG,qBAAqB,kBAAW,uCAAuC,CACvI,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC;AAnDD,kCAmDC","sourcesContent":["import path from 'path';\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\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 yarg's .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 */\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 (\n      commandOptions.has(key) &&\n      !Object.prototype.hasOwnProperty.call(parsedProcessArgv, key)\n    );\n  };\n\n  const cfg: Record<string, unknown> = snapConfig.cliOptions || {};\n  for (const key of Object.keys(cfg)) {\n    if (Object.hasOwnProperty.call(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.7.0",
+  "version": "0.10.0",
   "description": "A CLI for developing MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -17,14 +17,16 @@
     "setup": "yarn install && yarn allow-scripts",
     "shasum": "node ./scripts/computeSnapShasum.js",
     "build:init-template": "node ./scripts/createInitTemplate.js && yarn prettier --check src/cmds/init/init-template.json",
-    "build:typescript": "tsc --project ./tsconfig.local.json",
+    "build:guards": "ts-auto-guard --guard-file-name=__GENERATED__ ./src/utils/snap-config.ts",
+    "build:tsc": "tsc --project ./tsconfig.local.json",
     "build:chmod": "chmod +x ./dist/main.js",
-    "build": "yarn build:init-template && yarn build:typescript && yarn build:chmod",
-    "build:pre-tsc": "echo 'N/A'",
-    "build:post-tsc": "yarn build:init-template && yarn build:chmod",
+    "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:post-tsc": "yarn build:chmod && yarn build:readme",
     "build:clean": "yarn clean && yarn build",
     "build:watch": "tsc-watch --onSuccess 'yarn build:chmod'",
-    "clean": "rimraf dist/*",
+    "clean": "rimraf dist/* src/**/*__GENERATED__*",
     "test": "yarn build:init-template && jest",
     "test:watch": "yarn test --watch",
     "test:ci": "yarn test",
@@ -43,7 +45,7 @@
     "@babel/plugin-proposal-optional-chaining": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.16.7",
     "@babel/preset-env": "^7.16.7",
-    "@metamask/snap-controllers": "^0.7.0",
+    "@metamask/snap-controllers": "^0.10.0",
     "@nodefactory/strip-comments": "^1.0.2",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
@@ -84,10 +86,12 @@
     "eslint-plugin-jest": "^24.4.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
+    "execa": "^5.1.1",
     "jest": "^26.6.3",
     "patch-package": "^6.4.7",
     "prettier": "^2.3.2",
     "rimraf": "^3.0.2",
+    "ts-auto-guard": "^2.3.0",
     "ts-jest": "^26.5.6",
     "ts-node": "^9.1.1",
     "tsc-watch": "^4.5.0",

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

@@ -1,42 +0,0 @@
-/// <reference types="node" />
-import { Option, YargsArgs } from '../../types/yargs';
-/**
- * Opens a stream to write the destination file path.
- *
- * @param dest - The output file path
- * @returns - The stream
- */
-export declare function createBundleStream(dest: string): NodeJS.WritableStream;
-declare type CloseStreamArgs = {
-    bundleError: Error;
-    bundleBuffer: Buffer;
-    bundleStream: NodeJS.WritableStream;
-    src: string;
-    dest: string;
-    resolve: (value: boolean) => void;
-    argv: YargsArgs;
-};
-/**
- * Postprocesses the bundle string and closes the write stream.
- *
- * @param stream - The write stream
- * @param bundleString - The bundle string
- * @param options - post process options
- * @param options.stripComments
- */
-export declare function closeBundleStream({ bundleError, bundleBuffer, bundleStream, src, dest, resolve, argv, }: CloseStreamArgs): Promise<void>;
-/**
- * Postprocesses a JavaScript bundle string such that it can be evaluated in SES.
- * Currently:
- * - converts certain dot notation to string notation (for indexing)
- * - makes all direct calls to eval indirect
- * - wraps original bundle in anonymous function
- * - handles certain Babel-related edge cases
- *
- * @param bundleString - The bundle string
- * @param options - post process options
- * @param options.stripComments
- * @returns - The postprocessed bundle string
- */
-export declare function postProcess(bundleString: string | null, options?: Partial<Option>): string | null;
-export {};