@metamask/snaps-cli 1.0.1 → 2.0.0

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

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

@@ -1,117 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyConfig = exports.loadConfig = exports.isSnapConfig = exports.SnapConfigStruct = void 0;
-const utils_1 = require("@metamask/utils");
-const path_1 = __importDefault(require("path"));
-const superstruct_1 = require("superstruct");
-const yargs_parser_1 = __importDefault(require("yargs-parser"));
-const builders_1 = __importDefault(require("../builders"));
-const misc_1 = require("./misc");
-exports.SnapConfigStruct = (0, superstruct_1.object)({
-    cliOptions: (0, superstruct_1.optional)((0, superstruct_1.object)()),
-    bundlerCustomizer: (0, superstruct_1.optional)((0, superstruct_1.func)()),
-});
-/**
- * Check if the given value is a {@link SnapConfig} object. Note that this
- * function does not check the validity of the `bundleCustomizer` property, as
- * it is not possible to check the validity of a function in JavaScript.
- *
- * @param value - The value to check.
- * @returns `true` if the value is a valid {@link SnapConfig} object, `false`
- * otherwise.
- */
-function isSnapConfig(value) {
-    return (0, superstruct_1.is)(value, exports.SnapConfigStruct);
-}
-exports.isSnapConfig = isSnapConfig;
-let snapConfigCache;
-/**
- * Attempt to load the snap config file (`snap.config.js`). By default will use
- * 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) {
-        return snapConfigCache;
-    }
-    let config;
-    try {
-        // eslint-disable-next-line node/global-require, import/no-dynamic-require, @typescript-eslint/no-require-imports
-        config = require(path_1.default.resolve(process.cwd(), misc_1.CONFIG_FILE));
-    }
-    catch (error) {
-        if (error.code === 'MODULE_NOT_FOUND') {
-            snapConfigCache = {};
-            return snapConfigCache;
-        }
-        (0, misc_1.logError)(`Error during parsing of ${misc_1.CONFIG_FILE}`, error);
-        return process.exit(1);
-    }
-    if (!isSnapConfig(config)) {
-        (0, misc_1.logError)(`Can't validate ${misc_1.CONFIG_FILE}. Ensure it's a proper javascript file and abides with the structure of a snap configuration file`);
-        return process.exit(1);
-    }
-    snapConfigCache = config;
-    return config;
-}
-exports.loadConfig = loadConfig;
-// Note that the below function is necessary because yargs' .config() function
-// leaves much to be desired.
-//
-// In particular, it will set all properties included in the config file
-// regardless of the command, which fails during validation.
-/**
- * Attempts to read configuration options for package.json and the config file,
- * and apply them to argv if they weren't already set.
- *
- * 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
-    // getOptions. This function returns an object with properties "key" and
-    // "alias", which specify the options associated with the current command and
-    // their aliases, respectively.
-    //
-    // We leverage this to ensure that the config is only applied to args that are
-    // valid for the current command, and that weren't specified by the user on
-    // the command line.
-    //
-    // If we set args that aren't valid for the current command, yargs will error
-    // during validation.
-    const { alias: aliases, key: options } = yargsInstance.getOptions();
-    const parsedProcessArgv = (0, yargs_parser_1.default)(processArgv, {
-        alias: aliases,
-    });
-    delete parsedProcessArgv._; // irrelevant yargs parser artifact
-    const commandOptions = new Set(Object.keys(options));
-    const shouldSetArg = (key) => {
-        return commandOptions.has(key) && !(0, utils_1.hasProperty)(parsedProcessArgv, key);
-    };
-    const config = snapConfig.cliOptions ?? {};
-    for (const key of Object.keys(config)) {
-        if ((0, utils_1.hasProperty)(builders_1.default, key)) {
-            if (shouldSetArg(key)) {
-                yargsArgv[key] = config[key];
-            }
-        }
-        else {
-            (0, misc_1.logError)(`Error: Encountered unrecognized config property "options.${key}" in config file "${misc_1.CONFIG_FILE}". Remove the property and try again.`);
-            process.exit(1);
-        }
-    }
-}
-exports.applyConfig = applyConfig;
-//# sourceMappingURL=snap-config.js.map

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

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