@metamask/snaps-cli 0.16.0 → 0.17.0

package/dist/cmds/serve/index.js

@@ -2,56 +2,14 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const http_1 = __importDefault(require("http"));
-const serve_handler_1 = __importDefault(require("serve-handler"));
 const builders_1 = __importDefault(require("../../builders"));
-const utils_1 = require("../../utils");
-const serveUtils_1 = require("./serveUtils");
-/**
- * Starts a local, static HTTP server on the given port with the given root
- * directory.
- *
- * @param argv - arguments as an object generated by yargs
- * @param argv.root - The root directory path string
- * @param argv.port - The server port
- */
-async function serve(argv) {
-    const { port, root: rootDir } = argv;
-    await (0, utils_1.validateDirPath)(rootDir, true);
-    console.log(`\nStarting server...`);
-    const server = http_1.default.createServer(async (req, res) => {
-        await (0, serve_handler_1.default)(req, res, {
-            public: rootDir,
-            headers: [
-                {
-                    source: '**/*',
-                    headers: [
-                        {
-                            key: 'Cache-Control',
-                            value: 'no-cache',
-                        },
-                    ],
-                },
-            ],
-        });
-    });
-    server.listen({ port }, () => (0, serveUtils_1.logServerListening)(port));
-    server.on('request', (request) => (0, serveUtils_1.logRequest)(request));
-    server.on('error', (error) => {
-        (0, serveUtils_1.logServerError)(error, argv.port);
-        process.exitCode = 1;
-    });
-    server.on('close', () => {
-        console.log('Server closed');
-        process.exitCode = 1;
-    });
-}
+const serveHandler_1 = require("./serveHandler");
 module.exports = {
     command: ['serve', 's'],
     desc: 'Locally serve Snap file(s) for testing',
     builder: (yarg) => {
         yarg.option('root', builders_1.default.root).option('port', builders_1.default.port);
     },
-    handler: (argv) => serve(argv),
+    handler: (argv) => (0, serveHandler_1.serve)(argv),
 };
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/serve/index.ts"],"names":[],"mappings":";;;;AAAA,gDAAwB;AACxB,kEAAyC;AAEzC,8DAAsC;AAEtC,uCAA8C;AAC9C,6CAA8E;AAW9E;;;;;;;GAOG;AACH,KAAK,UAAU,KAAK,CAAC,IAAe;IAClC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAErC,MAAM,IAAA,uBAAe,EAAC,OAAiB,EAAE,IAAI,CAAC,CAAC;IAE/C,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAEpC,MAAM,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAClD,MAAM,IAAA,uBAAY,EAAC,GAAG,EAAE,GAAG,EAAE;YAC3B,MAAM,EAAE,OAAiB;YACzB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP;4BACE,GAAG,EAAE,eAAe;4BACpB,KAAK,EAAE,UAAU;yBAClB;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,IAAA,+BAAkB,EAAC,IAAI,CAAC,CAAC,CAAC;IAExD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,OAAO,CAAC,CAAC,CAAC;IAEvD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QAC3B,IAAA,2BAAc,EAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACtB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAtDD,iBAAS;IACP,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,IAAI,EAAE,wCAAwC;IAC9C,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;CAC1C,CAAC","sourcesContent":["import http from 'http';\nimport serveHandler from 'serve-handler';\nimport yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { validateDirPath } from '../../utils';\nimport { logRequest, logServerError, logServerListening } from './serveUtils';\n\nexport = {\n  command: ['serve', 's'],\n  desc: 'Locally serve Snap file(s) for testing',\n  builder: (yarg: yargs.Argv) => {\n    yarg.option('root', builders.root).option('port', builders.port);\n  },\n  handler: (argv: YargsArgs) => serve(argv),\n};\n\n/**\n * Starts a local, static HTTP server on the given port with the given root\n * directory.\n *\n * @param argv - arguments as an object generated by yargs\n * @param argv.root - The root directory path string\n * @param argv.port - The server port\n */\nasync function serve(argv: YargsArgs): Promise<void> {\n  const { port, root: rootDir } = argv;\n\n  await validateDirPath(rootDir as string, true);\n\n  console.log(`\\nStarting server...`);\n\n  const server = http.createServer(async (req, res) => {\n    await serveHandler(req, res, {\n      public: rootDir as string,\n      headers: [\n        {\n          source: '**/*',\n          headers: [\n            {\n              key: 'Cache-Control',\n              value: 'no-cache',\n            },\n          ],\n        },\n      ],\n    });\n  });\n\n  server.listen({ port }, () => logServerListening(port));\n\n  server.on('request', (request) => logRequest(request));\n\n  server.on('error', (error) => {\n    logServerError(error, argv.port);\n    process.exitCode = 1;\n  });\n\n  server.on('close', () => {\n    console.log('Server closed');\n    process.exitCode = 1;\n  });\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cmds/serve/index.ts"],"names":[],"mappings":";;;;AACA,8DAAsC;AAEtC,iDAAuC;AAEvC,iBAAS;IACP,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC;IACvB,IAAI,EAAE,wCAAwC;IAC9C,OAAO,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAA,oBAAK,EAAC,IAAI,CAAC;CAC1C,CAAC","sourcesContent":["import yargs from 'yargs';\nimport builders from '../../builders';\nimport { YargsArgs } from '../../types/yargs';\nimport { serve } from './serveHandler';\n\nexport = {\n  command: ['serve', 's'],\n  desc: 'Locally serve Snap file(s) for testing',\n  builder: (yarg: yargs.Argv) => {\n    yarg.option('root', builders.root).option('port', builders.port);\n  },\n  handler: (argv: YargsArgs) => serve(argv),\n};\n"]}

package/dist/cmds/serve/serveHandler.d.ts

@@ -0,0 +1,10 @@
+import { YargsArgs } from '../../types/yargs';
+/**
+ * Starts a local, static HTTP server on the given port with the given root
+ * directory.
+ *
+ * @param argv - Arguments as an object generated by Yargs.
+ * @param argv.root - The root directory path string.
+ * @param argv.port - The server port.
+ */
+export declare function serve(argv: YargsArgs): Promise<void>;

package/dist/cmds/serve/serveHandler.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = void 0;
+const http_1 = __importDefault(require("http"));
+const serve_handler_1 = __importDefault(require("serve-handler"));
+const utils_1 = require("../../utils");
+const serveUtils_1 = require("./serveUtils");
+/**
+ * Starts a local, static HTTP server on the given port with the given root
+ * directory.
+ *
+ * @param argv - Arguments as an object generated by Yargs.
+ * @param argv.root - The root directory path string.
+ * @param argv.port - The server port.
+ */
+async function serve(argv) {
+    const { port, root: rootDir } = argv;
+    await (0, utils_1.validateDirPath)(rootDir, true);
+    console.log(`\nStarting server...`);
+    const server = http_1.default.createServer(async (req, res) => {
+        await (0, serve_handler_1.default)(req, res, {
+            public: rootDir,
+            headers: [
+                {
+                    source: '**/*',
+                    headers: [
+                        {
+                            key: 'Cache-Control',
+                            value: 'no-cache',
+                        },
+                    ],
+                },
+            ],
+        });
+    });
+    server.listen({ port }, () => (0, serveUtils_1.logServerListening)(port));
+    server.on('request', (request) => (0, serveUtils_1.logRequest)(request));
+    server.on('error', (error) => {
+        (0, serveUtils_1.logServerError)(error, argv.port);
+        process.exitCode = 1;
+    });
+    server.on('close', () => {
+        console.log('Server closed');
+        process.exitCode = 1;
+    });
+}
+exports.serve = serve;
+//# sourceMappingURL=serveHandler.js.map

package/dist/cmds/serve/serveHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serveHandler.js","sourceRoot":"","sources":["../../../src/cmds/serve/serveHandler.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,kEAAyC;AAEzC,uCAA8C;AAC9C,6CAA8E;AAE9E;;;;;;;GAOG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAErC,MAAM,IAAA,uBAAe,EAAC,OAAiB,EAAE,IAAI,CAAC,CAAC;IAE/C,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAEpC,MAAM,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAClD,MAAM,IAAA,uBAAY,EAAC,GAAG,EAAE,GAAG,EAAE;YAC3B,MAAM,EAAE,OAAiB;YACzB,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP;4BACE,GAAG,EAAE,eAAe;4BACpB,KAAK,EAAE,UAAU;yBAClB;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,IAAA,+BAAkB,EAAC,IAAI,CAAC,CAAC,CAAC;IAExD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,OAAO,CAAC,CAAC,CAAC;IAEvD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QAC3B,IAAA,2BAAc,EAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACtB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AArCD,sBAqCC","sourcesContent":["import http from 'http';\nimport serveHandler from 'serve-handler';\nimport { YargsArgs } from '../../types/yargs';\nimport { validateDirPath } from '../../utils';\nimport { logRequest, logServerError, logServerListening } from './serveUtils';\n\n/**\n * Starts a local, static HTTP server on the given port with the given root\n * directory.\n *\n * @param argv - Arguments as an object generated by Yargs.\n * @param argv.root - The root directory path string.\n * @param argv.port - The server port.\n */\nexport async function serve(argv: YargsArgs): Promise<void> {\n  const { port, root: rootDir } = argv;\n\n  await validateDirPath(rootDir as string, true);\n\n  console.log(`\\nStarting server...`);\n\n  const server = http.createServer(async (req, res) => {\n    await serveHandler(req, res, {\n      public: rootDir as string,\n      headers: [\n        {\n          source: '**/*',\n          headers: [\n            {\n              key: 'Cache-Control',\n              value: 'no-cache',\n            },\n          ],\n        },\n      ],\n    });\n  });\n\n  server.listen({ port }, () => logServerListening(port));\n\n  server.on('request', (request) => logRequest(request));\n\n  server.on('error', (error) => {\n    logServerError(error, argv.port);\n    process.exitCode = 1;\n  });\n\n  server.on('close', () => {\n    console.log('Server closed');\n    process.exitCode = 1;\n  });\n}\n"]}

package/dist/cmds/serve/serveUtils.d.ts

@@ -1,5 +1,22 @@
+/**
+ * Log a message with the URL and port of the server.
+ *
+ * @param port - The port that the server is running on.
+ */
 export declare function logServerListening(port: number): void;
+/**
+ * Log a message with the request URL.
+ *
+ * @param request - The request object.
+ * @param request.url - The URL of the request.
+ */
 export declare function logRequest(request: {
     url: string;
 }): void;
+/**
+ * Log an error message.
+ *
+ * @param error - The error to log.
+ * @param port - The port that the server is running on.
+ */
 export declare function logServerError(error: Error, port: number): void;

package/dist/cmds/serve/serveUtils.js

@@ -2,14 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logServerError = exports.logRequest = exports.logServerListening = void 0;
 const utils_1 = require("../../utils");
+/**
+ * Log a message with the URL and port of the server.
+ *
+ * @param port - The port that the server is running on.
+ */
 function logServerListening(port) {
     console.log(`Server listening on: http://localhost:${port}`);
 }
 exports.logServerListening = logServerListening;
+/**
+ * Log a message with the request URL.
+ *
+ * @param request - The request object.
+ * @param request.url - The URL of the request.
+ */
 function logRequest(request) {
     console.log(`Handling incoming request for: ${request.url}`);
 }
 exports.logRequest = logRequest;
+/**
+ * Log an error message.
+ *
+ * @param error - The error to log.
+ * @param port - The port that the server is running on.
+ */
 function logServerError(error, port) {
     if (error.code === 'EADDRINUSE') {
         (0, utils_1.logError)(`Server error: Port ${port} already in use.`);

package/dist/cmds/serve/serveUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"serveUtils.js","sourceRoot":"","sources":["../../../src/cmds/serve/serveUtils.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AAEvC,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,OAAO,CAAC,GAAG,CAAC,yCAAyC,IAAI,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gDAEC;AAED,SAAgB,UAAU,CAAC,OAAwB;IACjD,OAAO,CAAC,GAAG,CAAC,kCAAkC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gCAEC;AAED,SAAgB,cAAc,CAAC,KAAY,EAAE,IAAY;IACvD,IAAK,KAAa,CAAC,IAAI,KAAK,YAAY,EAAE;QACxC,IAAA,gBAAQ,EAAC,sBAAsB,IAAI,kBAAkB,CAAC,CAAC;KACxD;SAAM;QACL,IAAA,gBAAQ,EAAC,iBAAiB,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;KACnD;AACH,CAAC;AAND,wCAMC","sourcesContent":["import { logError } from '../../utils';\n\nexport function logServerListening(port: number) {\n  console.log(`Server listening on: http://localhost:${port}`);\n}\n\nexport function logRequest(request: { url: string }) {\n  console.log(`Handling incoming request for: ${request.url}`);\n}\n\nexport function logServerError(error: Error, port: number) {\n  if ((error as any).code === 'EADDRINUSE') {\n    logError(`Server error: Port ${port} already in use.`);\n  } else {\n    logError(`Server error: ${error.message}`, error);\n  }\n}\n"]}
+{"version":3,"file":"serveUtils.js","sourceRoot":"","sources":["../../../src/cmds/serve/serveUtils.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AAEvC;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,OAAO,CAAC,GAAG,CAAC,yCAAyC,IAAI,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gDAEC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,OAAwB;IACjD,OAAO,CAAC,GAAG,CAAC,kCAAkC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gCAEC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAY,EAAE,IAAY;IACvD,IAAK,KAAa,CAAC,IAAI,KAAK,YAAY,EAAE;QACxC,IAAA,gBAAQ,EAAC,sBAAsB,IAAI,kBAAkB,CAAC,CAAC;KACxD;SAAM;QACL,IAAA,gBAAQ,EAAC,iBAAiB,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;KACnD;AACH,CAAC;AAND,wCAMC","sourcesContent":["import { logError } from '../../utils';\n\n/**\n * Log a message with the URL and port of the server.\n *\n * @param port - The port that the server is running on.\n */\nexport function logServerListening(port: number) {\n  console.log(`Server listening on: http://localhost:${port}`);\n}\n\n/**\n * Log a message with the request URL.\n *\n * @param request - The request object.\n * @param request.url - The URL of the request.\n */\nexport function logRequest(request: { url: string }) {\n  console.log(`Handling incoming request for: ${request.url}`);\n}\n\n/**\n * Log an error message.\n *\n * @param error - The error to log.\n * @param port - The port that the server is running on.\n */\nexport function logServerError(error: Error, port: number) {\n  if ((error as any).code === 'EADDRINUSE') {\n    logError(`Server error: Port ${port} already in use.`);\n  } else {\n    logError(`Server error: ${error.message}`, error);\n  }\n}\n"]}

package/dist/cmds/watch/index.js

@@ -21,6 +21,9 @@ module.exports = {
             .option('depsToTranspile', builders_1.default.depsToTranspile)
             .option('manifest', builders_1.default.manifest)
             .option('writeManifest', builders_1.default.writeManifest)
+            .option('serve', builders_1.default.serve)
+            .option('root', builders_1.default.root)
+            .option('port', builders_1.default.port)
             .implies('writeManifest', 'manifest')
             .implies('depsToTranspile', 'transpilationMode')
             .middleware((argv) => (0, utils_1.processInvalidTranspilation)(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,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,IAAA,mCAA2B,EAAC,IAAW,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAA,oBAAK,EAAC,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"]}
+{"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,MAAM,CAAC,OAAO,EAAE,kBAAQ,CAAC,KAAK,CAAC;aAC/B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,MAAM,CAAC,MAAM,EAAE,kBAAQ,CAAC,IAAI,CAAC;aAC7B,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC;aACpC,OAAO,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;aAC/C,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mCAA2B,EAAC,IAAW,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,CAAC,IAAe,EAAE,EAAE,CAAC,IAAA,oBAAK,EAAC,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      .option('serve', builders.serve)\n      .option('root', builders.root)\n      .option('port', builders.port)\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.d.ts

@@ -6,9 +6,9 @@ import { YargsArgs } from '../../types/yargs';
  * Ignores 'node_modules' and dotfiles.
  * Creates destination directory if it doesn't exist.
  *
- * @param argv - arguments as an object generated by yargs
- * @param argv.src - The source file path
- * @param argv.dist - The output directory path
- * @param argv.'outfileName' - The output file name
+ * @param argv - Arguments as an object generated by Yargs.
+ * @param argv.src - The source file path.
+ * @param argv.dist - The output directory path.
+ * @param argv.'outfileName' - The output file name.
  */
 export declare function watch(argv: YargsArgs): Promise<void>;

package/dist/cmds/watch/watchHandler.js

@@ -9,6 +9,7 @@ const utils_1 = require("../../utils");
 const bundle_1 = require("../build/bundle");
 const evalHandler_1 = require("../eval/evalHandler");
 const manifestHandler_1 = require("../manifest/manifestHandler");
+const serveHandler_1 = require("../serve/serveHandler");
 /**
  * Watch a directory and its subdirectories for changes, and build when files
  * are added or changed.
@@ -16,13 +17,13 @@ const manifestHandler_1 = require("../manifest/manifestHandler");
  * Ignores 'node_modules' and dotfiles.
  * Creates destination directory if it doesn't exist.
  *
- * @param argv - arguments as an object generated by yargs
- * @param argv.src - The source file path
- * @param argv.dist - The output directory path
- * @param argv.'outfileName' - The output file name
+ * @param argv - Arguments as an object generated by Yargs.
+ * @param argv.src - The source file path.
+ * @param argv.dist - The output directory path.
+ * @param argv.'outfileName' - The output file name.
  */
 async function watch(argv) {
-    const { dist, eval: shouldEval, manifest, outfileName, src } = argv;
+    const { dist, eval: shouldEval, manifest, outfileName, src, serve: shouldServe, } = argv;
     if (outfileName) {
         (0, utils_1.validateOutfileName)(outfileName);
     }
@@ -63,7 +64,12 @@ async function watch(argv) {
             (str) => str !== '.' && str.startsWith('.'),
         ],
     })
-        .on('ready', buildSnap)
+        .on('ready', async () => {
+        await buildSnap();
+        if (shouldServe) {
+            await (0, serveHandler_1.serve)(argv);
+        }
+    })
         .on('add', (path) => buildSnap(path, `File added: ${path}`))
         .on('change', (path) => buildSnap(path, `File changed: ${path}`))
         .on('unlink', (path) => console.log(`File removed: ${path}`))

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,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,IAAA,2BAAmB,EAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,IAAA,wBAAgB,EAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,IAAA,uBAAe,EAAC,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,IAAA,sBAAc,EAAC,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,IAAA,eAAM,EAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,IAAA,kBAAU,GAAE,CAAC,iBAAiB,CAAC,CAAC;YAErE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC;aAC7B;YAED,IAAI,UAAU,EAAE;gBACd,MAAM,IAAA,sBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;aAClD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,gBAAQ,EACN,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,IAAA,gBAAQ,EAAC,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"]}
+{"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;AAC9D,wDAA8C;AAE9C;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,KAAK,CAAC,IAAe;IACzC,MAAM,EACJ,IAAI,EACJ,IAAI,EAAE,UAAU,EAChB,QAAQ,EACR,WAAW,EACX,GAAG,EACH,KAAK,EAAE,WAAW,GACnB,GAAG,IAAI,CAAC;IACT,IAAI,WAAW,EAAE;QACf,IAAA,2BAAmB,EAAC,WAAqB,CAAC,CAAC;KAC5C;IACD,MAAM,IAAA,wBAAgB,EAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,IAAA,uBAAe,EAAC,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,IAAA,sBAAc,EAAC,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,IAAA,eAAM,EAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,IAAA,kBAAU,GAAE,CAAC,iBAAiB,CAAC,CAAC;YAErE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC;aAC7B;YAED,IAAI,UAAU,EAAE;gBACd,MAAM,IAAA,sBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;aAClD;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,gBAAQ,EACN,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,KAAK,IAAI,EAAE;QACtB,MAAM,SAAS,EAAE,CAAC;QAClB,IAAI,WAAW,EAAE;YACf,MAAM,IAAA,oBAAK,EAAC,IAAI,CAAC,CAAC;SACnB;IACH,CAAC,CAAC;SACD,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,IAAA,gBAAQ,EAAC,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;AA5ED,sBA4EC","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';\nimport { serve } from '../serve/serveHandler';\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 {\n    dist,\n    eval: shouldEval,\n    manifest,\n    outfileName,\n    src,\n    serve: shouldServe,\n  } = 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', async () => {\n      await buildSnap();\n      if (shouldServe) {\n        await serve(argv);\n      }\n    })\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.d.ts

@@ -3,16 +3,16 @@ import type { Json } from '@metamask/snap-controllers';
  * Checks whether the given path string resolves to an existing directory, and
  * optionally creates the directory if it doesn't exist.
  *
- * @param pathString - The path string to check
- * @param createDir - Whether to create the directory if it doesn't exist
- * @returns - Whether the given path is an existing directory
+ * @param pathString - The path string to check.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns Whether the given path is an existing directory.
  */
 export declare function isDirectory(pathString: string, createDir: boolean): Promise<boolean>;
 /**
  * Checks whether the given path string resolves to an existing file.
  *
- * @param pathString - The path string to check
- * @returns Whether the given path is an existing file
+ * @param pathString - The path string to check.
+ * @returns Whether the given path is an existing file.
  */
 export declare function isFile(pathString: string): Promise<boolean>;
 /**

package/dist/utils/fs.js

@@ -7,9 +7,9 @@ const misc_1 = require("./misc");
  * Checks whether the given path string resolves to an existing directory, and
  * optionally creates the directory if it doesn't exist.
  *
- * @param pathString - The path string to check
- * @param createDir - Whether to create the directory if it doesn't exist
- * @returns - Whether the given path is an existing directory
+ * @param pathString - The path string to check.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns Whether the given path is an existing directory.
  */
 async function isDirectory(pathString, createDir) {
     try {
@@ -37,8 +37,8 @@ exports.isDirectory = isDirectory;
 /**
  * Checks whether the given path string resolves to an existing file.
  *
- * @param pathString - The path string to check
- * @returns Whether the given path is an existing file
+ * @param pathString - The path string to check.
+ * @returns Whether the given path is an existing file.
  */
 async function isFile(pathString) {
     try {

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,IAAA,eAAQ,EAAC,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"]}
+{"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,IAAA,eAAQ,EAAC,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

@@ -4,16 +4,17 @@ export declare const permRequestKeys: string[];
 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.
+ * watch mode activation, verbose errors messages, and whether to suppress
+ * warnings.
  *
- * @param argv - arguments as an object generated by yargs
+ * @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
+ * @returns `true` if the value is the string `"true"`, `false` if it is the
  * string `"false"`, the value if it is already a boolean, or an error
  * otherwise.
  */
@@ -22,30 +23,32 @@ export declare function booleanStringToBoolean(value: unknown): boolean;
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.
  *
- * @param argv - arguments as an object generated by yargs
+ * @param argv - Arguments as an object generated by yargs.
  */
 export declare function sanitizeInputs(argv: Arguments): void;
 /**
  * Logs an error message to console. Logs original error if it exists and
  * the verboseErrors global is true.
  *
- * @param msg - The error message
- * @param err - The original error
+ * @param msg - The error message.
+ * @param err - The original error.
  */
 export declare function logError(msg: string, err?: Error): void;
 /**
  * Logs a warning message to console.
  *
- * @param msg - The warning message
+ * @param msg - The warning message.
+ * @param error - The original error.
  */
 export declare function logWarning(msg: string, error?: Error): void;
 /**
- * Logs an error, attempts to unlink the destination file, and exits.
+ * Logs an error, attempts to unlink the destination file, and kills the
+ * process.
  *
- * @param prefix - The message prefix
- * @param msg - The error message
- * @param err - The original error
- * @param destFilePath - The output file path
+ * @param prefix - The message prefix.
+ * @param msg - The error message.
+ * @param err - The original error.
+ * @param destFilePath - The output file path.
  */
 export declare function writeError(prefix: string, msg: string, err: Error, destFilePath?: string): Promise<void>;
 /**
@@ -53,6 +56,6 @@ export declare function writeError(prefix: string, msg: string, err: Error, dest
  * given path string.
  *
  * @param pathString - The path string to trim.
- * @returns - The trimmed path string.
+ * @returns The trimmed path string.
  */
 export declare function trimPathString(pathString: string): string;

package/dist/utils/misc.js

@@ -32,9 +32,10 @@ const pathArguments = new Set([
 ]);
 /**
  * Sets global variable snaps which tracks user settings:
- * watch mode activation, verbose errors messages, and whether to suppress warnings.
+ * watch mode activation, verbose errors messages, and whether to suppress
+ * warnings.
  *
- * @param argv - arguments as an object generated by yargs
+ * @param argv - Arguments as an object generated by `yargs`.
  */
 function setSnapGlobals(argv) {
     if (['w', 'watch'].includes(argv._[0])) {
@@ -55,7 +56,7 @@ 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
+ * @returns `true` if the value is the string `"true"`, `false` if it is the
  * string `"false"`, the value if it is already a boolean, or an error
  * otherwise.
  */
@@ -76,7 +77,7 @@ exports.booleanStringToBoolean = booleanStringToBoolean;
  * Sanitizes inputs. Currently normalizes "./" paths to ".".
  * Yargs handles other path normalization as specified in builders.
  *
- * @param argv - arguments as an object generated by yargs
+ * @param argv - Arguments as an object generated by yargs.
  */
 function sanitizeInputs(argv) {
     Object.keys(argv).forEach((key) => {
@@ -96,8 +97,8 @@ exports.sanitizeInputs = sanitizeInputs;
  * Logs an error message to console. Logs original error if it exists and
  * the verboseErrors global is true.
  *
- * @param msg - The error message
- * @param err - The original error
+ * @param msg - The error message.
+ * @param err - The original error.
  */
 function logError(msg, err) {
     console.error(msg);
@@ -109,7 +110,8 @@ exports.logError = logError;
 /**
  * Logs a warning message to console.
  *
- * @param msg - The warning message
+ * @param msg - The warning message.
+ * @param error - The original error.
  */
 function logWarning(msg, error) {
     if (msg && !global.snaps.suppressWarnings) {
@@ -121,12 +123,13 @@ function logWarning(msg, error) {
 }
 exports.logWarning = logWarning;
 /**
- * Logs an error, attempts to unlink the destination file, and exits.
+ * Logs an error, attempts to unlink the destination file, and kills the
+ * process.
  *
- * @param prefix - The message prefix
- * @param msg - The error message
- * @param err - The original error
- * @param destFilePath - The output file path
+ * @param prefix - The message prefix.
+ * @param msg - The error message.
+ * @param err - The original error.
+ * @param destFilePath - The output file path.
  */
 async function writeError(prefix, msg, err, destFilePath) {
     let processedPrefix = prefix;
@@ -155,7 +158,7 @@ exports.writeError = writeError;
  * given path string.
  *
  * @param pathString - The path string to trim.
- * @returns - The trimmed path string.
+ * @returns The trimmed path string.
  */
 function trimPathString(pathString) {
     return pathString.replace(/^[./]+|[./]+$/gu, '');

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;AAC9C,gDAAwB;AAGX,QAAA,SAAS,GAAG,IAAA,cAAI,EAAC,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,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;;;;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 { hasProperty } from '@metamask/utils';\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 (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 * @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"]}
+{"version":3,"file":"misc.js","sourceRoot":"","sources":["../../src/utils/misc.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA4C;AAC5C,gDAAwB;AACxB,2CAA8C;AAC9C,gDAAwB;AAGX,QAAA,SAAS,GAAG,IAAA,cAAI,EAAC,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;;;;;;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,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 { hasProperty } from '@metamask/utils';\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\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-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/readline.d.ts

@@ -6,7 +6,32 @@ declare type PromptArgs = {
     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 {};