@metamask/snaps-rollup-plugin 0.24.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# @metamask/snaps-rollup-plugin
+
+A plugin for developing [MetaMask Snaps](https://docs.metamask.io/guide/snaps.html) using [Rollup](https://rollupjs.org/). This can be used as alternative to the `mm-snap` CLI `build` command. It transforms the bundle to fix common issues with SES. For a list of changes the plugin makes, you can refer to [the source code](../utils/src/post-process.ts).
+
+## Installation
+
+Use Node.js `16.0.0` or later. We recommend using [nvm](https://github.com/nvm-sh/nvm) for managing Node.js versions.
+
+Install a dependency in your snap project using `yarn` or `npm`:
+
+- `npm install @metamask/snaps-rollup-plugin`
+- `yarn add @metamask/snaps-rollup-plugin`
+
+## Usage
+
+Add the plugin to the `plugins` array in your Rollup configuration:
+
+```ts
+// rollup.config.js
+
+import snaps from '@metamask/snaps-rollup-plugin';
+
+export default {
+  plugins: [snaps(options)],
+};
+```
+
+### Options
+
+All options are optional, and default to `true`.
+
+```ts
+import { Options } from '@metamask/snaps-rollup-plugin';
+
+const options: Options = {
+  /**
+   * Whether to strip all comments from the bundle.
+   */
+  stripComments: true,
+
+  /**
+   * Whether to evaluate the bundle with SES, to ensure SES compatibility.
+   */
+  eval: true,
+
+  /**
+   * The path to the Snap manifest file. If set, it will be checked and automatically updated with
+   * the bundle's hash, if `writeManifest` is enabled. Defaults to `snap/manifest.json` in the
+   * current working directory.
+   */
+  manifestPath: './snap.manifest.json',
+
+  /**
+   * Whether to write the updated Snap manifest file to disk. If `manifestPath` is not set, this
+   * option has no effect. If this is disabled, an error will be thrown if the manifest file is
+   * invalid.
+   */
+  writeManifest: true,
+};
+```

package/dist/__fixtures__/source-map.d.ts

@@ -0,0 +1 @@
+declare const foo = "bar";

package/dist/__fixtures__/source-map.js

@@ -0,0 +1,6 @@
+"use strict";
+// This file is only used for testing source map generation.
+// eslint-disable-next-line import/unambiguous
+const foo = 'bar';
+console.log(foo);
+//# sourceMappingURL=source-map.js.map

package/dist/__fixtures__/source-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-map.js","sourceRoot":"","sources":["../../src/__fixtures__/source-map.ts"],"names":[],"mappings":";AAAA,4DAA4D;AAE5D,8CAA8C;AAC9C,MAAM,GAAG,GAAG,KAAK,CAAC;AAClB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC","sourcesContent":["// This file is only used for testing source map generation.\n\n// eslint-disable-next-line import/unambiguous\nconst foo = 'bar';\nconsole.log(foo);\n"]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './plugin';
+export type { Options } from './plugin';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAmC;AAA1B,kHAAA,OAAO,OAAA","sourcesContent":["export { default } from './plugin';\nexport type { Options } from './plugin';\n"]}

package/dist/plugin.d.ts

@@ -0,0 +1,24 @@
+import { PostProcessOptions } from '@metamask/snaps-utils';
+import { Plugin } from 'rollup';
+declare type PluginOptions = {
+    eval?: boolean;
+    manifestPath?: string;
+    writeManifest?: boolean;
+};
+export declare type Options = PluginOptions & Omit<PostProcessOptions, 'sourceMap' | 'inputSourceMap'>;
+/**
+ * Creates a Snaps Rollup plugin instance.
+ *
+ * @param options - The plugin options.
+ * @param options.stripComments - Whether to strip comments. Defaults to `true`.
+ * @param options.eval - Whether to evaluate the bundle to test SES
+ * compatibility. Defaults to `true`.
+ * @param options.manifestPath - The path to the manifest file. If provided,
+ * the manifest will be validated. Defaults to
+ * `process.cwd() + '/snap.manifest.json'`.
+ * @param options.writeManifest - Whether to fix the manifest. Defaults to
+ * `true`.
+ * @returns The Rollup plugin object.
+ */
+export default function snaps(options?: Partial<Options>): Plugin;
+export {};

package/dist/plugin.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const snaps_utils_1 = require("@metamask/snaps-utils");
+/**
+ * Creates a Snaps Rollup plugin instance.
+ *
+ * @param options - The plugin options.
+ * @param options.stripComments - Whether to strip comments. Defaults to `true`.
+ * @param options.eval - Whether to evaluate the bundle to test SES
+ * compatibility. Defaults to `true`.
+ * @param options.manifestPath - The path to the manifest file. If provided,
+ * the manifest will be validated. Defaults to
+ * `process.cwd() + '/snap.manifest.json'`.
+ * @param options.writeManifest - Whether to fix the manifest. Defaults to
+ * `true`.
+ * @returns The Rollup plugin object.
+ */
+function snaps(options) {
+    const defaultOptions = Object.assign({ eval: true, manifestPath: path_1.default.join(process.cwd(), 'snap.manifest.json'), writeManifest: true }, options);
+    return {
+        name: '@metamask/snaps-rollup-plugin',
+        renderChunk(code) {
+            // Rollup internally merges the new source map with the old one, so there
+            // is no need to pass the current source map to the function.
+            const result = (0, snaps_utils_1.postProcessBundle)(code, Object.assign(Object.assign({}, defaultOptions), { sourceMap: true }));
+            if (result.warnings.length > 0) {
+                this.warn(`Bundle Warning: Processing of the Snap bundle completed with warnings.\n${result.warnings.join('\n')}`);
+            }
+            return { code: result.code, map: result.sourceMap };
+        },
+        async writeBundle(output) {
+            if (!output.file) {
+                this.warn('No output file specified, skipping bundle validation.');
+                return;
+            }
+            if (defaultOptions.eval) {
+                await (0, snaps_utils_1.evalBundle)(output.file).catch((error) => {
+                    this.error(error);
+                });
+            }
+            if (defaultOptions.manifestPath) {
+                const { errors, warnings } = await (0, snaps_utils_1.checkManifest)(path_1.default.dirname(defaultOptions.manifestPath), defaultOptions.writeManifest, await fs_1.promises.readFile(output.file, 'utf8'));
+                if (!defaultOptions.writeManifest && errors.length > 0) {
+                    this.error(`Manifest Error: The manifest is invalid.\n${errors.join('\n')}`);
+                }
+                if (warnings.length > 0) {
+                    this.warn(`Manifest Warning: Validation of snap.manifest.json completed with warnings.\n${warnings.join('\n')}`);
+                }
+            }
+        },
+    };
+}
+exports.default = snaps;
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;;;AAAA,2BAAoC;AACpC,gDAA6B;AAC7B,uDAK+B;AAY/B;;;;;;;;;;;;;GAaG;AACH,SAAwB,KAAK,CAAC,OAA0B;IACtD,MAAM,cAAc,mBAClB,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,cAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,oBAAoB,CAAC,EACjE,aAAa,EAAE,IAAI,IAChB,OAAO,CACX,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,+BAA+B;QAErC,WAAW,CAAC,IAAY;YACtB,yEAAyE;YACzE,6DAA6D;YAC7D,MAAM,MAAM,GAAG,IAAA,+BAAiB,EAAC,IAAI,kCAChC,cAAc,KACjB,SAAS,EAAE,IAAI,IACf,CAAC;YAEH,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC9B,IAAI,CAAC,IAAI,CACP,2EAA2E,MAAM,CAAC,QAAQ,CAAC,IAAI,CAC7F,IAAI,CACL,EAAE,CACJ,CAAC;aACH;YAED,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,WAAW,CAAC,MAAM;YACtB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;gBAChB,IAAI,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;gBACnE,OAAO;aACR;YAED,IAAI,cAAc,CAAC,IAAI,EAAE;gBACvB,MAAM,IAAA,wBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC5C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;aACJ;YAED,IAAI,cAAc,CAAC,YAAY,EAAE;gBAC/B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAA,2BAAa,EAC9C,cAAS,CAAC,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,EAC9C,cAAc,CAAC,aAAa,EAC5B,MAAM,aAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CACvC,CAAC;gBAEF,IAAI,CAAC,cAAc,CAAC,aAAa,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBACtD,IAAI,CAAC,KAAK,CACR,6CAA6C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjE,CAAC;iBACH;gBAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;oBACvB,IAAI,CAAC,IAAI,CACP,gFAAgF,QAAQ,CAAC,IAAI,CAC3F,IAAI,CACL,EAAE,CACJ,CAAC;iBACH;aACF;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAjED,wBAiEC","sourcesContent":["import { promises as fs } from 'fs';\nimport pathUtils from 'path';\nimport {\n  checkManifest,\n  evalBundle,\n  postProcessBundle,\n  PostProcessOptions,\n} from '@metamask/snaps-utils';\nimport { Plugin, SourceMapInput } from 'rollup';\n\ntype PluginOptions = {\n  eval?: boolean;\n  manifestPath?: string;\n  writeManifest?: boolean;\n};\n\nexport type Options = PluginOptions &\n  Omit<PostProcessOptions, 'sourceMap' | 'inputSourceMap'>;\n\n/**\n * Creates a Snaps Rollup plugin instance.\n *\n * @param options - The plugin options.\n * @param options.stripComments - Whether to strip comments. Defaults to `true`.\n * @param options.eval - Whether to evaluate the bundle to test SES\n * compatibility. Defaults to `true`.\n * @param options.manifestPath - The path to the manifest file. If provided,\n * the manifest will be validated. Defaults to\n * `process.cwd() + '/snap.manifest.json'`.\n * @param options.writeManifest - Whether to fix the manifest. Defaults to\n * `true`.\n * @returns The Rollup plugin object.\n */\nexport default function snaps(options?: Partial<Options>): Plugin {\n  const defaultOptions = {\n    eval: true,\n    manifestPath: pathUtils.join(process.cwd(), 'snap.manifest.json'),\n    writeManifest: true,\n    ...options,\n  };\n\n  return {\n    name: '@metamask/snaps-rollup-plugin',\n\n    renderChunk(code: string): { code: string; map?: SourceMapInput } | null {\n      // Rollup internally merges the new source map with the old one, so there\n      // is no need to pass the current source map to the function.\n      const result = postProcessBundle(code, {\n        ...defaultOptions,\n        sourceMap: true,\n      });\n\n      if (result.warnings.length > 0) {\n        this.warn(\n          `Bundle Warning: Processing of the Snap bundle completed with warnings.\\n${result.warnings.join(\n            '\\n',\n          )}`,\n        );\n      }\n\n      return { code: result.code, map: result.sourceMap };\n    },\n\n    async writeBundle(output): Promise<void> {\n      if (!output.file) {\n        this.warn('No output file specified, skipping bundle validation.');\n        return;\n      }\n\n      if (defaultOptions.eval) {\n        await evalBundle(output.file).catch((error) => {\n          this.error(error);\n        });\n      }\n\n      if (defaultOptions.manifestPath) {\n        const { errors, warnings } = await checkManifest(\n          pathUtils.dirname(defaultOptions.manifestPath),\n          defaultOptions.writeManifest,\n          await fs.readFile(output.file, 'utf8'),\n        );\n\n        if (!defaultOptions.writeManifest && errors.length > 0) {\n          this.error(\n            `Manifest Error: The manifest is invalid.\\n${errors.join('\\n')}`,\n          );\n        }\n\n        if (warnings.length > 0) {\n          this.warn(\n            `Manifest Warning: Validation of snap.manifest.json completed with warnings.\\n${warnings.join(\n              '\\n',\n            )}`,\n          );\n        }\n      }\n    },\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@metamask/snaps-rollup-plugin",
+  "version": "0.24.0",
+  "keywords": [
+    "rollup",
+    "rollup-plugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/snaps-monorepo.git"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "test": "jest && yarn posttest",
+    "posttest": "jest-it-up",
+    "test:ci": "yarn test",
+    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:changelog": "yarn auto-changelog validate",
+    "build:tsc": "tsc --project tsconfig.build.json",
+    "build": "yarn build:tsc",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
+    "publish:package": "../../scripts/publish-package.sh"
+  },
+  "dependencies": {
+    "@metamask/snaps-utils": "^0.24.0"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^2.0.3",
+    "@metamask/auto-changelog": "^2.6.0",
+    "@metamask/eslint-config": "^9.0.0",
+    "@metamask/eslint-config-jest": "^9.0.0",
+    "@metamask/eslint-config-nodejs": "^9.0.0",
+    "@metamask/eslint-config-typescript": "^9.0.1",
+    "@rollup/plugin-virtual": "^2.1.0",
+    "@types/jest": "^27.5.1",
+    "deepmerge": "^4.2.2",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^29.0.2",
+    "jest-it-up": "^2.0.0",
+    "memfs": "^3.4.7",
+    "prettier": "^2.3.2",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.72.1",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.4.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}