@metamask/snaps-webpack-plugin 0.14.0 → 0.17.0

package/dist/plugin.d.ts

@@ -1,8 +1,22 @@
 import { PostProcessOptions } from '@metamask/snap-utils';
-import { Compiler, WebpackPluginInstance } from 'webpack';
+import { Compiler } from 'webpack';
 export declare type Options = PostProcessOptions;
-export default class SnapsWebpackPlugin implements WebpackPluginInstance {
+export default class SnapsWebpackPlugin {
     readonly options: Partial<Options>;
+    /**
+     * Construct an instance of the plugin.
+     *
+     * @param options - The post-process options.
+     * @param options.stripComments - Whether to strip comments. Defaults to `true`.
+     * @param options.transformHtmlComments - Whether to transform HTML comments.
+     * Defaults to `true`.
+     */
     constructor(options?: Partial<Options>);
+    /**
+     * Apply the plugin to the Webpack compiler. Hooks into the `processAssets`
+     * stage to process the bundle.
+     *
+     * @param compiler - The Webpack compiler.
+     */
     apply(compiler: Compiler): void;
 }

package/dist/plugin.js

@@ -4,9 +4,23 @@ const snap_utils_1 = require("@metamask/snap-utils");
 const webpack_sources_1 = require("webpack-sources");
 const PLUGIN_NAME = 'SnapsWebpackPlugin';
 class SnapsWebpackPlugin {
+    /**
+     * Construct an instance of the plugin.
+     *
+     * @param options - The post-process options.
+     * @param options.stripComments - Whether to strip comments. Defaults to `true`.
+     * @param options.transformHtmlComments - Whether to transform HTML comments.
+     * Defaults to `true`.
+     */
     constructor(options = {}) {
         this.options = options;
     }
+    /**
+     * Apply the plugin to the Webpack compiler. Hooks into the `processAssets`
+     * stage to process the bundle.
+     *
+     * @param compiler - The Webpack compiler.
+     */
     apply(compiler) {
         compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
             compilation.hooks.processAssets.tap(PLUGIN_NAME, (assets) => {

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;AAAA,qDAA6E;AAE7E,qDAA4C;AAE5C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAIzC,MAAqB,kBAAkB;IAGrC,YAAY,UAA4B,EAAE;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YAC1D,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC1D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;oBACxC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;oBAChC,MAAM,SAAS,GAAG,IAAA,8BAAiB,EACjC,KAAK,CAAC,MAAM,EAAY,EACxB,IAAI,CAAC,OAAO,CACb,CAAC;oBAEF,IAAI,SAAS,EAAE;wBACb,+EAA+E;wBAC/E,qDAAqD;wBACrD,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,2BAAS,CAAC,SAAS,CAAQ,CAAC,CAAC;qBACrE;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1BD,qCA0BC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;AAAA,qDAA6E;AAE7E,qDAA4C;AAE5C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAIzC,MAAqB,kBAAkB;IAGrC;;;;;;;OAOG;IACH,YAAY,UAA4B,EAAE;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAkB;QACtB,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YAC1D,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE;gBAC1D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;oBACxC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;oBAChC,MAAM,SAAS,GAAG,IAAA,8BAAiB,EACjC,KAAK,CAAC,MAAM,EAAY,EACxB,IAAI,CAAC,OAAO,CACb,CAAC;oBAEF,IAAI,SAAS,EAAE;wBACb,+EAA+E;wBAC/E,qDAAqD;wBACrD,WAAW,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,2BAAS,CAAC,SAAS,CAAQ,CAAC,CAAC;qBACrE;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxCD,qCAwCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-webpack-plugin",
-  "version": "0.14.0",
+  "version": "0.17.0",
   "keywords": [
     "webpack",
     "plugin"
@@ -14,7 +14,7 @@
     "dist/"
   ],
   "scripts": {
-    "test": "jest",
+    "test": "jest && yarn posttest",
     "posttest": "jest-it-up",
     "test:ci": "yarn test",
     "lint:eslint": "eslint . --cache --ext js,ts",
@@ -24,29 +24,42 @@
     "lint:changelog": "yarn auto-changelog validate",
     "build:tsc": "tsc --project tsconfig.local.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 *.tsbuildinfo dist/*",
-    "publish": "../../scripts/publish-package.sh"
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
+    "publish:package": "../../scripts/publish-package.sh"
   },
   "dependencies": {
-    "@metamask/snap-utils": "^0.14.0",
+    "@metamask/snap-utils": "^0.17.0",
     "webpack-sources": "^3.2.3"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/webpack": "^5.28.0",
+    "@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",
+    "@types/jest": "^27.5.1",
     "@types/webpack-sources": "^3.2.0",
+    "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": "^27.5.1",
     "jest-it-up": "^2.0.0",
     "memfs": "^3.4.1",
-    "ts-jest": "^27.1.4",
+    "prettier": "^2.3.2",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.1.5",
     "typescript": "^4.4.0",
-    "webpack": "^5.72.0"
+    "webpack": "^5.72.1"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "publishConfig": {
     "access": "public",

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-# 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.14.0]
-### Fixed
-- Actually publish package contents ([#449](https://github.com/MetaMask/snaps-skunkworks/pull/449))
-  - Package contents were omitted from the previous version due to a build failure.
-
-## [0.13.0]
-### Changed
-- No changes this release.
-
-## [0.12.0]
-### Added
-- Initial release ([#420](https://github.com/MetaMask/snaps-skunkworks/pull/420))
-
-[Unreleased]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.14.0...HEAD
-[0.14.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.13.0...v0.14.0
-[0.13.0]: https://github.com/MetaMask/snaps-skunkworks/compare/v0.12.0...v0.13.0
-[0.12.0]: https://github.com/MetaMask/snaps-skunkworks/releases/tag/v0.12.0