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

package/dist/esm/webpack/utils.js

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

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

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

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

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

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

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

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

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

package/dist/types/builders.d.ts

@@ -1,8 +0,0 @@
-import type { Options } from 'yargs';
-export declare enum TranspilationModes {
-    LocalAndDeps = "localAndDeps",
-    LocalOnly = "localOnly",
-    None = "none"
-}
-declare const builders: Record<string, Readonly<Options>>;
-export default builders;

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

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

@@ -1,10 +0,0 @@
-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/commands/build/index.d.ts

@@ -1,10 +0,0 @@
-import type yargs from 'yargs';
-import type { YargsArgs } from '../../types/yargs';
-declare const command: {
-    command: string[];
-    desc: string;
-    builder: (yarg: yargs.Argv) => void;
-    handler: (argv: YargsArgs) => Promise<void>;
-};
-export * from './implementation';
-export default command;

package/dist/types/commands/eval/__test__/browserify/bad/snap.config.d.ts

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

package/dist/types/commands/eval/__test__/browserify/good/snap.config.d.ts

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

package/dist/types/commands/eval/__test__/webpack/bad/snap.config.d.ts

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

package/dist/types/commands/eval/__test__/webpack/good/snap.config.d.ts

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

package/dist/types/commands/eval/__test__/webpack/snap.config.d.ts

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

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

@@ -1,14 +0,0 @@
-import type { ProcessedConfig } from '../../config';
-export declare type EvalOptions = {
-    input?: string;
-};
-export declare type EvalContext = Required<EvalOptions>;
-/**
- * Runs the snap in a worker, to ensure SES compatibility.
- *
- * @param config - The processed config object.
- * @param options - The eval options.
- * @returns A promise that resolves once the eval has finished.
- * @throws If the eval failed.
- */
-export declare function evaluateHandler(config: ProcessedConfig, options?: EvalOptions): Promise<void>;

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

@@ -1,9 +0,0 @@
-/**
- * Evaluate the given bundle in the SES environment. This is a wrapper around
- * {@link evalBundle} that throws a {@link CommandError} if the bundle cannot be
- * evaluated.
- *
- * @param path - The path to the bundle.
- * @throws If the bundle cannot be evaluated.
- */
-export declare function evaluate(path: string): Promise<import("@metamask/snaps-utils").EvalOutput>;

package/dist/types/commands/eval/index.d.ts

@@ -1,10 +0,0 @@
-import type yargs from 'yargs';
-import type { YargsArgs } from '../../types/yargs';
-declare const command: {
-    command: string[];
-    desc: string;
-    builder: (yarg: yargs.Argv) => void;
-    handler: (argv: YargsArgs) => Promise<void>;
-};
-export * from './implementation';
-export default command;

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

@@ -1,12 +0,0 @@
-import type { Ora } from 'ora';
-/**
- * Check the snap manifest file at the given path. If `write` is `true`, the
- * manifest will be written to disk if it is invalid. If `write` is `false`,
- * the manifest will not be written to disk, and the function will log any
- * errors and warnings to the console.
- *
- * @param path - The path to the manifest file.
- * @param write - Whether to write the manifest to disk if it is invalid.
- * @param spinner - An optional spinner to use for logging.
- */
-export declare function manifest(path: string, write: boolean, spinner?: Ora): Promise<boolean>;

package/dist/types/commands/manifest/index.d.ts

@@ -1,10 +0,0 @@
-import type yargs from 'yargs';
-import type { YargsArgs } from '../../types/yargs';
-declare const command: {
-    command: string[];
-    desc: string;
-    builder: (yarg: yargs.Argv) => void;
-    handler: (argv: YargsArgs) => Promise<void>;
-};
-export * from './implementation';
-export default command;

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

@@ -1,14 +0,0 @@
-import type { ProcessedConfig } from '../../config';
-declare type ManifestOptions = {
-    fix?: boolean;
-};
-/**
- * Validates a snap.manifest.json file. Attempts to fix the manifest and write
- * the fixed version to disk if `writeManifest` is true. Throws if validation
- * fails.
- *
- * @param config - The config object.
- * @param options - The options object.
- */
-export declare function manifestHandler(config: ProcessedConfig, options: ManifestOptions): Promise<void>;
-export {};

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

@@ -1,16 +0,0 @@
-import type { ProcessedConfig } from '../../config';
-declare type ServeOptions = {
-    /**
-     * The port to listen on.
-     */
-    port: number;
-};
-/**
- * Starts a local, static HTTP server on the given port with the given root
- * directory.
- *
- * @param config - The config object.
- * @param options - The options object.
- */
-export declare function serveHandler(config: ProcessedConfig, options: ServeOptions): Promise<void>;
-export {};

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

@@ -1,14 +0,0 @@
-import type { Watching } from 'webpack';
-import type { ProcessedWebpackConfig } from '../../config';
-import type { WebpackOptions } from '../../webpack';
-/**
- * Build the snap bundle and watch for changes. 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 for the first time.
- * The promise resolves with a Webpack watching instance that can be used to
- * close the watcher.
- */
-export declare function watch(config: ProcessedWebpackConfig, options?: WebpackOptions): Promise<Watching>;

package/dist/types/commands/watch/index.d.ts

@@ -1,10 +0,0 @@
-import type yargs from 'yargs';
-import type { YargsArgs } from '../../types/yargs';
-declare const command: {
-    command: string[];
-    desc: string;
-    builder: (yarg: yargs.Argv) => void;
-    handler: (argv: YargsArgs) => Promise<void>;
-};
-export * from './implementation';
-export default command;

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

@@ -1,19 +0,0 @@
-import type { ProcessedConfig } from '../../config';
-declare type WatchOptions = {
-    /**
-     * The port to listen on.
-     */
-    port?: number;
-};
-/**
- * Watch a directory and its subdirectories for changes, and build when files
- * are added or changed.
- *
- * Ignores 'node_modules' and dotfiles.
- * Creates destination directory if it doesn't exist.
- *
- * @param config - The config object.
- * @param options - The options object.
- */
-export declare function watchHandler(config: ProcessedConfig, options: WatchOptions): Promise<void>;
-export {};