@studyportals/webpack-helper 2.4.3 → 3.0.0-beta.10

package/README.md

@@ -1,201 +1,250 @@
-# WebpackHelper
-
-WebpackHelper is a utility that makes it easy to set up a webpack configuration for Studyportals' projects that adhere to our [Webpack quality criteria](https://knowledge-vault.studyportals.xyz/quality-standards/front-end/webpack-quality-criteria.html).
-
-## Table of Contents
-- [Quick Start](#quick-start)
-- [Configuration](#configuration)
-  - [entry](#entry-required)
-  - [output](#output-required)
-  - [preset](#preset)
-  - [bob](#bob)
-  - [common](#common)
-  - [development](#development)
-  - [production](#production)
-- [Presets](#presets)
-  - [javascript](#javascript)
-  - [typescript](#typescript)
-  - [vue-typescript](#vue-typescript)
-- [DoD compliance with Babel and Browserslist](#dod-compliance-with-babel-and-browserslist) 
-
-## Quick Start
-
-```bash
-npm i -D @studyportals/webpack-helper
-```
-
-After installation, getting started is quite easy. Just set up a `webpack.config.js` file in the root of your project, require Webpack Helper and set up a configuration using it's `create` method like so:
-
-```javascript
-const path = require('path');
-const WebpackHelper = require("@studyportals/webpack-helper");
-
-const configuration = WebpackHelper.create({
-	entry: [
-		"./src/main.ts"
-	],
-	output: {
-		path: path.resolve(__dirname, './dist'),
-		fileName: 'bundle',
-		hash: true,
-		// Use this if you want to control hashing for js and css separately
-		hash: {
-			js: true,
-			css: false
-		}
-	},
-	preset: "vue-typescript",
-	bob: {
-		name: 'MicroService',
-		html: '<div id=\"MicroServicePlaceholder\"></div>',
-		baseURL: '/dist',
-		defer: ['style'],
-		dllPackages: [
-			{
-				name: "package-dll",
-				manifest: require("@studyportals/package-dll/dist/manifest.json")
-			}
-		]
-	},
-	common: {
-		//any config
-	},
-	development: {
-		//any config
-	},
-	production: {
-		//any config
-	}
-});
-```
-
-When your configuration is created you can get an instance of it for the correct environment and export it for webpack to use like so:
-
-```javascript
-module.exports = mode => configuration.get(mode);
-```
-## Configuration
-
-Webpack Helper offers a compact but flexible configuration interface. Below you will find every option available.
-
-### entry **(required)**
-
-The entrypoint for your webpack bundle. This can either be configured as an object with the bundle name as a key and the path as a value or as an array of paths if your project requires multiple entry points.
-
-```javascript
-entry: [
-	"./src/main.ts"
-]
-
-//or
-
-entry: {
-	bundle: "./src/main.ts"
-}
-```
-
-### output **(required)**
-
-The output object has some options that define how your bundle will be output. It has the following properties:
-
-- `path`**(required)**: The target directory for all output files.
-- `library`: The name of the exported library, which will also be used to namespace sourcemaps. This will default to `null`.
-- `publicPath`: The url to the output directory resolved relative to the HTML page. This will default to `null`.
-- `fileName`: A custom filename for your bundle. This will default to `[name]` which refers to the name you've given your entrypoint.
-- `hash`: Whether or not to add build hashes to your filenames. This will default to `true`. Whenever you want different values for your js and css you can pass an object with separate properties and values as in the example below.
-- `crossOriginLoading`: Tells webpack to enable cross-origin loading of chunks. Can either be set to `anonymous` or `user-credentials`.
-
-```javascript
-output: {
-	path: path.resolve(__dirname, './dist'),
-	library: 'test-microservice',
-	publicPath: '/assets/',
-	fileName: 'application',
-	crossOriginLoading: 'anonymous',
-	hash: false,
-	//or
-	hash: {
-		js: true,
-		css: false
-	}
-}
-```
-
-### preset
-
-The preset property determines which preset to load into your webpack configuration.
-
-```javascript
-preset: "vue-typescript | typescript | javascript"
-```
-
-### bob
-
-The bob object adds all necessary configuration to have your project generate a manifest file to be used by [Bob](https://github.com/studyportals/Bob).
-
-- `name`**(required)**: The name of your microservice.
-- `html`**(required)**: The HTML that needs to be output by your microservice. Can be a path to a document or a snippet.
-- `baseURL`: The baseURL for your microservice assets.
-- `async`: An array of JS filenames to be loaded async.
-- `defer`: An array of CSS filenames to be lazy-loaded.
-- `exclude`: An array of filenames (CSS and JS) that should be excluded from your manifest file.
-- `dllPackages`: An array of objects that reference your Dll dependencies. They all require a name and a Dll manifest in the form of a json file.
-
-```javascript
-bob: {
-	name: 'MicroService',
-	html: '<div id=\"MicroServicePlaceholder\"></div>',
-	baseURL: '/dist',
-	defer: ['style'],
-	exclude: ['demo-assets'],
-	dllPackages: [
-		{
-			name: "package-dll",
-			manifest: require("@studyportals/package-dll/dist/manifest.json")
-		}
-	]
-}
-```
-
-WebpackHelper uses [BobManifestGenerator](https://github.com/studyportals/BobManifestGenerator) to generate a manifest file.
-
-### common
-
-Extra Webpack configuration to be used for all environments can be passed in the `common` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
-
-### development
-
-Extra Webpack configuration to be used for all development builds can be passed in the `development` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
-
-**NOTE**: Some default configuration for development builds will be added automatically. Details can be found [here](src/defaults/defaults.md).
-
-### production
-
-Extra Webpack configuration to be used for all production builds can be passed in the `production` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
-
-**NOTE**: Some default configuration for production builds will be added automatically. Details can be found [here](src/defaults/defaults.md).
-
-## Presets
-
-In order to make your life as easy as possible, Webpack Helper ships with a set of presets that will take care of putting some essential plugins and loaders in your configuration. The different presets are listed below.
-
-More in depth information on what configuration these presets will add to your project can be found [here](src/presets/presets.md).
-
-### javascript
-
-The javascript preset will resolve all `.js` and `.json` files and transpiles them with Babel. If your project has styling, it will separate that out in a separate `.css` file.
-
-### typescript
-
-The typescript preset will resolve all `.ts`, `.tsx`, `.js` and `.json` files. It transpiles them using tsc and Babel. Be aware that you will need to include a `tsconfig.json` in your project for it to work properly. If your project has styling, it will separate that out in a separate `.css` file.
-
-### vue-typescript
-
-The vue-typescript preset will resolve all `.vue`, `.ts`, `.tsx`, `.js` and `.json` files. It transpiles them using vue-loader, tsc and Babel. Be aware that you will need to include a `tsconfig.json` in your project for it to work properly. If your project has styling, it will separate that out in a separate `.css` file.
-
-## DoD compliance with Babel and Browserslist
-
-In order to comply to [Studyportals' definition of done](https://knowledge-vault.studyportals.xyz/definitions-of-done/product/) we use `babel` to transpile our front-end code according to the browsers we need to support. To do this your project needs some configuration. When Webpack Helper is installed it will put standard configuration in the root of your project which consists of 2 files:
-
-- `.babelrc`: A standard configuration for babel that loads the `babel-env` and `babel-typescripts` presets. You might need to add more plugins for your specific project.
-- `.browserslistrc`: A configuration file for browserslist. This is used by `babel-env` to determine which browsers to transpile the code for. Within this file the configuration for student facing products will be loaded by default but other configurations can be easily loaded by uncommenting some lines.
+# WebpackHelper
+
+WebpackHelper is a utility that makes it easy to set up a webpack configuration for Studyportals' projects that adhere to our [Webpack quality criteria](https://knowledge-vault.studyportals.xyz/quality-standards/front-end/webpack-quality-criteria.html).
+
+## Table of Contents
+- [Webpack version](#webpack-version)
+  - [Notes on updating Webpack from v4 to v5](#notes-on-updating-webpack-from-v4-to-v5)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+  - [entry](#entry-required)
+  - [output](#output-required)
+  - [preset](#preset)
+  - [bob](#bob)
+  - [common](#common)
+  - [development](#development)
+  - [production](#production)
+- [Presets](#presets)
+  - [javascript](#javascript)
+  - [typescript](#typescript)
+  - [vue-typescript](#vue-typescript)
+- [DoD compliance with Babel and Browserslist](#dod-compliance-with-babel-and-browserslist) 
+
+## Webpack version
+This version of WebpackHelper is based on webpack 5. Some earlier WebpackHelper versions used earlier versions of Webpack. If you get syntax errors when updating to the latest version of WebpackHelper, please check out the [Webpack documentation](https://webpack.js.org/configuration/).
+
+### Notes on updating Webpack from v4 to v5
+Below are some notes that might be helpful when you're upgrading a microservice from webpack-helper v2 (based on Webpack v4) to v3 (based on Webpack v5).
+
+#### Dev server
+Webpack-helper **v2 and below**: Your `development.devServer` file might include these parts:
+```javascript
+{
+    development: {
+        devServer: {
+            open: true,
+            overlay: true,
+            writeToDisk: true
+        }
+    }
+}
+```
+Webpack-helper **v3 and beyond**: Your `webpack.config.js` file should configure those parts like this:
+```javascript
+{
+    development: {
+        devServer: {
+            client: {
+                overlay: true
+            },
+            devMiddleware: {
+                writeToDisk: true
+            },
+            open: true,
+            static: path.join(__dirname, '.') // Related to writeToDisk.
+        }
+    }
+}
+```
+
+#### Exporting
+Webpack-helper **v2 and below**: Your `webpack.config.js` file ended with the following:
+```javascript
+module.exports = mode => configuration.get(mode);
+```
+Webpack-helper **v3 and beyond**: Your `webpack.config.js` file should end with the following (as is also mentioned further below):
+```javascript
+module.exports = (env, details) => configuration.get(details.mode);
+```
+
+## Quick Start
+
+```bash
+npm i -D @studyportals/webpack-helper
+```
+
+After installation, getting started is quite easy. Just set up a `webpack.config.js` file in the root of your project, require Webpack Helper and set up a configuration using it's `create` method like so:
+
+```javascript
+const path = require('path');
+const WebpackHelper = require("@studyportals/webpack-helper");
+
+const configuration = WebpackHelper.create({
+	entry: [
+		"./src/main.ts"
+	],
+	output: {
+		path: path.resolve(__dirname, './dist'),
+		fileName: 'bundle',
+		hash: true,
+		// Use this if you want to control hashing for js and css separately
+		hash: {
+			js: true,
+			css: false
+		}
+	},
+	preset: "vue-typescript",
+	bob: {
+		name: 'MicroService',
+		html: '<div id=\"MicroServicePlaceholder\"></div>',
+		baseURL: '/dist',
+		defer: ['style'],
+		dllPackages: [
+			{
+				name: "package-dll",
+				manifest: require("@studyportals/package-dll/dist/manifest.json")
+			}
+		]
+	},
+	common: {
+		//any config
+	},
+	development: {
+		//any config
+	},
+	production: {
+		//any config
+	}
+});
+```
+
+When your configuration is created you can get an instance of it for the correct environment and export it for webpack to use like so:
+
+```javascript
+module.exports = (env, details) => configuration.get(details.mode);
+```
+## Configuration
+
+Webpack Helper offers a compact but flexible configuration interface. Below you will find every option available.
+
+### entry **(required)**
+
+The entrypoint for your webpack bundle. This can either be configured as an object with the bundle name as a key and the path as a value or as an array of paths if your project requires multiple entry points.
+
+```javascript
+entry: [
+	"./src/main.ts"
+]
+
+//or
+
+entry: {
+	bundle: "./src/main.ts"
+}
+```
+
+### output **(required)**
+
+The output object has some options that define how your bundle will be output. It has the following properties:
+
+- `path`**(required)**: The target directory for all output files.
+- `library`: The name of the exported library, which will also be used to namespace sourcemaps. This will default to `null`.
+- `publicPath`: The url to the output directory resolved relative to the HTML page. This will default to `null`.
+- `fileName`: A custom filename for your bundle. This will default to `[name]` which refers to the name you've given your entrypoint.
+- `hash`: Whether or not to add build hashes to your filenames. This will default to `true`. Whenever you want different values for your js and css you can pass an object with separate properties and values as in the example below.
+- `crossOriginLoading`: Tells webpack to enable cross-origin loading of chunks. Can either be set to `anonymous` or `user-credentials`.
+
+```javascript
+output: {
+	path: path.resolve(__dirname, './dist'),
+	library: 'test-microservice',
+	publicPath: '/assets/',
+	fileName: 'application',
+	crossOriginLoading: 'anonymous',
+	hash: false,
+	//or
+	hash: {
+		js: true,
+		css: false
+	}
+}
+```
+
+### preset
+
+The preset property determines which preset to load into your webpack configuration.
+
+```javascript
+preset: "vue-typescript | typescript | javascript"
+```
+
+### bob
+
+The bob object adds all necessary configuration to have your project generate a manifest file to be used by [Bob](https://github.com/studyportals/Bob).
+
+- `name`**(required)**: The name of your microservice.
+- `html`**(required)**: The HTML that needs to be output by your microservice. Can be a path to a document or a snippet.
+- `baseURL`: The baseURL for your microservice assets.
+- `async`: An array of JS filenames to be loaded async.
+- `defer`: An array of CSS filenames to be lazy-loaded.
+- `exclude`: An array of filenames (CSS and JS) that should be excluded from your manifest file.
+- `dllPackages`: An array of objects that reference your Dll dependencies. They all require a name and a Dll manifest in the form of a json file.
+
+```javascript
+bob: {
+	name: 'MicroService',
+	html: '<div id=\"MicroServicePlaceholder\"></div>',
+	baseURL: '/dist',
+	defer: ['style'],
+	exclude: ['demo-assets'],
+	dllPackages: [
+		{
+			name: "package-dll",
+			manifest: require("@studyportals/package-dll/dist/manifest.json")
+		}
+	]
+}
+```
+
+WebpackHelper uses [BobManifestGenerator](https://github.com/studyportals/BobManifestGenerator) to generate a manifest file.
+
+### common
+
+Extra Webpack configuration to be used for all environments can be passed in the `common` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
+
+### development
+
+Extra Webpack configuration to be used for all development builds can be passed in the `development` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
+
+**NOTE**: Some default configuration for development builds will be added automatically. Details can be found [here](src/defaults/defaults.md).
+
+### production
+
+Extra Webpack configuration to be used for all production builds can be passed in the `production` object. This configuration needs to adhere to Webpack's configuration interface and will be merged in with the other configuration through [webpack-merge](https://github.com/survivejs/webpack-merge).
+
+**NOTE**: Some default configuration for production builds will be added automatically. Details can be found [here](src/defaults/defaults.md).
+
+## Presets
+
+In order to make your life as easy as possible, Webpack Helper ships with a set of presets that will take care of putting some essential plugins and loaders in your configuration. The different presets are listed below.
+
+More in depth information on what configuration these presets will add to your project can be found [here](src/presets/presets.md).
+
+### javascript
+
+The javascript preset will resolve all `.js` and `.json` files and transpiles them with Babel. If your project has styling, it will separate that out in a separate `.css` file.
+
+### typescript
+
+The typescript preset will resolve all `.ts`, `.tsx`, `.js` and `.json` files. It transpiles them using tsc and Babel. Be aware that you will need to include a `tsconfig.json` in your project for it to work properly. If your project has styling, it will separate that out in a separate `.css` file.
+
+### vue-typescript
+
+The vue-typescript preset will resolve all `.vue`, `.ts`, `.tsx`, `.js` and `.json` files. It transpiles them using vue-loader, tsc and Babel. Be aware that you will need to include a `tsconfig.json` in your project for it to work properly. If your project has styling, it will separate that out in a separate `.css` file.
+
+## DoD compliance with Babel and Browserslist
+
+In order to comply to [Studyportals' definition of done](https://knowledge-vault.studyportals.xyz/definitions-of-done/product/) we use `babel` to transpile our front-end code according to the browsers we need to support. To do this your project needs some configuration. When Webpack Helper is installed it will put standard configuration in the root of your project which consists of 2 files:
+
+- `.babelrc`: A standard configuration for babel that loads the `babel-env` and `babel-typescripts` presets. You might need to add more plugins for your specific project.
+- `.browserslistrc`: A configuration file for browserslist. This is used by `babel-env` to determine which browsers to transpile the code for. Within this file the configuration for student facing products will be loaded by default but other configurations can be easily loaded by uncommenting some lines.

package/assets/.babelrc

@@ -1,11 +1,11 @@
-{
-  "plugins": [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-transform-modules-commonjs",
-    "@babel/plugin-syntax-dynamic-import"
-  ],
-  "presets": [
-    "@babel/preset-env",
-    "@babel/preset-typescript"
-  ]
+{
+  "plugins": [
+    "@babel/plugin-proposal-class-properties",
+    "@babel/plugin-transform-modules-commonjs",
+    "@babel/plugin-syntax-dynamic-import"
+  ],
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-typescript"
+  ]
 }

package/assets/.browserslistrc

@@ -1,3 +1,3 @@
-#extends @studyportals/browserslist-config/clients
-#extends @studyportals/browserslist-config/internal
+#extends @studyportals/browserslist-config/clients
+#extends @studyportals/browserslist-config/internal
 extends @studyportals/browserslist-config/student

package/package.json

@@ -1,58 +1,58 @@
-{
-  "name": "@studyportals/webpack-helper",
-  "version": "2.4.3",
-  "description": "A collection of standard configurations and helpers for webpack.",
-  "main": "src/main.js",
-  "scripts": {
-    "test": "jest --coverage",
-    "build": "tsc ./src/**/*.ts",
-    "prepublish": "npm run build",
-    "postinstall": "cp ./assets/.babelrc ./assets/.browserslistrc ../../../"
-  },
-  "files": [
-    "src/**/*.js",
-    "assets/*"
-  ],
-  "author": {
-    "name": "Frank Kluijtmans",
-    "email": "frank@studyportals.com"
-  },
-  "license": "ISC",
-  "dependencies": {
-    "@babel/core": "^7.5.5",
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-transform-modules-commonjs": "^7.5.0",
-    "@babel/plugin-transform-runtime": "^7.5.5",
-    "@babel/plugin-transform-typescript": "^7.5.5",
-    "@babel/preset-env": "^7.5.5",
-    "@babel/preset-typescript": "^7.3.3",
-    "@babel/runtime": "^7.5.5",
-    "@studyportals/bob-manifest-generator": "^2.3.1",
-    "@studyportals/browserslist-config": "^1.2.0",
-    "@studyportals/dll-availability-tracker": "^1.0.2",
-    "@studyportals/vue-config": "^3.0.0",
-    "babel-loader": "^8.0.6",
-    "css-loader": "^3.4.2",
-    "file-loader": "^6.0.0",
-    "mini-css-extract-plugin": "^0.9.0",
-    "node-sass": "^4.13.1",
-    "optimize-css-assets-webpack-plugin": "^5.0.3",
-    "path": "^0.12.7",
-    "sass-loader": "^8.0.2",
-    "terser-webpack-plugin": "^2.3.4",
-    "ts-loader": "^6.2.1",
-    "typescript": "^3.7.2",
-    "vue-loader": "^15.8.3",
-    "vue-template-compiler": "2.5.16",
-    "webpack": "^4.41.2",
-    "webpack-cli": "^3.3.10",
-    "webpack-merge": "^4.2.2"
-  },
-  "devDependencies": {
-    "@types/node": "^12.12.30",
-    "babel-jest": "^25.1.0",
-    "jest": "^25.1.0",
-    "ts-jest": "^25.2.1"
-  }
-}
+{
+  "name": "@studyportals/webpack-helper",
+  "version": "3.0.0-beta.10",
+  "description": "A collection of standard configurations and helpers for webpack.",
+  "main": "src/main.js",
+  "scripts": {
+    "test": "jest --coverage",
+    "build": "tsc",
+    "prepublish": "npm run build",
+    "postinstall": "cp ./assets/.babelrc ./assets/.browserslistrc ../../../"
+  },
+  "files": [
+    "src/**/*.js",
+    "assets/*"
+  ],
+  "author": {
+    "name": "Frank Kluijtmans",
+    "email": "frank@studyportals.com"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "@babel/core": "^7.5.5",
+    "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
+    "@babel/plugin-transform-modules-commonjs": "^7.5.0",
+    "@babel/plugin-transform-runtime": "^7.5.5",
+    "@babel/plugin-transform-typescript": "^7.5.5",
+    "@babel/preset-env": "^7.5.5",
+    "@babel/preset-typescript": "^7.3.3",
+    "@babel/runtime": "^7.5.5",
+    "@studyportals/bob-manifest-generator": "^3.0.0-beta.1",
+    "@studyportals/browserslist-config": "^1.2.0",
+    "@studyportals/dll-availability-tracker": "^1.0.2",
+    "@studyportals/vue-config": "4.0.0-beta.4",
+    "babel-loader": "^8.2.3",
+    "css-loader": "^6.5.1",
+    "file-loader": "^6.2.0",
+    "mini-css-extract-plugin": "^2.5.3",
+    "optimize-css-assets-webpack-plugin": "^5.0.8",
+    "path": "^0.12.7",
+    "sass": "^1.49.7",
+    "sass-loader": "^12.4.0",
+    "terser-webpack-plugin": "^5.3.1",
+    "ts-loader": "^9.2.6",
+    "typescript": "^3.7.2",
+    "vue-loader": "^16.2.0",
+    "webpack": "^5.68.0",
+    "webpack-cli": "^4.9.1",
+    "webpack-merge": "^5.8.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.0",
+    "@types/node": "^17.0.14",
+    "babel-jest": "^25.1.0",
+    "jest": "^25.1.0",
+    "ts-jest": "^25.2.1"
+  }
+}

package/src/defaults/development.config.js

@@ -1,7 +1,8 @@
-"use strict";
-exports.__esModule = true;
-exports.DevelopmentConfig = {
-    optimization: {
-        minimize: false
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevelopmentConfig = void 0;
+exports.DevelopmentConfig = {
+    optimization: {
+        minimize: false
+    }
+};