@rushstack/webpack-plugin-utilities 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# webpack-plugin-utilities
+
+## Installation
+
+`npm install @rushstack/webpack-plugin-utilities --save`
+
+## Overview
+
+This is a collection of utilities for writing webpack plugins
+
+# Usage
+
+```JavaScript
+import { VersionDetection } from "@rushstack/webpack-plugin-utilities"
+
+class MyExampleWebpackPlugin {
+  constructor() {
+    this.pluginName = "MyExampleWebpackPlugin"
+  }
+
+  apply(compiler) {
+    if (VersionDetection.isWebpack3OrEarlier(compiler)) {
+      throw new Error(`This plugin does not support webpack 3 or below.`)
+    }
+
+    const isWebpack4 = VersionDetection.isWebpack4(compiler);
+
+    if (isWebpack4) {
+      compiler.hooks.compilation.tap(this.pluginName, (compilation) => {
+        // ....
+      });
+    } else {
+      compiler.hooks.compilation.tap(this.pluginName, (compilation) => {
+        // ...
+      });
+    }
+  }
+}
+```
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/webpack/webpack-plugin-utilities/CHANGELOG.md) - Find
+  out what's new in the latest version
+
+`@rushstack/webpack-plugin-utilities` is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.23.0"
+    }
+  ]
+}

package/dist/webpack-plugin-utilities.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Utility package which provides a set of tools for working in
+ * webpack plugins, loaders, and other integrations.
+ * @packageDocumentation
+ */
+
+import type * as Webpack from 'webpack';
+
+/**
+ * We do not have quality API detection between webpack major versions 1-3.
+ * We can detect the absence of hooks which was a version 3 feature.
+ *
+ * @public
+ */
+declare function isWebpack3OrEarlier(compiler: Webpack.Compiler): boolean;
+
+/**
+ * Detects whether or not we are using webpack 4
+ *
+ * @public
+ */
+declare function isWebpack4(compiler: Webpack.Compiler): boolean;
+
+/**
+ * Detects whether or not we are using webpack 5
+ *
+ * @public
+ */
+declare function isWebpack5(compiler: Webpack.Compiler): boolean;
+
+declare namespace VersionDetection {
+    export {
+        isWebpack3OrEarlier,
+        isWebpack4,
+        isWebpack5
+    }
+}
+export { VersionDetection }
+
+export { }

package/lib/DetectWebpackVersion.d.ts

@@ -0,0 +1,28 @@
+/**
+ * There is no `compiler.version` API available prior to webpack 5,
+ * therefore we will have to make some inferences about which major version of webpack we are on.
+ * Feature Request: https://github.com/webpack/webpack/issues/15679
+ * @description
+ */
+import type * as Webpack from 'webpack';
+/**
+ * We do not have quality API detection between webpack major versions 1-3.
+ * We can detect the absence of hooks which was a version 3 feature.
+ *
+ * @public
+ */
+declare function isWebpack3OrEarlier(compiler: Webpack.Compiler): boolean;
+/**
+ * Detects whether or not we are using webpack 4
+ *
+ * @public
+ */
+declare function isWebpack4(compiler: Webpack.Compiler): boolean;
+/**
+ * Detects whether or not we are using webpack 5
+ *
+ * @public
+ */
+declare function isWebpack5(compiler: Webpack.Compiler): boolean;
+export { isWebpack3OrEarlier, isWebpack4, isWebpack5 };
+//# sourceMappingURL=DetectWebpackVersion.d.ts.map

package/lib/DetectWebpackVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DetectWebpackVersion.d.ts","sourceRoot":"","sources":["../src/DetectWebpackVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,KAAK,OAAO,MAAM,SAAS,CAAC;AAExC;;;;;GAKG;AACH,iBAAS,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAGvD;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,OAAO,CAIvD;AAED,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC"}

package/lib/DetectWebpackVersion.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * There is no `compiler.version` API available prior to webpack 5,
+ * therefore we will have to make some inferences about which major version of webpack we are on.
+ * Feature Request: https://github.com/webpack/webpack/issues/15679
+ * @description
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWebpack5 = exports.isWebpack4 = exports.isWebpack3OrEarlier = void 0;
+/**
+ * We do not have quality API detection between webpack major versions 1-3.
+ * We can detect the absence of hooks which was a version 3 feature.
+ *
+ * @public
+ */
+function isWebpack3OrEarlier(compiler) {
+    return !compiler.hooks;
+}
+exports.isWebpack3OrEarlier = isWebpack3OrEarlier;
+/**
+ * Detects whether or not we are using webpack 4
+ *
+ * @public
+ */
+function isWebpack4(compiler) {
+    var _a;
+    const webpackVersion = (_a = compiler === null || compiler === void 0 ? void 0 : compiler.webpack) === null || _a === void 0 ? void 0 : _a.version;
+    return !webpackVersion;
+}
+exports.isWebpack4 = isWebpack4;
+/**
+ * Detects whether or not we are using webpack 5
+ *
+ * @public
+ */
+function isWebpack5(compiler) {
+    var _a;
+    const webpackVersion = (_a = compiler === null || compiler === void 0 ? void 0 : compiler.webpack) === null || _a === void 0 ? void 0 : _a.version;
+    return !!webpackVersion;
+}
+exports.isWebpack5 = isWebpack5;
+//# sourceMappingURL=DetectWebpackVersion.js.map

