@metamask/snaps-cli 0.37.1-flask.1 → 0.38.1-flask.1

package/dist/esm/webpack/plugins.js

@@ -0,0 +1,343 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+function _class_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return fn;
+}
+function _class_private_method_init(obj, privateSet) {
+    _check_private_redeclaration(obj, privateSet);
+    privateSet.add(obj);
+}
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { indent } from '@metamask/snaps-utils';
+import { assert, hasProperty, isObject } from '@metamask/utils';
+import { dim, red, yellow } from 'chalk';
+import { isBuiltin } from 'module';
+import { evaluate } from '../commands/eval';
+import { error, getErrorMessage, info, warn } from '../utils';
+import { pluralize } from './utils';
+var _spinner = /*#__PURE__*/ new WeakMap(), /**
+   * Get the error message for the given stats error.
+   *
+   * @param statsError - The stats error.
+   * @returns The error message.
+   */ _getStatsErrorMessage = /*#__PURE__*/ new WeakSet();
+/**
+ * A plugin that logs the stats after compilation. This is useful for logging
+ * the number of files compiled, and the time taken to compile them.
+ */ export class SnapsStatsPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        compiler.hooks.afterDone.tap(this.constructor.name, (stats)=>{
+            if (!stats) {
+                return;
+            }
+            const { modules, time, errors } = stats.toJson();
+            assert(modules, 'Modules must be defined in stats.');
+            assert(time, 'Time must be defined in stats.');
+            if (errors?.length) {
+                const formattedErrors = errors.map(_class_private_method_get(this, _getStatsErrorMessage, getStatsErrorMessage).bind(this)).join('\n\n');
+                error(`Compiled ${modules.length} ${pluralize(modules.length, 'file')} in ${time}ms with ${errors.length} ${pluralize(errors.length, 'error')}.\n\n${formattedErrors}\n`, _class_private_field_get(this, _spinner));
+                _class_private_field_get(this, _spinner)?.stop();
+                process.exitCode = 1;
+                return;
+            }
+            info(`Compiled ${modules.length} ${pluralize(modules.length, 'file')} in ${time}ms.`, _class_private_field_get(this, _spinner));
+            if (compiler.watchMode) {
+                // The spinner may be restarted by the watch plugin, outside of the
+                // `executeSteps` flow, so we stop it here just in case.
+                _class_private_field_get(this, _spinner)?.succeed('Done!');
+            }
+        });
+    }
+    constructor(options = {
+        verbose: false
+    }, spinner){
+        _class_private_method_init(this, _getStatsErrorMessage);
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner, spinner);
+    }
+}
+function getStatsErrorMessage(statsError) {
+    const baseMessage = this.options.verbose ? getErrorMessage(statsError) : statsError.message;
+    const [first, ...rest] = baseMessage.split('\n');
+    return [
+        indent(red(`• ${first}`), 2),
+        ...rest.map((message)=>indent(red(message), 4)),
+        statsError.details && indent(dim(statsError.details), 4)
+    ].filter(Boolean).join('\n');
+}
+var _spinner1 = /*#__PURE__*/ new WeakMap(), _safeEvaluate = /*#__PURE__*/ new WeakSet();
+/**
+ * A plugin that adds extra files to watch. This is useful for watching files
+ * that are not imported by the entry point, such as the `snap.manifest.json`
+ * file.
+ */ export class SnapsWatchPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        compiler.hooks.invalid.tap(this.constructor.name, (file)=>{
+            _class_private_field_get(this, _spinner1)?.start();
+            info(`Changes detected in ${yellow(file)}, recompiling.`, _class_private_field_get(this, _spinner1));
+        });
+        compiler.hooks.afterEmit.tapPromise(this.constructor.name, async ({ fileDependencies })=>{
+            this.options.files?.forEach(fileDependencies.add.bind(fileDependencies));
+            if (this.options.bundle && this.options.evaluate) {
+                await _class_private_method_get(this, _safeEvaluate, safeEvaluate).call(this, this.options.bundle);
+            }
+        });
+    }
+    constructor(options, spinner){
+        /**
+   * Safely evaluate the bundle at the given path. If an error occurs, it will
+   * be logged to the console, rather than throwing an error.
+   *
+   * This function should never throw an error.
+   *
+   * @param bundlePath - The path to the bundle.
+   */ _class_private_method_init(this, _safeEvaluate);
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner1, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner1, spinner);
+    }
+}
+async function safeEvaluate(bundlePath) {
+    try {
+        await evaluate(bundlePath);
+        info(`Snap bundle evaluated successfully.`, _class_private_field_get(this, _spinner1));
+    } catch (evaluateError) {
+        error(evaluateError.message, _class_private_field_get(this, _spinner1));
+    }
+}
+var _source = /*#__PURE__*/ new WeakMap(), _spinner2 = /*#__PURE__*/ new WeakMap();
+/**
+ * A plugin that logs a message when a built-in module is not resolved. The
+ * MetaMask Snaps CLI does not support built-in modules by default, and this
+ * plugin is used to warn the user when they try to import a built-in module,
+ * when no fallback is configured.
+ */ export class SnapsBuiltInResolver {
+    /**
+   * Apply the plugin to the Webpack resolver.
+   *
+   * @param resolver - The Webpack resolver.
+   */ apply(resolver) {
+        resolver.getHook(_class_private_field_get(this, _source)).tapAsync(this.constructor.name, ({ module: isModule, request }, _, callback)=>{
+            if (!isModule || !request) {
+                return callback();
+            }
+            const baseRequest = request.split('/')[0];
+            if (isBuiltin(baseRequest) && !this.options.ignore?.includes(baseRequest)) {
+                const fallback = resolver.options.fallback.find(({ name })=>name === baseRequest);
+                if (fallback && !fallback.alias) {
+                    this.unresolvedModules.add(baseRequest);
+                }
+            }
+            return callback();
+        });
+    }
+    constructor(options = {
+        ignore: []
+    }, spinner){
+        /**
+   * The built-in modules that have been imported, but not resolved.
+   */ _define_property(this, "unresolvedModules", new Set());
+        /**
+   * The name of the resolver hook to tap into.
+   */ _class_private_field_init(this, _source, {
+            writable: true,
+            value: 'described-resolve'
+        });
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner2, {
+            writable: true,
+            value: void 0
+        });
+        this.options = options;
+        _class_private_field_set(this, _spinner2, spinner);
+    }
+}
+var _spinner3 = /*#__PURE__*/ new WeakMap(), /**
+   * Check if a built-in module is used, but not provided by Webpack's
+   * `fallback` configuration.
+   *
+   * @param compiler - The Webpack compiler.
+   */ _checkBuiltIns = /*#__PURE__*/ new WeakSet(), /**
+   * Check if the given instance is a `ProvidePlugin`. This is not guaranteed to
+   * be accurate, but it's good enough for our purposes. If we were to use
+   * `instanceof` instead, it might not work if multiple versions of Webpack are
+   * installed.
+   *
+   * @param instance - The instance to check.
+   * @returns Whether the instance is a `ProvidePlugin`, i.e., whether it's an
+   * object with the name `ProvidePlugin` and a `definitions` property.
+   */ _isProvidePlugin = /*#__PURE__*/ new WeakSet(), /**
+   * Check if the `Buffer` global is used, but not provided by Webpack's
+   * `DefinePlugin`.
+   *
+   * @param compiler - The Webpack compiler.
+   */ _checkBuffer = /*#__PURE__*/ new WeakSet();
+/**
+ * A plugin that logs a message when:
+ *
+ * - A built-in module is not resolved. The MetaMask Snaps CLI does not support
+ * built-in modules by default, and this plugin is used to warn the user when
+ * they try to import a built-in module, when no fallback is configured.
+ * - A snap uses the `Buffer` global. The MetaMask Snaps CLI does not support
+ * the `Buffer` global by default, and this plugin is used to warn the user when
+ * they try to use the `Buffer` global.
+ *
+ * We use both a resolver and a plugin, because the resolver is used to detect
+ * when a built-in module is imported, and the plugin is used to log a single
+ * message when the compilation is complete. We can't do everything in a single
+ * plugin, because the resolver doesn't have access to the compilation, and the
+ * plugin doesn't have access to the resolver.
+ */ export class SnapsBundleWarningsPlugin {
+    /**
+   * Apply the plugin to the Webpack compiler.
+   *
+   * @param compiler - The Webpack compiler.
+   */ apply(compiler) {
+        if (this.options.builtIns) {
+            _class_private_method_get(this, _checkBuiltIns, checkBuiltIns).call(this, compiler);
+        }
+        if (this.options.buffer) {
+            _class_private_method_get(this, _checkBuffer, checkBuffer).call(this, compiler);
+        }
+    }
+    constructor(options = {
+        buffer: true,
+        builtIns: true
+    }, spinner){
+        _class_private_method_init(this, _checkBuiltIns);
+        _class_private_method_init(this, _isProvidePlugin);
+        _class_private_method_init(this, _checkBuffer);
+        /**
+   * The spinner to use for logging.
+   */ _class_private_field_init(this, _spinner3, {
+            writable: true,
+            value: void 0
+        });
+        /**
+   * The options for the plugin.
+   */ _define_property(this, "options", void 0);
+        this.options = options;
+        _class_private_field_set(this, _spinner3, spinner);
+    }
+}
+function checkBuiltIns(compiler) {
+    compiler.hooks.afterCompile.tap(this.constructor.name, ()=>{
+        if (!this.options.builtInResolver) {
+            return;
+        }
+        const { unresolvedModules } = this.options.builtInResolver;
+        if (unresolvedModules.size === 0) {
+            return;
+        }
+        const formattedModules = new Array(...unresolvedModules).map((name)=>indent(`• ${name}`, 2)).join('\n');
+        warn(`The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided.\n` + `The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must provide a fallback: https://webpack.js.org/configuration/resolve/#resolvefallback.\n` + `To disable this warning, set ${yellow('`stats.builtIns`')} to ${yellow('`false`')} in your snap config file, or add the module to the ${yellow('`stats.builtIns.ignore`')} array.\n\n${formattedModules}\n`, _class_private_field_get(this, _spinner3));
+    });
+}
+function isProvidePlugin(instance) {
+    return isObject(instance) && instance.constructor.name === 'ProvidePlugin' && hasProperty(instance, 'definitions');
+}
+function checkBuffer(compiler) {
+    const plugin = compiler.options.plugins?.find((instance)=>_class_private_method_get(this, _isProvidePlugin, isProvidePlugin).call(this, instance));
+    // If the `ProvidePlugin` is configured to provide `Buffer`, then we don't
+    // need to warn the user.
+    if (plugin) {
+        const { definitions } = plugin;
+        if (definitions.Buffer) {
+            return;
+        }
+    }
+    compiler.hooks.compilation.tap(this.constructor.name, (compilation)=>{
+        compilation.hooks.afterProcessAssets.tap(this.constructor.name, (assets)=>{
+            // Check if assets use `Buffer`.
+            const bufferAssets = Object.entries(assets).filter(([name])=>name.endsWith('.js')).filter(([, asset])=>asset.source().includes('Buffer'));
+            if (bufferAssets.length === 0) {
+                return;
+            }
+            warn(`The snap attempted to use the Node.js Buffer global, which is not supported by the MetaMask Snaps CLI.\n` + `To use the Buffer global, you must use the ${yellow('`ProvidePlugin`')} to inject it: https://webpack.js.org/plugins/provide-plugin/.\n` + `To disable this warning, set ${yellow('`stats.buffer`')} to ${yellow('`false`')} in your snap config file.`, _class_private_field_get(this, _spinner3));
+        });
+    });
+}
+
+//# sourceMappingURL=plugins.js.map

