@metamask/snaps-webpack-plugin 0.12.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.12.0]
+### Added
+- Initial release ([#420](https://github.com/MetaMask/snaps-skunkworks/pull/420))
+
+[Unreleased]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/MetaMask/snaps-skunkworks/releases/tag/v0.12.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,47 @@
+# @metamask/snaps-webpack-plugin
+
+A plugin for developing [MetaMask Snaps](https://docs.metamask.io/guide/snaps.html) using [Webpack](https://webpack.js.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/bundle.ts).
+
+## Installation
+
+Use Node.js `14.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-webpack-plugin`
+- `yarn add @metamask/snaps-webpack-plugin`
+
+## Usage
+
+Add the plugin to the `plugins` array in your Webpack configuration:
+
+```ts
+// webpack.config.js
+
+import SnapsWebpackPlugin from '@metamask/snaps-webpack-plugin';
+
+export default {
+  plugins: [new SnapsWebpackPlugin(options)],
+};
+```
+
+### Options
+
+All options are optional, and default to `true`.
+
+```ts
+import { Options } from '@metamask/snaps-webpack-plugin';
+
+const options: Options = {
+  /**
+   * Whether to strip all comments from the bundle.
+   */
+  stripComments: true,
+
+  /**
+   * Whether to break up tokens that could be parsed as HTML comment terminators. This may change
+   * the behaviour of programs that contain HTML comment terminators in string literals.
+   */
+  transformHtmlComments: true,
+};
+```

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@metamask/snaps-webpack-plugin",
+  "version": "0.12.0",
+  "keywords": [
+    "webpack",
+    "plugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/snaps-skunkworks.git"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "test": "jest",
+    "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:pre-tsc": "echo 'N/A'",
+    "build:post-tsc": "echo 'N/A'",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf dist/*",
+    "publish": "../../scripts/publish-package.sh"
+  },
+  "dependencies": {
+    "@metamask/snap-utils": "^0.12.0",
+    "webpack-sources": "^3.2.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@types/webpack": "^5.28.0",
+    "@types/webpack-sources": "^3.2.0",
+    "jest": "^27.5.1",
+    "jest-it-up": "^2.0.0",
+    "memfs": "^3.4.1",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.4.0",
+    "webpack": "^5.72.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}