package/lib/DetectWebpackVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DetectWebpackVersion.js","sourceRoot":"","sources":["../src/DetectWebpackVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAIH;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,QAA0B;IACrD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;AACzB,CAAC;AAuBQ,kDAAmB;AArB5B;;;;GAIG;AACH,SAAS,UAAU,CAAC,QAA0B;;IAC5C,MAAM,cAAc,GAAuB,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,OAAO,CAAC;IACtE,OAAO,CAAC,cAAc,CAAC;AACzB,CAAC;AAa6B,gCAAU;AAXxC;;;;GAIG;AACH,SAAS,UAAU,CAAC,QAA0B;;IAC5C,MAAM,cAAc,GAAuB,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,OAAO,CAAC;IAEtE,OAAO,CAAC,CAAC,cAAc,CAAC;AAC1B,CAAC;AAEyC,gCAAU","sourcesContent":["/**\n * There is no `compiler.version` API available prior to webpack 5,\n * therefore we will have to make some inferences about which major version of webpack we are on.\n * Feature Request: https://github.com/webpack/webpack/issues/15679\n * @description\n */\n\nimport type * as Webpack from 'webpack';\n\n/**\n * We do not have quality API detection between webpack major versions 1-3.\n * We can detect the absence of hooks which was a version 3 feature.\n *\n * @public\n */\nfunction isWebpack3OrEarlier(compiler: Webpack.Compiler): boolean {\n  return !compiler.hooks;\n}\n\n/**\n * Detects whether or not we are using webpack 4\n *\n * @public\n */\nfunction isWebpack4(compiler: Webpack.Compiler): boolean {\n  const webpackVersion: string | undefined = compiler?.webpack?.version;\n  return !webpackVersion;\n}\n\n/**\n * Detects whether or not we are using webpack 5\n *\n * @public\n */\nfunction isWebpack5(compiler: Webpack.Compiler): boolean {\n  const webpackVersion: string | undefined = compiler?.webpack?.version;\n\n  return !!webpackVersion;\n}\n\nexport { isWebpack3OrEarlier, isWebpack4, isWebpack5 };\n"]}

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Utility package which provides a set of tools for working in
+ * webpack plugins, loaders, and other integrations.
+ * @packageDocumentation
+ */
+import * as VersionDetection from './DetectWebpackVersion';
+export { VersionDetection };
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH,OAAO,KAAK,gBAAgB,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/lib/index.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionDetection = void 0;
+/**
+ * Utility package which provides a set of tools for working in
+ * webpack plugins, loaders, and other integrations.
+ * @packageDocumentation
+ */
+const VersionDetection = __importStar(require("./DetectWebpackVersion"));
+exports.VersionDetection = VersionDetection;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D;;;;GAIG;AAEH,yEAA2D;AAClD,4CAAgB","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Utility package which provides a set of tools for working in\n * webpack plugins, loaders, and other integrations.\n * @packageDocumentation\n */\n\nimport * as VersionDetection from './DetectWebpackVersion';\nexport { VersionDetection };\n"]}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@rushstack/webpack-plugin-utilities",
+  "version": "0.1.0",
+  "description": "This plugin sets the webpack public path at runtime.",
+  "main": "lib/index.js",
+  "typings": "dist/webpack-plugin-utilities.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack.git",
+    "directory": "webpack/webpack-plugin-utilities"
+  },
+  "peerDependencies": {
+    "@types/webpack": "^4.39.8",
+    "webpack": "^5.35.1"
+  },
+  "peerDependenciesMeta": {
+    "@types/webpack": {
+      "optional": true
+    },
+    "webpack": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@rushstack/eslint-config": "2.6.0",
+    "@rushstack/heft": "0.45.0",
+    "@rushstack/heft-node-rig": "1.9.1",
+    "@types/heft-jest": "1.0.1",
+    "@types/node": "12.20.24",
+    "@types/tapable": "1.0.6",
+    "webpack": "~5.68.0"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft build --clean"
+  },
+  "readme": "# webpack-plugin-utilities\n\n## Installation\n\n`npm install @rushstack/webpack-plugin-utilities --save`\n\n## Overview\n\nThis is a collection of utilities for writing webpack plugins\n\n# Usage\n\n```JavaScript\nimport { VersionDetection } from \"@rushstack/webpack-plugin-utilities\"\n\nclass MyExampleWebpackPlugin {\n  constructor() {\n    this.pluginName = \"MyExampleWebpackPlugin\"\n  }\n\n  apply(compiler) {\n    if (VersionDetection.isWebpack3OrEarlier(compiler)) {\n      throw new Error(`This plugin does not support webpack 3 or below.`)\n    }\n\n    const isWebpack4 = VersionDetection.isWebpack4(compiler);\n\n    if (isWebpack4) {\n      compiler.hooks.compilation.tap(this.pluginName, (compilation) => {\n        // ....\n      });\n    } else {\n      compiler.hooks.compilation.tap(this.pluginName, (compilation) => {\n        // ...\n      });\n    }\n  }\n}\n```\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/main/webpack/webpack-plugin-utilities/CHANGELOG.md) - Find\n  out what's new in the latest version\n\n`@rushstack/webpack-plugin-utilities` is part of the [Rush Stack](https://rushstack.io/) family of projects."
+}