package/dist/esm/webpack/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webpack/plugins.ts"],"sourcesContent":["import { indent } from '@metamask/snaps-utils';\nimport { assert, hasProperty, isObject } from '@metamask/utils';\nimport { dim, red, yellow } from 'chalk';\nimport { isBuiltin } from 'module';\nimport type { Ora } from 'ora';\nimport type {\n  Compiler,\n  ProvidePlugin,\n  ResolvePluginInstance,\n  Resolver,\n  StatsError,\n  WebpackPluginInstance,\n} from 'webpack';\n\nimport { evaluate } from '../commands/eval';\nimport { error, getErrorMessage, info, warn } from '../utils';\nimport { pluralize } from './utils';\n\nexport type SnapsStatsPluginOptions = {\n  /**\n   * Whether to log the verbose stats.\n   */\n  verbose?: boolean;\n};\n\n/**\n * A plugin that logs the stats after compilation. This is useful for logging\n * the number of files compiled, and the time taken to compile them.\n */\nexport class SnapsStatsPlugin implements WebpackPluginInstance {\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsStatsPluginOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(\n    options: SnapsStatsPluginOptions = {\n      verbose: false,\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    compiler.hooks.afterDone.tap(this.constructor.name, (stats) => {\n      if (!stats) {\n        return;\n      }\n\n      const { modules, time, errors } = stats.toJson();\n\n      assert(modules, 'Modules must be defined in stats.');\n      assert(time, 'Time must be defined in stats.');\n\n      if (errors?.length) {\n        const formattedErrors = errors\n          .map(this.#getStatsErrorMessage.bind(this))\n          .join('\\n\\n');\n\n        error(\n          `Compiled ${modules.length} ${pluralize(\n            modules.length,\n            'file',\n          )} in ${time}ms with ${errors.length} ${pluralize(\n            errors.length,\n            'error',\n          )}.\\n\\n${formattedErrors}\\n`,\n          this.#spinner,\n        );\n\n        this.#spinner?.stop();\n\n        process.exitCode = 1;\n        return;\n      }\n\n      info(\n        `Compiled ${modules.length} ${pluralize(\n          modules.length,\n          'file',\n        )} in ${time}ms.`,\n        this.#spinner,\n      );\n\n      if (compiler.watchMode) {\n        // The spinner may be restarted by the watch plugin, outside of the\n        // `executeSteps` flow, so we stop it here just in case.\n        this.#spinner?.succeed('Done!');\n      }\n    });\n  }\n\n  /**\n   * Get the error message for the given stats error.\n   *\n   * @param statsError - The stats error.\n   * @returns The error message.\n   */\n  #getStatsErrorMessage(statsError: StatsError) {\n    const baseMessage = this.options.verbose\n      ? getErrorMessage(statsError)\n      : statsError.message;\n\n    const [first, ...rest] = baseMessage.split('\\n');\n\n    return [\n      indent(red(`• ${first}`), 2),\n      ...rest.map((message) => indent(red(message), 4)),\n      statsError.details && indent(dim(statsError.details), 4),\n    ]\n      .filter(Boolean)\n      .join('\\n');\n  }\n}\n\n/**\n * The options for the {@link SnapsWatchPlugin}.\n */\nexport type SnapsWatchPluginOptions = {\n  /**\n   * The bundle path. This is the file that will be evaluated, if the `evaluate`\n   * option is set.\n   */\n  bundle?: string;\n\n  /**\n   * Whether to evaluate the bundle. This only applies if the `bundle` option is\n   * set.\n   */\n  evaluate?: boolean;\n\n  /**\n   * The extra files to watch.\n   */\n  files?: string[];\n};\n\n/**\n * A plugin that adds extra files to watch. This is useful for watching files\n * that are not imported by the entry point, such as the `snap.manifest.json`\n * file.\n */\nexport class SnapsWatchPlugin implements WebpackPluginInstance {\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsWatchPluginOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(options: SnapsWatchPluginOptions, spinner?: Ora) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    compiler.hooks.invalid.tap(this.constructor.name, (file) => {\n      this.#spinner?.start();\n      info(`Changes detected in ${yellow(file)}, recompiling.`, this.#spinner);\n    });\n\n    compiler.hooks.afterEmit.tapPromise(\n      this.constructor.name,\n      async ({ fileDependencies }) => {\n        this.options.files?.forEach(\n          fileDependencies.add.bind(fileDependencies),\n        );\n\n        if (this.options.bundle && this.options.evaluate) {\n          await this.#safeEvaluate(this.options.bundle);\n        }\n      },\n    );\n  }\n\n  /**\n   * Safely evaluate the bundle at the given path. If an error occurs, it will\n   * be logged to the console, rather than throwing an error.\n   *\n   * This function should never throw an error.\n   *\n   * @param bundlePath - The path to the bundle.\n   */\n  async #safeEvaluate(bundlePath: string) {\n    try {\n      await evaluate(bundlePath);\n      info(`Snap bundle evaluated successfully.`, this.#spinner);\n    } catch (evaluateError) {\n      error(evaluateError.message, this.#spinner);\n    }\n  }\n}\n\n/**\n * The options for the {@link SnapsBuiltInResolver}.\n */\nexport type SnapsBuiltInResolverOptions = {\n  /**\n   * The built-in modules to ignore.\n   */\n  ignore?: string[];\n};\n\n/**\n * A plugin that logs a message when a built-in module is not resolved. The\n * MetaMask Snaps CLI does not support built-in modules by default, and this\n * plugin is used to warn the user when they try to import a built-in module,\n * when no fallback is configured.\n */\nexport class SnapsBuiltInResolver implements ResolvePluginInstance {\n  /**\n   * The built-in modules that have been imported, but not resolved.\n   */\n  readonly unresolvedModules = new Set<string>();\n\n  /**\n   * The name of the resolver hook to tap into.\n   */\n  readonly #source = 'described-resolve';\n\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsBuiltInResolverOptions;\n\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  constructor(\n    options: SnapsBuiltInResolverOptions = {\n      ignore: [],\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack resolver.\n   *\n   * @param resolver - The Webpack resolver.\n   */\n  apply(resolver: Resolver) {\n    resolver\n      .getHook(this.#source)\n      .tapAsync(\n        this.constructor.name,\n        ({ module: isModule, request }, _, callback) => {\n          if (!isModule || !request) {\n            return callback();\n          }\n\n          const baseRequest = request.split('/')[0];\n          if (\n            isBuiltin(baseRequest) &&\n            !this.options.ignore?.includes(baseRequest)\n          ) {\n            const fallback = resolver.options.fallback.find(\n              ({ name }) => name === baseRequest,\n            );\n\n            if (fallback && !fallback.alias) {\n              this.unresolvedModules.add(baseRequest);\n            }\n          }\n\n          return callback();\n        },\n      );\n  }\n}\n\n/**\n * The options for the {@link SnapsBundleWarningsPlugin}.\n */\nexport type SnapsBundleWarningsPluginOptions = {\n  /**\n   * The {@link SnapsBuiltInResolver} instance to use for detecting built-in\n   * modules.\n   */\n  builtInResolver?: SnapsBuiltInResolver | false;\n\n  /**\n   * Whether to show warnings if built-in modules are used, but not provided by\n   * Webpack's `fallback` configuration.\n   */\n  builtIns?: boolean;\n\n  /**\n   * Whether to show warnings if the `Buffer` global is used, but not provided\n   * by Webpack's `DefinePlugin`.\n   */\n  buffer?: boolean;\n};\n\n/**\n * A plugin that logs a message when:\n *\n * - A built-in module is not resolved. The MetaMask Snaps CLI does not support\n * built-in modules by default, and this plugin is used to warn the user when\n * they try to import a built-in module, when no fallback is configured.\n * - A snap uses the `Buffer` global. The MetaMask Snaps CLI does not support\n * the `Buffer` global by default, and this plugin is used to warn the user when\n * they try to use the `Buffer` global.\n *\n * We use both a resolver and a plugin, because the resolver is used to detect\n * when a built-in module is imported, and the plugin is used to log a single\n * message when the compilation is complete. We can't do everything in a single\n * plugin, because the resolver doesn't have access to the compilation, and the\n * plugin doesn't have access to the resolver.\n */\n\nexport class SnapsBundleWarningsPlugin implements WebpackPluginInstance {\n  /**\n   * The spinner to use for logging.\n   */\n  readonly #spinner?: Ora;\n\n  /**\n   * The options for the plugin.\n   */\n  readonly options: SnapsBundleWarningsPluginOptions;\n\n  constructor(\n    options: SnapsBundleWarningsPluginOptions = {\n      buffer: true,\n      builtIns: true,\n    },\n    spinner?: Ora,\n  ) {\n    this.options = options;\n    this.#spinner = spinner;\n  }\n\n  /**\n   * Apply the plugin to the Webpack compiler.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  apply(compiler: Compiler) {\n    if (this.options.builtIns) {\n      this.#checkBuiltIns(compiler);\n    }\n\n    if (this.options.buffer) {\n      this.#checkBuffer(compiler);\n    }\n  }\n\n  /**\n   * Check if a built-in module is used, but not provided by Webpack's\n   * `fallback` configuration.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  #checkBuiltIns(compiler: Compiler) {\n    compiler.hooks.afterCompile.tap(this.constructor.name, () => {\n      if (!this.options.builtInResolver) {\n        return;\n      }\n\n      const { unresolvedModules } = this.options.builtInResolver;\n      if (unresolvedModules.size === 0) {\n        return;\n      }\n\n      const formattedModules = new Array(...unresolvedModules)\n        .map((name) => indent(`• ${name}`, 2))\n        .join('\\n');\n\n      warn(\n        `The snap attempted to use one or more Node.js builtins, but no browser fallback has been provided.\\n` +\n          `The MetaMask Snaps CLI does not support Node.js builtins by default. If you want to use this module, you must provide a fallback: https://webpack.js.org/configuration/resolve/#resolvefallback.\\n` +\n          `To disable this warning, set ${yellow(\n            '`stats.builtIns`',\n          )} to ${yellow(\n            '`false`',\n          )} in your snap config file, or add the module to the ${yellow(\n            '`stats.builtIns.ignore`',\n          )} array.\\n\\n${formattedModules}\\n`,\n        this.#spinner,\n      );\n    });\n  }\n\n  /**\n   * Check if the given instance is a `ProvidePlugin`. This is not guaranteed to\n   * be accurate, but it's good enough for our purposes. If we were to use\n   * `instanceof` instead, it might not work if multiple versions of Webpack are\n   * installed.\n   *\n   * @param instance - The instance to check.\n   * @returns Whether the instance is a `ProvidePlugin`, i.e., whether it's an\n   * object with the name `ProvidePlugin` and a `definitions` property.\n   */\n  #isProvidePlugin(instance: unknown): instance is ProvidePlugin {\n    return (\n      isObject(instance) &&\n      instance.constructor.name === 'ProvidePlugin' &&\n      hasProperty(instance, 'definitions')\n    );\n  }\n\n  /**\n   * Check if the `Buffer` global is used, but not provided by Webpack's\n   * `DefinePlugin`.\n   *\n   * @param compiler - The Webpack compiler.\n   */\n  #checkBuffer(compiler: Compiler) {\n    const plugin = compiler.options.plugins?.find((instance) =>\n      this.#isProvidePlugin(instance),\n    ) as ProvidePlugin | undefined;\n\n    // If the `ProvidePlugin` is configured to provide `Buffer`, then we don't\n    // need to warn the user.\n    if (plugin) {\n      const { definitions } = plugin;\n      if (definitions.Buffer) {\n        return;\n      }\n    }\n\n    compiler.hooks.compilation.tap(this.constructor.name, (compilation) => {\n      compilation.hooks.afterProcessAssets.tap(\n        this.constructor.name,\n        (assets) => {\n          // Check if assets use `Buffer`.\n          const bufferAssets = Object.entries(assets)\n            .filter(([name]) => name.endsWith('.js'))\n            .filter(([, asset]) => asset.source().includes('Buffer'));\n\n          if (bufferAssets.length === 0) {\n            return;\n          }\n\n          warn(\n            `The snap attempted to use the Node.js Buffer global, which is not supported by the MetaMask Snaps CLI.\\n` +\n              `To use the Buffer global, you must use the ${yellow(\n                '`ProvidePlugin`',\n              )} to inject it: https://webpack.js.org/plugins/provide-plugin/.\\n` +\n              `To disable this warning, set ${yellow(\n                '`stats.buffer`',\n              )} to ${yellow('`false`')} in your snap config file.`,\n            this.#spinner,\n          );\n        },\n      );\n    });\n  }\n}\n"],"names":["indent","assert","hasProperty","isObject","dim","red","yellow","isBuiltin","evaluate","error","getErrorMessage","info","warn","pluralize","SnapsStatsPlugin","apply","compiler","hooks","afterDone","tap","constructor","name","stats","modules","time","errors","toJson","length","formattedErrors","map","getStatsErrorMessage","bind","join","spinner","stop","process","exitCode","watchMode","succeed","options","verbose","statsError","baseMessage","message","first","rest","split","details","filter","Boolean","SnapsWatchPlugin","invalid","file","start","afterEmit","tapPromise","fileDependencies","files","forEach","add","bundle","safeEvaluate","bundlePath","evaluateError","SnapsBuiltInResolver","resolver","getHook","source","tapAsync","module","isModule","request","_","callback","baseRequest","ignore","includes","fallback","find","alias","unresolvedModules","Set","SnapsBundleWarningsPlugin","builtIns","checkBuiltIns","buffer","checkBuffer","afterCompile","builtInResolver","size","formattedModules","Array","instance","plugin","plugins","isProvidePlugin","definitions","Buffer","compilation","afterProcessAssets","assets","bufferAssets","Object","entries","endsWith","asset"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAASA,MAAM,QAAQ,wBAAwB;AAC/C,SAASC,MAAM,EAAEC,WAAW,EAAEC,QAAQ,QAAQ,kBAAkB;AAChE,SAASC,GAAG,EAAEC,GAAG,EAAEC,MAAM,QAAQ,QAAQ;AACzC,SAASC,SAAS,QAAQ,SAAS;AAWnC,SAASC,QAAQ,QAAQ,mBAAmB;AAC5C,SAASC,KAAK,EAAEC,eAAe,EAAEC,IAAI,EAAEC,IAAI,QAAQ,WAAW;AAC9D,SAASC,SAAS,QAAQ,UAAU;IAsBzB,wCAkET;;;;;GAKC,GACD;AArFF;;;CAGC,GACD,OAAO,MAAMC;IAqBX;;;;GAIC,GACDC,MAAMC,QAAkB,EAAE;QACxBA,SAASC,KAAK,CAACC,SAAS,CAACC,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAACC;YACnD,IAAI,CAACA,OAAO;gBACV;YACF;YAEA,MAAM,EAAEC,OAAO,EAAEC,IAAI,EAAEC,MAAM,EAAE,GAAGH,MAAMI,MAAM;YAE9CzB,OAAOsB,SAAS;YAChBtB,OAAOuB,MAAM;YAEb,IAAIC,QAAQE,QAAQ;gBAClB,MAAMC,kBAAkBH,OACrBI,GAAG,CAAC,0BAAA,IAAI,EAAEC,uBAAAA,sBAAqBC,IAAI,CAAC,IAAI,GACxCC,IAAI,CAAC;gBAERvB,MACE,CAAC,SAAS,EAAEc,QAAQI,MAAM,CAAC,CAAC,EAAEd,UAC5BU,QAAQI,MAAM,EACd,QACA,IAAI,EAAEH,KAAK,QAAQ,EAAEC,OAAOE,MAAM,CAAC,CAAC,EAAEd,UACtCY,OAAOE,MAAM,EACb,SACA,KAAK,EAAEC,gBAAgB,EAAE,CAAC,2BAC5B,IAAI,EAAEK;yCAGR,IAAI,EAAEA,WAASC;gBAEfC,QAAQC,QAAQ,GAAG;gBACnB;YACF;YAEAzB,KACE,CAAC,SAAS,EAAEY,QAAQI,MAAM,CAAC,CAAC,EAAEd,UAC5BU,QAAQI,MAAM,EACd,QACA,IAAI,EAAEH,KAAK,GAAG,CAAC,2BACjB,IAAI,EAAES;YAGR,IAAIjB,SAASqB,SAAS,EAAE;gBACtB,mEAAmE;gBACnE,wDAAwD;yCACxD,IAAI,EAAEJ,WAASK,QAAQ;YACzB;QACF;IACF;IA9DAlB,YACEmB,UAAmC;QACjCC,SAAS;IACX,CAAC,EACDP,OAAa,CACb;QAiEF,iCAAA;QAhFA;;GAEC,GACD,uBAASM,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAQE,IAAI,CAACA,OAAO,GAAGA;uCACTN,UAAUA;IAClB;AA6EF;AAfE,SAAA,qBAAsBQ,UAAsB;IAC1C,MAAMC,cAAc,IAAI,CAACH,OAAO,CAACC,OAAO,GACpC9B,gBAAgB+B,cAChBA,WAAWE,OAAO;IAEtB,MAAM,CAACC,OAAO,GAAGC,KAAK,GAAGH,YAAYI,KAAK,CAAC;IAE3C,OAAO;QACL9C,OAAOK,IAAI,CAAC,EAAE,EAAEuC,MAAM,CAAC,GAAG;WACvBC,KAAKhB,GAAG,CAAC,CAACc,UAAY3C,OAAOK,IAAIsC,UAAU;QAC9CF,WAAWM,OAAO,IAAI/C,OAAOI,IAAIqC,WAAWM,OAAO,GAAG;KACvD,CACEC,MAAM,CAACC,SACPjB,IAAI,CAAC;AACV;IAuCS,yCAwCH;AAtDR;;;;CAIC,GACD,OAAO,MAAMkB;IAgBX;;;;GAIC,GACDnC,MAAMC,QAAkB,EAAE;QACxBA,SAASC,KAAK,CAACkC,OAAO,CAAChC,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAAC+B;qCACjD,IAAI,EAAEnB,YAASoB;YACf1C,KAAK,CAAC,oBAAoB,EAAEL,OAAO8C,MAAM,cAAc,CAAC,2BAAE,IAAI,EAAEnB;QAClE;QAEAjB,SAASC,KAAK,CAACqC,SAAS,CAACC,UAAU,CACjC,IAAI,CAACnC,WAAW,CAACC,IAAI,EACrB,OAAO,EAAEmC,gBAAgB,EAAE;YACzB,IAAI,CAACjB,OAAO,CAACkB,KAAK,EAAEC,QAClBF,iBAAiBG,GAAG,CAAC5B,IAAI,CAACyB;YAG5B,IAAI,IAAI,CAACjB,OAAO,CAACqB,MAAM,IAAI,IAAI,CAACrB,OAAO,CAAC/B,QAAQ,EAAE;gBAChD,MAAM,0BAAA,IAAI,EAAEqD,eAAAA,mBAAN,IAAI,EAAe,IAAI,CAACtB,OAAO,CAACqB,MAAM;YAC9C;QACF;IAEJ;IA5BAxC,YAAYmB,OAAgC,EAAEN,OAAa,CAAE;QA8B7D;;;;;;;GAOC,GACD,iCAAM;QAhDN;;GAEC,GACD,uBAASM,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAGE,IAAI,CAACA,OAAO,GAAGA;uCACTN,WAAUA;IAClB;AA2CF;AARE,eAAA,aAAoB6B,UAAkB;IACpC,IAAI;QACF,MAAMtD,SAASsD;QACfnD,KAAK,CAAC,mCAAmC,CAAC,2BAAE,IAAI,EAAEsB;IACpD,EAAE,OAAO8B,eAAe;QACtBtD,MAAMsD,cAAcpB,OAAO,2BAAE,IAAI,EAAEV;IACrC;AACF;IA4BS,uCAUA;AAzBX;;;;;CAKC,GACD,OAAO,MAAM+B;IA+BX;;;;GAIC,GACDjD,MAAMkD,QAAkB,EAAE;QACxBA,SACGC,OAAO,0BAAC,IAAI,EAAEC,UACdC,QAAQ,CACP,IAAI,CAAChD,WAAW,CAACC,IAAI,EACrB,CAAC,EAAEgD,QAAQC,QAAQ,EAAEC,OAAO,EAAE,EAAEC,GAAGC;YACjC,IAAI,CAACH,YAAY,CAACC,SAAS;gBACzB,OAAOE;YACT;YAEA,MAAMC,cAAcH,QAAQzB,KAAK,CAAC,IAAI,CAAC,EAAE;YACzC,IACEvC,UAAUmE,gBACV,CAAC,IAAI,CAACnC,OAAO,CAACoC,MAAM,EAAEC,SAASF,cAC/B;gBACA,MAAMG,WAAWZ,SAAS1B,OAAO,CAACsC,QAAQ,CAACC,IAAI,CAC7C,CAAC,EAAEzD,IAAI,EAAE,GAAKA,SAASqD;gBAGzB,IAAIG,YAAY,CAACA,SAASE,KAAK,EAAE;oBAC/B,IAAI,CAACC,iBAAiB,CAACrB,GAAG,CAACe;gBAC7B;YACF;YAEA,OAAOD;QACT;IAEN;IA1CArD,YACEmB,UAAuC;QACrCoC,QAAQ,EAAE;IACZ,CAAC,EACD1C,OAAa,CACb;QAzBF;;GAEC,GACD,uBAAS+C,qBAAoB,IAAIC;QAEjC;;GAEC,GACD,gCAAS;;mBAAU;;QAEnB;;GAEC,GACD,uBAAS1C,WAAT,KAAA;QAEA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAQE,IAAI,CAACA,OAAO,GAAGA;uCACTN,WAAUA;IAClB;AAmCF;IA8CW,yCAiCT;;;;;GAKC,GACD,8CA8BA;;;;;;;;;GASC,GACD,gDAQA;;;;;GAKC,GACD;AAlHF;;;;;;;;;;;;;;;CAeC,GAED,OAAO,MAAMiD;IAsBX;;;;GAIC,GACDnE,MAAMC,QAAkB,EAAE;QACxB,IAAI,IAAI,CAACuB,OAAO,CAAC4C,QAAQ,EAAE;YACzB,0BAAA,IAAI,EAAEC,gBAAAA,oBAAN,IAAI,EAAgBpE;QACtB;QAEA,IAAI,IAAI,CAACuB,OAAO,CAAC8C,MAAM,EAAE;YACvB,0BAAA,IAAI,EAAEC,cAAAA,kBAAN,IAAI,EAActE;QACpB;IACF;IAxBAI,YACEmB,UAA4C;QAC1C8C,QAAQ;QACRF,UAAU;IACZ,CAAC,EACDlD,OAAa,CACb;QA0BF,iCAAA;QAwCA,iCAAA;QAcA,iCAAA;QAhGA;;GAEC,GACD,gCAAS;;mBAAT,KAAA;;QAEA;;GAEC,GACD,uBAASM,WAAT,KAAA;QASE,IAAI,CAACA,OAAO,GAAGA;uCACTN,WAAUA;IAClB;AAsHF;AA/FE,SAAA,cAAejB,QAAkB;IAC/BA,SAASC,KAAK,CAACsE,YAAY,CAACpE,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE;QACrD,IAAI,CAAC,IAAI,CAACkB,OAAO,CAACiD,eAAe,EAAE;YACjC;QACF;QAEA,MAAM,EAAER,iBAAiB,EAAE,GAAG,IAAI,CAACzC,OAAO,CAACiD,eAAe;QAC1D,IAAIR,kBAAkBS,IAAI,KAAK,GAAG;YAChC;QACF;QAEA,MAAMC,mBAAmB,IAAIC,SAASX,mBACnCnD,GAAG,CAAC,CAACR,OAASrB,OAAO,CAAC,EAAE,EAAEqB,KAAK,CAAC,EAAE,IAClCW,IAAI,CAAC;QAERpB,KACE,CAAC,oGAAoG,CAAC,GACpG,CAAC,kMAAkM,CAAC,GACpM,CAAC,6BAA6B,EAAEN,OAC9B,oBACA,IAAI,EAAEA,OACN,WACA,oDAAoD,EAAEA,OACtD,2BACA,WAAW,EAAEoF,iBAAiB,EAAE,CAAC,2BACrC,IAAI,EAAEzD;IAEV;AACF;AAYA,SAAA,gBAAiB2D,QAAiB;IAChC,OACEzF,SAASyF,aACTA,SAASxE,WAAW,CAACC,IAAI,KAAK,mBAC9BnB,YAAY0F,UAAU;AAE1B;AAQA,SAAA,YAAa5E,QAAkB;IAC7B,MAAM6E,SAAS7E,SAASuB,OAAO,CAACuD,OAAO,EAAEhB,KAAK,CAACc,WAC7C,0BAAA,IAAI,EAAEG,kBAAAA,sBAAN,IAAI,EAAkBH;IAGxB,0EAA0E;IAC1E,yBAAyB;IACzB,IAAIC,QAAQ;QACV,MAAM,EAAEG,WAAW,EAAE,GAAGH;QACxB,IAAIG,YAAYC,MAAM,EAAE;YACtB;QACF;IACF;IAEAjF,SAASC,KAAK,CAACiF,WAAW,CAAC/E,GAAG,CAAC,IAAI,CAACC,WAAW,CAACC,IAAI,EAAE,CAAC6E;QACrDA,YAAYjF,KAAK,CAACkF,kBAAkB,CAAChF,GAAG,CACtC,IAAI,CAACC,WAAW,CAACC,IAAI,EACrB,CAAC+E;YACC,gCAAgC;YAChC,MAAMC,eAAeC,OAAOC,OAAO,CAACH,QACjCpD,MAAM,CAAC,CAAC,CAAC3B,KAAK,GAAKA,KAAKmF,QAAQ,CAAC,QACjCxD,MAAM,CAAC,CAAC,GAAGyD,MAAM,GAAKA,MAAMtC,MAAM,GAAGS,QAAQ,CAAC;YAEjD,IAAIyB,aAAa1E,MAAM,KAAK,GAAG;gBAC7B;YACF;YAEAf,KACE,CAAC,wGAAwG,CAAC,GACxG,CAAC,2CAA2C,EAAEN,OAC5C,mBACA,gEAAgE,CAAC,GACnE,CAAC,6BAA6B,EAAEA,OAC9B,kBACA,IAAI,EAAEA,OAAO,WAAW,0BAA0B,CAAC,2BACvD,IAAI,EAAE2B;QAEV;IAEJ;AACF"}

package/dist/esm/webpack/utils.js

@@ -0,0 +1,160 @@
+import { dim } from 'chalk';
+import { promises as fs } from 'fs';
+import { dirname, resolve } from 'path';
+export const BROWSERSLIST_FILE = resolve(dirname(// eslint-disable-next-line n/no-extraneous-require
+require.resolve('@metamask/snaps-cli/package.json')), '.browserslistrc');
+/**
+ * Get the default loader for JavaScript and TypeScript files, based on the
+ * config object.
+ *
+ * - If the `legacy` option is set, we use the custom `browserify` loader. This
+ * uses the legacy Browserify config to transpile the code.
+ * - Otherwise, we use the `swc-loader`. This is a Webpack loader that uses the
+ * `SWC` compiler, which is a much faster alternative to Babel and TypeScript's
+ * own compiler.
+ *
+ * @param config - The processed snap Webpack config.
+ * @param config.legacy - The legacy config object, if any.
+ * @param config.sourceMap - Whether to generate source maps.
+ * @see https://swc.rs/docs/usage/swc-loader
+ * @returns The default loader.
+ */ export async function getDefaultLoader({ legacy, sourceMap }) {
+    if (legacy) {
+        return {
+            /**
+       * If the snap uses the legacy config, we use the custom `browserify`
+       * loader. This uses the legacy Browserify config to transpile the code.
+       * This is necessary for backwards compatibility with the
+       * `bundlerCustomizer` function.
+       */ loader: resolve(__dirname, 'loaders', 'browserify'),
+            /**
+       * The options for the `browserify` loader. These can be overridden in the
+       * snap config.
+       */ options: legacy
+        };
+    }
+    const targets = await getBrowserslistTargets();
+    return {
+        /**
+     * We use the `swc-loader` to transpile TypeScript and JavaScript files.
+     * This is a Webpack loader that uses the `SWC` compiler, which is a much
+     * faster alternative to Babel and TypeScript's own compiler.
+     */ loader: 'swc-loader',
+        /**
+     * The options for the `swc-loader`. These can be overridden in the
+     * `.swcrc` file.
+     *
+     * @see https://swc.rs/docs/configuration/swcrc
+     */ options: {
+            sync: false,
+            /**
+       * This tells SWC to generate source maps. We set it to the
+       * `sourceMap` value from the config object.
+       *
+       * This must be enabled if source maps are enabled in the config.
+       */ sourceMaps: Boolean(getDevTool(sourceMap)),
+            jsc: {
+                /**
+         * MetaMask targets ES2020, so we set the target to ES2020. This
+         * ensures that the code is transpiled to ES2020, and that the
+         * necessary polyfills are added.
+         *
+         * @see https://swc.rs/docs/configuration/compilation#jsctarget
+         */ target: 'es2020',
+                parser: {
+                    /**
+           * This tells the parser to parse TypeScript files. If you
+           * don't need to support TypeScript, you can set this to
+           * `ecmascript` instead, but there's no harm in leaving it
+           * as `typescript`.
+           *
+           * @see https://swc.rs/docs/configuration/compilation#jscparser
+           */ syntax: 'typescript'
+                }
+            },
+            /**
+       * The module configuration. This tells SWC how to output the
+       * transpiled code.
+       *
+       * @see https://swc.rs/docs/configuration/modules
+       */ module: {
+                /**
+         * This tells SWC to output CommonJS modules. MetaMask Snaps
+         * doesn't support ES modules yet, so this is necessary.
+         *
+         * @see https://swc.rs/docs/configuration/modules#commonjs
+         */ type: 'commonjs'
+            },
+            env: {
+                targets: targets.join(', ')
+            }
+        }
+    };
+}
+/**
+ * Get the Webpack devtool configuration based on the given snap config.
+ *
+ * - If `sourceMap` is `inline`, return `inline-source-map`.
+ * - If `sourceMap` is `true`, return `source-map`.
+ * - Otherwise, return `false`.
+ *
+ * @param sourceMap - The `sourceMap` value from the snap config.
+ * @returns The Webpack devtool configuration.
+ */ export function getDevTool(sourceMap) {
+    if (sourceMap === 'inline') {
+        return 'inline-source-map';
+    }
+    if (sourceMap === true) {
+        return 'source-map';
+    }
+    return false;
+}
+/**
+ * Get a function that can be used as handler function for Webpack's
+ * `ProgressPlugin`.
+ *
+ * @param spinner - The spinner to update.
+ * @param spinnerText - The initial spinner text. This will be prepended to the
+ * percentage.
+ * @returns A function that can be used as handler function for Webpack's
+ * `ProgressPlugin`.
+ */ // Note: This is extracted for testing purposes.
+export function getProgressHandler(spinner, spinnerText) {
+    return (percentage)=>{
+        if (spinner && spinnerText) {
+            spinner.text = `${spinnerText} ${dim(`(${Math.round(percentage * 100)}%)`)}`;
+        }
+    };
+}
+/**
+ * Get the targets from the `.browserslistrc` file.
+ *
+ * @returns The browser targets as an array of strings.
+ */ export async function getBrowserslistTargets() {
+    const contents = await fs.readFile(BROWSERSLIST_FILE, 'utf8');
+    return contents.split('\n').map((line)=>line.trim()).filter((line)=>line && !line.startsWith('#'));
+}
+/**
+ * Get a singular or plural string based on the given count. This is useful for
+ * generating messages like "1 error" or "2 errors". By default, the plural
+ * string is the singular string with an "s" appended to it.
+ *
+ * This assumes that the text is in English, and likely won't work for some
+ * other languages.
+ *
+ * @param count - The count.
+ * @param singular - The singular string.
+ * @param plural - The plural string.
+ * @returns The singular or plural string.
+ * @example
+ * ```typescript
+ * pluralize(1, 'error'); // => 'error'
+ * pluralize(2, 'error'); // => 'errors'
+ * pluralize(1, 'error', 'problem'); // => 'error'
+ * pluralize(2, 'error', 'problems'); // => 'problems'
+ * ```
+ */ export function pluralize(count, singular, plural = `${singular}s`) {
+    return count === 1 ? singular : plural;
+}
+
+//# sourceMappingURL=utils.js.map

package/dist/esm/webpack/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/webpack/utils.ts"],"sourcesContent":["import { dim } from 'chalk';\nimport { promises as fs } from 'fs';\nimport type { Ora } from 'ora';\nimport { dirname, resolve } from 'path';\nimport type { Configuration } from 'webpack';\n\nimport type { ProcessedWebpackConfig } from '../config';\n\nexport const BROWSERSLIST_FILE = resolve(\n  dirname(\n    // eslint-disable-next-line n/no-extraneous-require\n    require.resolve('@metamask/snaps-cli/package.json'),\n  ),\n  '.browserslistrc',\n);\n\n/**\n * Get the default loader for JavaScript and TypeScript files, based on the\n * config object.\n *\n * - If the `legacy` option is set, we use the custom `browserify` loader. This\n * uses the legacy Browserify config to transpile the code.\n * - Otherwise, we use the `swc-loader`. This is a Webpack loader that uses the\n * `SWC` compiler, which is a much faster alternative to Babel and TypeScript's\n * own compiler.\n *\n * @param config - The processed snap Webpack config.\n * @param config.legacy - The legacy config object, if any.\n * @param config.sourceMap - Whether to generate source maps.\n * @see https://swc.rs/docs/usage/swc-loader\n * @returns The default loader.\n */\nexport async function getDefaultLoader({\n  legacy,\n  sourceMap,\n}: ProcessedWebpackConfig) {\n  if (legacy) {\n    return {\n      /**\n       * If the snap uses the legacy config, we use the custom `browserify`\n       * loader. This uses the legacy Browserify config to transpile the code.\n       * This is necessary for backwards compatibility with the\n       * `bundlerCustomizer` function.\n       */\n      loader: resolve(__dirname, 'loaders', 'browserify'),\n\n      /**\n       * The options for the `browserify` loader. These can be overridden in the\n       * snap config.\n       */\n      options: legacy,\n    };\n  }\n\n  const targets = await getBrowserslistTargets();\n  return {\n    /**\n     * We use the `swc-loader` to transpile TypeScript and JavaScript files.\n     * This is a Webpack loader that uses the `SWC` compiler, which is a much\n     * faster alternative to Babel and TypeScript's own compiler.\n     */\n    loader: 'swc-loader',\n\n    /**\n     * The options for the `swc-loader`. These can be overridden in the\n     * `.swcrc` file.\n     *\n     * @see https://swc.rs/docs/configuration/swcrc\n     */\n    options: {\n      sync: false,\n\n      /**\n       * This tells SWC to generate source maps. We set it to the\n       * `sourceMap` value from the config object.\n       *\n       * This must be enabled if source maps are enabled in the config.\n       */\n      sourceMaps: Boolean(getDevTool(sourceMap)),\n\n      jsc: {\n        /**\n         * MetaMask targets ES2020, so we set the target to ES2020. This\n         * ensures that the code is transpiled to ES2020, and that the\n         * necessary polyfills are added.\n         *\n         * @see https://swc.rs/docs/configuration/compilation#jsctarget\n         */\n        target: 'es2020',\n\n        parser: {\n          /**\n           * This tells the parser to parse TypeScript files. If you\n           * don't need to support TypeScript, you can set this to\n           * `ecmascript` instead, but there's no harm in leaving it\n           * as `typescript`.\n           *\n           * @see https://swc.rs/docs/configuration/compilation#jscparser\n           */\n          syntax: 'typescript',\n        },\n      },\n\n      /**\n       * The module configuration. This tells SWC how to output the\n       * transpiled code.\n       *\n       * @see https://swc.rs/docs/configuration/modules\n       */\n      module: {\n        /**\n         * This tells SWC to output CommonJS modules. MetaMask Snaps\n         * doesn't support ES modules yet, so this is necessary.\n         *\n         * @see https://swc.rs/docs/configuration/modules#commonjs\n         */\n        type: 'commonjs',\n      },\n\n      env: {\n        targets: targets.join(', '),\n      },\n    },\n  };\n}\n\n/**\n * Get the Webpack devtool configuration based on the given snap config.\n *\n * - If `sourceMap` is `inline`, return `inline-source-map`.\n * - If `sourceMap` is `true`, return `source-map`.\n * - Otherwise, return `false`.\n *\n * @param sourceMap - The `sourceMap` value from the snap config.\n * @returns The Webpack devtool configuration.\n */\nexport function getDevTool(\n  sourceMap: ProcessedWebpackConfig['sourceMap'],\n): Configuration['devtool'] {\n  if (sourceMap === 'inline') {\n    return 'inline-source-map';\n  }\n\n  if (sourceMap === true) {\n    return 'source-map';\n  }\n\n  return false;\n}\n\n/**\n * Get a function that can be used as handler function for Webpack's\n * `ProgressPlugin`.\n *\n * @param spinner - The spinner to update.\n * @param spinnerText - The initial spinner text. This will be prepended to the\n * percentage.\n * @returns A function that can be used as handler function for Webpack's\n * `ProgressPlugin`.\n */\n// Note: This is extracted for testing purposes.\nexport function getProgressHandler(spinner?: Ora, spinnerText?: string) {\n  return (percentage: number) => {\n    if (spinner && spinnerText) {\n      spinner.text = `${spinnerText} ${dim(\n        `(${Math.round(percentage * 100)}%)`,\n      )}`;\n    }\n  };\n}\n\n/**\n * Get the targets from the `.browserslistrc` file.\n *\n * @returns The browser targets as an array of strings.\n */\nexport async function getBrowserslistTargets() {\n  const contents = await fs.readFile(BROWSERSLIST_FILE, 'utf8');\n  return contents\n    .split('\\n')\n    .map((line) => line.trim())\n    .filter((line) => line && !line.startsWith('#'));\n}\n\n/**\n * Get a singular or plural string based on the given count. This is useful for\n * generating messages like \"1 error\" or \"2 errors\". By default, the plural\n * string is the singular string with an \"s\" appended to it.\n *\n * This assumes that the text is in English, and likely won't work for some\n * other languages.\n *\n * @param count - The count.\n * @param singular - The singular string.\n * @param plural - The plural string.\n * @returns The singular or plural string.\n * @example\n * ```typescript\n * pluralize(1, 'error'); // => 'error'\n * pluralize(2, 'error'); // => 'errors'\n * pluralize(1, 'error', 'problem'); // => 'error'\n * pluralize(2, 'error', 'problems'); // => 'problems'\n * ```\n */\nexport function pluralize(\n  count: number,\n  singular: string,\n  plural = `${singular}s`,\n) {\n  return count === 1 ? singular : plural;\n}\n"],"names":["dim","promises","fs","dirname","resolve","BROWSERSLIST_FILE","require","getDefaultLoader","legacy","sourceMap","loader","__dirname","options","targets","getBrowserslistTargets","sync","sourceMaps","Boolean","getDevTool","jsc","target","parser","syntax","module","type","env","join","getProgressHandler","spinner","spinnerText","percentage","text","Math","round","contents","readFile","split","map","line","trim","filter","startsWith","pluralize","count","singular","plural"],"mappings":"AAAA,SAASA,GAAG,QAAQ,QAAQ;AAC5B,SAASC,YAAYC,EAAE,QAAQ,KAAK;AAEpC,SAASC,OAAO,EAAEC,OAAO,QAAQ,OAAO;AAKxC,OAAO,MAAMC,oBAAoBD,QAC/BD,QACE,mDAAmD;AACnDG,QAAQF,OAAO,CAAC,sCAElB,mBACA;AAEF;;;;;;;;;;;;;;;CAeC,GACD,OAAO,eAAeG,iBAAiB,EACrCC,MAAM,EACNC,SAAS,EACc;IACvB,IAAID,QAAQ;QACV,OAAO;YACL;;;;;OAKC,GACDE,QAAQN,QAAQO,WAAW,WAAW;YAEtC;;;OAGC,GACDC,SAASJ;QACX;IACF;IAEA,MAAMK,UAAU,MAAMC;IACtB,OAAO;QACL;;;;KAIC,GACDJ,QAAQ;QAER;;;;;KAKC,GACDE,SAAS;YACPG,MAAM;YAEN;;;;;OAKC,GACDC,YAAYC,QAAQC,WAAWT;YAE/BU,KAAK;gBACH;;;;;;SAMC,GACDC,QAAQ;gBAERC,QAAQ;oBACN;;;;;;;WAOC,GACDC,QAAQ;gBACV;YACF;YAEA;;;;;OAKC,GACDC,QAAQ;gBACN;;;;;SAKC,GACDC,MAAM;YACR;YAEAC,KAAK;gBACHZ,SAASA,QAAQa,IAAI,CAAC;YACxB;QACF;IACF;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASR,WACdT,SAA8C;IAE9C,IAAIA,cAAc,UAAU;QAC1B,OAAO;IACT;IAEA,IAAIA,cAAc,MAAM;QACtB,OAAO;IACT;IAEA,OAAO;AACT;AAEA;;;;;;;;;CASC,GACD,gDAAgD;AAChD,OAAO,SAASkB,mBAAmBC,OAAa,EAAEC,WAAoB;IACpE,OAAO,CAACC;QACN,IAAIF,WAAWC,aAAa;YAC1BD,QAAQG,IAAI,GAAG,CAAC,EAAEF,YAAY,CAAC,EAAE7B,IAC/B,CAAC,CAAC,EAAEgC,KAAKC,KAAK,CAACH,aAAa,KAAK,EAAE,CAAC,EACpC,CAAC;QACL;IACF;AACF;AAEA;;;;CAIC,GACD,OAAO,eAAehB;IACpB,MAAMoB,WAAW,MAAMhC,GAAGiC,QAAQ,CAAC9B,mBAAmB;IACtD,OAAO6B,SACJE,KAAK,CAAC,MACNC,GAAG,CAAC,CAACC,OAASA,KAAKC,IAAI,IACvBC,MAAM,CAAC,CAACF,OAASA,QAAQ,CAACA,KAAKG,UAAU,CAAC;AAC/C;AAEA;;;;;;;;;;;;;;;;;;;CAmBC,GACD,OAAO,SAASC,UACdC,KAAa,EACbC,QAAgB,EAChBC,SAAS,CAAC,EAAED,SAAS,CAAC,CAAC;IAEvB,OAAOD,UAAU,IAAIC,WAAWC;AAClC"}

package/dist/types/__fixtures__/configs/cjs.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/__fixtures__/configs/esm.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/__fixtures__/configs/invalid.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/__fixtures__/configs/typescript/snap.config.d.ts

@@ -0,0 +1,3 @@
+import type { SnapConfig } from '../../../config';
+declare const config: SnapConfig;
+export default config;

package/dist/types/builders.d.ts

@@ -1,27 +1,8 @@
-import type { Options, PositionalOptions } from 'yargs';
-export declare type SnapsCliBuilders = {
-    readonly bundle: Readonly<Options>;
-    readonly dist: Readonly<Options>;
-    readonly eval: Readonly<Options>;
-    readonly manifest: Readonly<Options>;
-    readonly outfileName: Readonly<Options>;
-    readonly port: Readonly<Options>;
-    readonly root: Readonly<Options>;
-    readonly sourceMaps: Readonly<Options>;
-    readonly src: Readonly<Options>;
-    readonly stripComments: Readonly<Options>;
-    readonly suppressWarnings: Readonly<Options>;
-    readonly transpilationMode: Readonly<Options>;
-    readonly depsToTranspile: Readonly<Options>;
-    readonly verboseErrors: Readonly<Options>;
-    readonly writeManifest: Readonly<Options>;
-    readonly serve: Readonly<Options>;
-    readonly directory: Readonly<PositionalOptions>;
-};
+import type { Options } from 'yargs';
 export declare enum TranspilationModes {
     LocalAndDeps = "localAndDeps",
     LocalOnly = "localOnly",
     None = "none"
 }
-declare const builders: SnapsCliBuilders;
+declare const builders: Record<string, Readonly<Options>>;
 export default builders;

package/dist/types/cli.d.ts

@@ -5,4 +5,4 @@
  * @param argv - The raw command line arguments, i.e., `process.argv`.
  * @param commands - The list of commands to use.
  */
-export declare function cli(argv: string[], commands: any): void;
+export declare function cli(argv: string[], commands: any): Promise<void>;

package/dist/types/commands/build/build.d.ts

@@ -0,0 +1,10 @@
+import type { ProcessedConfig } from '../../config';
+/**
+ * Build all files in the given source directory to the given destination
+ * directory.
+ *
+ * This creates the destination directory if it doesn't exist.
+ *
+ * @param config - The config object.
+ */
+export declare function buildHandler(config: ProcessedConfig): Promise<void>;

package/dist/types/commands/build/implementation.d.ts

@@ -0,0 +1,10 @@
+import type { ProcessedWebpackConfig } from '../../config';
+import type { WebpackOptions } from '../../webpack';
+/**
+ * Build the snap bundle. This uses Webpack to build the bundle.
+ *
+ * @param config - The config object.
+ * @param options - The Webpack options.
+ * @returns A promise that resolves when the bundle is built.
+ */
+export declare function build(config: ProcessedWebpackConfig, options?: WebpackOptions): Promise<void>;

package/dist/types/{cmds/eval → commands/build}/index.d.ts

@@ -6,4 +6,5 @@ declare const command: {
     builder: (yarg: yargs.Argv) => void;
     handler: (argv: YargsArgs) => Promise<void>;
 };
+export * from './implementation';
 export default command;