@metamask/snaps-cli 0.16.0 → 0.18.1

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 {};

package/dist/utils/readline.js

@@ -6,6 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.closePrompt = exports.prompt = exports.openPrompt = void 0;
 const readline_1 = __importDefault(require("readline"));
 let singletonReadlineInterface;
+/**
+ * Open a readline interface, to prompt for user input. Avoid using this
+ * function directly. Use the {@link prompt} function instead.
+ */
 function openPrompt() {
     singletonReadlineInterface = readline_1.default.createInterface({
         input: process.stdin,
@@ -13,6 +17,19 @@ function openPrompt() {
     });
 }
 exports.openPrompt = openPrompt;
+/**
+ * Prompt for user input on the command line. If the prompt isn't open, it will
+ * be opened.
+ *
+ * @param args - The prompt arguments.
+ * @param args.question - The question to ask.
+ * @param args.defaultValue - The default value to use, if no answer is provided.
+ * @param args.shouldClose - Whether to close the readline interface after
+ * prompting.
+ * @param args.readlineInterface - The readline interface to use. Uses the
+ * global readline interface if none provided.
+ * @returns The user's input, or the default value if none provided.
+ */
 function prompt({ question, defaultValue, shouldClose, readlineInterface = singletonReadlineInterface, }) {
     let _readlineInterface = readlineInterface;
     if (!_readlineInterface) {
@@ -38,6 +55,14 @@ function prompt({ question, defaultValue, shouldClose, readlineInterface = singl
     });
 }
 exports.prompt = prompt;
+/**
+ * Close the readline interface.
+ *
+ * @param readlineInterface - The readline interface to close. Uses the global
+ * readline interface if none provided.
+ * @throws If no readline interface is provided, and the global interface isn't
+ * open.
+ */
 function closePrompt(readlineInterface = singletonReadlineInterface) {
     if (readlineInterface) {
         readlineInterface.close();

package/dist/utils/readline.js.map

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

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

@@ -7,6 +7,15 @@ export declare type SnapConfig = {
     cliOptions?: Record<string, unknown>;
     bundlerCustomizer?: (bundler: browserify.BrowserifyObject) => void;
 };
+/**
+ * Attempt to load the snap config file (`snap.config.js`). By default will use
+ * the cached config, if it was loaded before, and `cached` is `true`. If the
+ * config file is not found, or the config is invalid, this function will kill
+ * the process.
+ *
+ * @param cached - Whether to use the cached config. Defaults to `true`.
+ * @returns The snap config.
+ */
 export declare function loadConfig(cached?: boolean): SnapConfig;
 /**
  * Attempts to read configuration options for package.json and the config file,
@@ -14,5 +23,10 @@ export declare function loadConfig(cached?: boolean): SnapConfig;
  *
  * Arguments are only set per the snap-cli config file if they were not specified
  * on the command line.
+ *
+ * @param snapConfig - The snap config.
+ * @param processArgv - The command line arguments, i.e., `process.argv`.
+ * @param yargsArgv - The processed `yargs` arguments.
+ * @param yargsInstance - An instance of `yargs`.
  */
 export declare function applyConfig(snapConfig: SnapConfig, processArgv: string[], yargsArgv: Arguments, yargsInstance: typeof yargs): void;

package/dist/utils/snap-config.js

@@ -11,6 +11,15 @@ const builders_1 = __importDefault(require("../builders"));
 const misc_1 = require("./misc");
 const snap_config___GENERATED__1 = require("./snap-config.__GENERATED__");
 let snapConfigCache;
+/**
+ * Attempt to load the snap config file (`snap.config.js`). By default will use
+ * the cached config, if it was loaded before, and `cached` is `true`. If the
+ * config file is not found, or the config is invalid, this function will kill
+ * the process.
+ *
+ * @param cached - Whether to use the cached config. Defaults to `true`.
+ * @returns The snap config.
+ */
 function loadConfig(cached = true) {
     if (snapConfigCache !== undefined && cached === true) {
         return snapConfigCache;
@@ -36,7 +45,7 @@ function loadConfig(cached = true) {
     return config;
 }
 exports.loadConfig = loadConfig;
-// Note that the below function is necessary because yarg's .config() function
+// Note that the below function is necessary because yargs' .config() function
 // leaves much to be desired.
 //
 // In particular, it will set all properties included in the config file
@@ -47,6 +56,11 @@ exports.loadConfig = loadConfig;
  *
  * Arguments are only set per the snap-cli config file if they were not specified
  * on the command line.
+ *
+ * @param snapConfig - The snap config.
+ * @param processArgv - The command line arguments, i.e., `process.argv`.
+ * @param yargsArgv - The processed `yargs` arguments.
+ * @param yargsInstance - An instance of `yargs`.
  */
 function applyConfig(snapConfig, processArgv, yargsArgv, yargsInstance) {
     // Instances of yargs has a number of undocumented functions, including

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

@@ -1 +1 @@
-{"version":3,"file":"snap-config.js","sourceRoot":"","sources":["../../src/utils/snap-config.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2CAA8C;AAG9C,gEAAsC;AAEtC,2DAAmC;AACnC,iCAA+C;AAC/C,0EAA2D;AAQ3D,IAAI,eAAuC,CAAC;AAE5C,SAAgB,UAAU,CAAC,MAAM,GAAG,IAAI;IACtC,IAAI,eAAe,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE;QACpD,OAAO,eAAe,CAAC;KACxB;IAED,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,iHAAiH;QACjH,MAAM,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAW,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,GAAQ,EAAE;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE;YACnC,eAAe,GAAG,EAAE,CAAC;YACrB,OAAO,eAAe,CAAC;SACxB;QACD,IAAA,eAAQ,EAAC,2BAA2B,kBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,IAAI,CAAC,IAAA,uCAAY,EAAC,MAAM,CAAC,EAAE;QACzB,IAAA,eAAQ,EACN,kBAAkB,kBAAW,mGAAmG,CACjI,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,eAAe,GAAG,MAAM,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AA1BD,gCA0BC;AAED,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;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,IAAA,sBAAU,EAAC,WAAW,EAAE;QAChD,KAAK,EAAE,OAAO;KACf,CAA4B,CAAC;IAC9B,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,mCAAmC;IAE/D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAErD,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE;QAC5C,OAAO,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,GAAG,GAA4B,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;IACjE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,IAAI,IAAA,mBAAW,EAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;YAC9B,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;aAAM;YACL,IAAA,eAAQ,EACN,4DAA4D,GAAG,qBAAqB,kBAAW,uCAAuC,CACvI,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC;AAhDD,kCAgDC","sourcesContent":["import path from 'path';\nimport { hasProperty } from '@metamask/utils';\nimport type browserify from 'browserify';\nimport { Arguments } from 'yargs';\nimport yargsParse from 'yargs-parser';\nimport yargs from 'yargs/yargs';\nimport builders from '../builders';\nimport { CONFIG_FILE, logError } from './misc';\nimport { isSnapConfig } from './snap-config.__GENERATED__';\n\n/** @see {isSnapConfig} ts-auto-guard:type-guard */\nexport type SnapConfig = {\n  cliOptions?: Record<string, unknown>;\n  bundlerCustomizer?: (bundler: browserify.BrowserifyObject) => void;\n};\n\nlet snapConfigCache: SnapConfig | undefined;\n\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 commandOptions.has(key) && !hasProperty(parsedProcessArgv, key);\n  };\n\n  const cfg: Record<string, unknown> = snapConfig.cliOptions || {};\n  for (const key of Object.keys(cfg)) {\n    if (hasProperty(builders, key)) {\n      if (shouldSetArg(key)) {\n        yargsArgv[key] = cfg[key];\n      }\n    } else {\n      logError(\n        `Error: Encountered unrecognized config property \"options.${key}\" in config file \"${CONFIG_FILE}\". Remove the property and try again.`,\n      );\n      process.exit(1);\n    }\n  }\n}\n"]}
+{"version":3,"file":"snap-config.js","sourceRoot":"","sources":["../../src/utils/snap-config.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2CAA8C;AAG9C,gEAAsC;AAEtC,2DAAmC;AACnC,iCAA+C;AAC/C,0EAA2D;AAQ3D,IAAI,eAAuC,CAAC;AAE5C;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,MAAM,GAAG,IAAI;IACtC,IAAI,eAAe,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE;QACpD,OAAO,eAAe,CAAC;KACxB;IAED,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,iHAAiH;QACjH,MAAM,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,kBAAW,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,GAAQ,EAAE;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE;YACnC,eAAe,GAAG,EAAE,CAAC;YACrB,OAAO,eAAe,CAAC;SACxB;QACD,IAAA,eAAQ,EAAC,2BAA2B,kBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,IAAI,CAAC,IAAA,uCAAY,EAAC,MAAM,CAAC,EAAE;QACzB,IAAA,eAAQ,EACN,kBAAkB,kBAAW,mGAAmG,CACjI,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACxB;IACD,eAAe,GAAG,MAAM,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AA1BD,gCA0BC;AAED,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,wEAAwE;AACxE,4DAA4D;AAE5D;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,UAAsB,EACtB,WAAqB,EACrB,SAAoB,EACpB,aAA2B;IAE3B,uEAAuE;IACvE,wEAAwE;IACxE,6EAA6E;IAC7E,+BAA+B;IAC/B,EAAE;IACF,8EAA8E;IAC9E,2EAA2E;IAC3E,oBAAoB;IACpB,EAAE;IACF,6EAA6E;IAC7E,qBAAqB;IACrB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GACpC,aACD,CAAC,UAAU,EAGX,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAA,sBAAU,EAAC,WAAW,EAAE;QAChD,KAAK,EAAE,OAAO;KACf,CAA4B,CAAC;IAC9B,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,mCAAmC;IAE/D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAErD,MAAM,YAAY,GAAG,CAAC,GAAW,EAAW,EAAE;QAC5C,OAAO,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAA,mBAAW,EAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,GAAG,GAA4B,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;IACjE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,IAAI,IAAA,mBAAW,EAAC,kBAAQ,EAAE,GAAG,CAAC,EAAE;YAC9B,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE;gBACrB,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;aAAM;YACL,IAAA,eAAQ,EACN,4DAA4D,GAAG,qBAAqB,kBAAW,uCAAuC,CACvI,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC;AAhDD,kCAgDC","sourcesContent":["import path from 'path';\nimport { hasProperty } from '@metamask/utils';\nimport type browserify from 'browserify';\nimport { Arguments } from 'yargs';\nimport yargsParse from 'yargs-parser';\nimport yargs from 'yargs/yargs';\nimport builders from '../builders';\nimport { CONFIG_FILE, logError } from './misc';\nimport { isSnapConfig } from './snap-config.__GENERATED__';\n\n/** @see {isSnapConfig} ts-auto-guard:type-guard */\nexport type SnapConfig = {\n  cliOptions?: Record<string, unknown>;\n  bundlerCustomizer?: (bundler: browserify.BrowserifyObject) => void;\n};\n\nlet snapConfigCache: SnapConfig | undefined;\n\n/**\n * Attempt to load the snap config file (`snap.config.js`). By default will use\n * the cached config, if it was loaded before, and `cached` is `true`. If the\n * config file is not found, or the config is invalid, this function will kill\n * the process.\n *\n * @param cached - Whether to use the cached config. Defaults to `true`.\n * @returns The snap config.\n */\nexport function loadConfig(cached = true): SnapConfig {\n  if (snapConfigCache !== undefined && cached === true) {\n    return snapConfigCache;\n  }\n\n  let config: any;\n  try {\n    // eslint-disable-next-line node/global-require, import/no-dynamic-require, @typescript-eslint/no-require-imports\n    config = require(path.resolve(process.cwd(), CONFIG_FILE));\n  } catch (err: any) {\n    if (err.code === 'MODULE_NOT_FOUND') {\n      snapConfigCache = {};\n      return snapConfigCache;\n    }\n    logError(`Error during parsing of ${CONFIG_FILE}`, err);\n    return process.exit(1);\n  }\n\n  if (!isSnapConfig(config)) {\n    logError(\n      `Can't validate ${CONFIG_FILE}. Ensure it's a proper javascript file and abides with the structure of a snap configuration file`,\n    );\n    return process.exit(1);\n  }\n  snapConfigCache = config;\n  return config;\n}\n\n// Note that the below function is necessary because yargs' .config() function\n// leaves much to be desired.\n//\n// In particular, it will set all properties included in the config file\n// regardless of the command, which fails during validation.\n\n/**\n * Attempts to read configuration options for package.json and the config file,\n * and apply them to argv if they weren't already set.\n *\n * Arguments are only set per the snap-cli config file if they were not specified\n * on the command line.\n *\n * @param snapConfig - The snap config.\n * @param processArgv - The command line arguments, i.e., `process.argv`.\n * @param yargsArgv - The processed `yargs` arguments.\n * @param yargsInstance - An instance of `yargs`.\n */\nexport function applyConfig(\n  snapConfig: SnapConfig,\n  processArgv: string[],\n  yargsArgv: Arguments,\n  yargsInstance: typeof yargs,\n): void {\n  // Instances of yargs has a number of undocumented functions, including\n  // getOptions. This function returns an object with properties \"key\" and\n  // \"alias\", which specify the options associated with the current command and\n  // their aliases, respectively.\n  //\n  // We leverage this to ensure that the config is only applied to args that are\n  // valid for the current command, and that weren't specified by the user on\n  // the command line.\n  //\n  // If we set args that aren't valid for the current command, yargs will error\n  // during validation.\n  const { alias: aliases, key: options } = (\n    yargsInstance as any\n  ).getOptions() as {\n    alias: Record<string, string[]>;\n    key: Record<string, unknown>;\n  };\n\n  const parsedProcessArgv = yargsParse(processArgv, {\n    alias: aliases,\n  }) as Record<string, unknown>;\n  delete parsedProcessArgv._; // irrelevant yargs parser artifact\n\n  const commandOptions = new Set(Object.keys(options));\n\n  const shouldSetArg = (key: string): boolean => {\n    return commandOptions.has(key) && !hasProperty(parsedProcessArgv, key);\n  };\n\n  const cfg: Record<string, unknown> = snapConfig.cliOptions || {};\n  for (const key of Object.keys(cfg)) {\n    if (hasProperty(builders, key)) {\n      if (shouldSetArg(key)) {\n        yargsArgv[key] = cfg[key];\n      }\n    } else {\n      logError(\n        `Error: Encountered unrecognized config property \"options.${key}\" in config file \"${CONFIG_FILE}\". Remove the property and try again.`,\n      );\n      process.exit(1);\n    }\n  }\n}\n"]}

package/dist/utils/validate-fs.d.ts

@@ -1,34 +1,35 @@
 /**
- * Gets the complete out file path from the source file path and output
+ * Gets the complete out file path from an output file name and parent
  * directory path.
  *
- * @param srcFilePath - The source file path
- * @param outDir - The out file directory
- * @returns - The complete out file path
+ * @param outDir - The path to the out file's parent directory.
+ * @param outFileName - The out file's name.
+ * @returns The complete path to the out file.
  */
 export declare function getOutfilePath(outDir: string, outFileName: string): string;
 /**
- * Ensures that the outfile name is just a js file name.
- * Throws on validation failure
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
  *
- * @param filename - The file name to validate
- * @returns - True if validation succeeded
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
  */
 export declare function validateOutfileName(filename: string): boolean;
 /**
- * Validates a file path.
- * Throws on validation failure
+ * Validates a file path. Throws on validation failure.
  *
- * @param filePath - The file path to validate
- * @returns - True if validation succeeded
+ * @param filePath - The file path to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the path does not resolve to a file.
  */
 export declare function validateFilePath(filePath: string): Promise<boolean>;
 /**
- * Validates a directory path.
- * Throws on validation failure.
+ * Validates a directory path. Throws on validation failure.
  *
- * @param dirPath - The directory path to validate
- * @param createDir - Whether to create the directory if it doesn't exist
- * @returns - True if validation succeeded
+ * @param dirPath - The directory path to validate.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns `true` if validation succeeded or the directory was created.
+ * @throws If the directory does not exist or could not be created.
  */
-export declare function validateDirPath(dirName: string, createDir: boolean): Promise<boolean>;
+export declare function validateDirPath(dirPath: string, createDir: boolean): Promise<boolean>;

package/dist/utils/validate-fs.js

@@ -7,23 +7,24 @@ exports.validateDirPath = exports.validateFilePath = exports.validateOutfileName
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("./fs");
 /**
- * Gets the complete out file path from the source file path and output
+ * Gets the complete out file path from an output file name and parent
  * directory path.
  *
- * @param srcFilePath - The source file path
- * @param outDir - The out file directory
- * @returns - The complete out file path
+ * @param outDir - The path to the out file's parent directory.
+ * @param outFileName - The out file's name.
+ * @returns The complete path to the out file.
  */
 function getOutfilePath(outDir, outFileName) {
     return path_1.default.join(outDir, outFileName || 'bundle.js');
 }
 exports.getOutfilePath = getOutfilePath;
 /**
- * Ensures that the outfile name is just a js file name.
- * Throws on validation failure
+ * Ensures that the outfile name is just a `.js` file name.
+ * Throws on validation failure.
  *
- * @param filename - The file name to validate
- * @returns - True if validation succeeded
+ * @param filename - The file name to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the file name is invalid.
  */
 function validateOutfileName(filename) {
     if (!filename.endsWith('.js') ||
@@ -35,11 +36,11 @@ function validateOutfileName(filename) {
 }
 exports.validateOutfileName = validateOutfileName;
 /**
- * Validates a file path.
- * Throws on validation failure
+ * Validates a file path. Throws on validation failure.
  *
- * @param filePath - The file path to validate
- * @returns - True if validation succeeded
+ * @param filePath - The file path to validate.
+ * @returns `true` if validation succeeded.
+ * @throws If the path does not resolve to a file.
  */
 async function validateFilePath(filePath) {
     const exists = await (0, fs_1.isFile)(filePath);
@@ -50,17 +51,17 @@ async function validateFilePath(filePath) {
 }
 exports.validateFilePath = validateFilePath;
 /**
- * Validates a directory path.
- * Throws on validation failure.
+ * Validates a directory path. Throws on validation failure.
  *
- * @param dirPath - The directory path to validate
- * @param createDir - Whether to create the directory if it doesn't exist
- * @returns - True if validation succeeded
+ * @param dirPath - The directory path to validate.
+ * @param createDir - Whether to create the directory if it doesn't exist.
+ * @returns `true` if validation succeeded or the directory was created.
+ * @throws If the directory does not exist or could not be created.
  */
-async function validateDirPath(dirName, createDir) {
-    const exists = await (0, fs_1.isDirectory)(dirName, createDir);
+async function validateDirPath(dirPath, createDir) {
+    const exists = await (0, fs_1.isDirectory)(dirPath, createDir);
     if (!exists) {
-        throw new Error(`Invalid params: '${dirName}' is not a directory or could not be created.`);
+        throw new Error(`Invalid params: '${dirPath}' is not a directory or could not be created.`);
     }
     return true;
 }

package/dist/utils/validate-fs.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate-fs.js","sourceRoot":"","sources":["../../src/utils/validate-fs.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA6B;AAC7B,6BAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,cAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC5B;QACA,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;KAC1E;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,WAAM,EAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,IAAA,gBAAW,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,0CAWC","sourcesContent":["import pathUtils from 'path';\nimport { isFile, isDirectory } from './fs';\n\n/**\n * Gets the complete out file path from the source file path and output\n * directory path.\n *\n * @param srcFilePath - The source file path\n * @param outDir - The out file directory\n * @returns - The complete out file path\n */\nexport function getOutfilePath(outDir: string, outFileName: string): string {\n  return pathUtils.join(outDir, outFileName || 'bundle.js');\n}\n\n/**\n * Ensures that the outfile name is just a js file name.\n * Throws on validation failure\n *\n * @param filename - The file name to validate\n * @returns - True if validation succeeded\n */\nexport function validateOutfileName(filename: string): boolean {\n  if (\n    !filename.endsWith('.js') ||\n    filename === '.js' ||\n    filename.indexOf('/') !== -1\n  ) {\n    throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);\n  }\n  return true;\n}\n\n/**\n * Validates a file path.\n * Throws on validation failure\n *\n * @param filePath - The file path to validate\n * @returns - True if validation succeeded\n */\nexport async function validateFilePath(filePath: string): Promise<boolean> {\n  const exists = await isFile(filePath);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${filePath}' is not a file or does not exist.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Validates a directory path.\n * Throws on validation failure.\n *\n * @param dirPath - The directory path to validate\n * @param createDir - Whether to create the directory if it doesn't exist\n * @returns - True if validation succeeded\n */\nexport async function validateDirPath(\n  dirName: string,\n  createDir: boolean,\n): Promise<boolean> {\n  const exists = await isDirectory(dirName, createDir);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${dirName}' is not a directory or could not be created.`,\n    );\n  }\n  return true;\n}\n"]}
+{"version":3,"file":"validate-fs.js","sourceRoot":"","sources":["../../src/utils/validate-fs.ts"],"names":[],"mappings":";;;;;;AAAA,gDAA6B;AAC7B,6BAA2C;AAE3C;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,WAAmB;IAChE,OAAO,cAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,WAAW,CAAC,CAAC;AAC5D,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzB,QAAQ,KAAK,KAAK;QAClB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC5B;QACA,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,sBAAsB,CAAC,CAAC;KAC1E;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AATD,kDASC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CAAC,QAAgB;IACrD,MAAM,MAAM,GAAG,MAAM,IAAA,WAAM,EAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,oCAAoC,CACjE,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,SAAkB;IAElB,MAAM,MAAM,GAAG,MAAM,IAAA,gBAAW,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,oBAAoB,OAAO,+CAA+C,CAC3E,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,0CAWC","sourcesContent":["import pathUtils from 'path';\nimport { isFile, isDirectory } from './fs';\n\n/**\n * Gets the complete out file path from an output file name and parent\n * directory path.\n *\n * @param outDir - The path to the out file's parent directory.\n * @param outFileName - The out file's name.\n * @returns The complete path to the out file.\n */\nexport function getOutfilePath(outDir: string, outFileName: string): string {\n  return pathUtils.join(outDir, outFileName || 'bundle.js');\n}\n\n/**\n * Ensures that the outfile name is just a `.js` file name.\n * Throws on validation failure.\n *\n * @param filename - The file name to validate.\n * @returns `true` if validation succeeded.\n * @throws If the file name is invalid.\n */\nexport function validateOutfileName(filename: string): boolean {\n  if (\n    !filename.endsWith('.js') ||\n    filename === '.js' ||\n    filename.indexOf('/') !== -1\n  ) {\n    throw new Error(`Invalid outfile name: ${filename}. Must be a .js file`);\n  }\n  return true;\n}\n\n/**\n * Validates a file path. Throws on validation failure.\n *\n * @param filePath - The file path to validate.\n * @returns `true` if validation succeeded.\n * @throws If the path does not resolve to a file.\n */\nexport async function validateFilePath(filePath: string): Promise<boolean> {\n  const exists = await isFile(filePath);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${filePath}' is not a file or does not exist.`,\n    );\n  }\n  return true;\n}\n\n/**\n * Validates a directory path. Throws on validation failure.\n *\n * @param dirPath - The directory path to validate.\n * @param createDir - Whether to create the directory if it doesn't exist.\n * @returns `true` if validation succeeded or the directory was created.\n * @throws If the directory does not exist or could not be created.\n */\nexport async function validateDirPath(\n  dirPath: string,\n  createDir: boolean,\n): Promise<boolean> {\n  const exists = await isDirectory(dirPath, createDir);\n  if (!exists) {\n    throw new Error(\n      `Invalid params: '${dirPath}' is not a directory or could not be created.`,\n    );\n  }\n  return true;\n}\n"]}