You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: packages/dotcom-page-kit-cli/README.md
+15-13
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,8 @@ page-kit --help
37
37
38
38
This action can be used to assemble the static assets for your application using Webpack. By default this action includes only a barebones Webpack configuration to bundle JavaScript source code but this can be extended via plugins to add additional functionality.
39
39
40
+
The action also creates a `manifest.json` (the file name is default but can be [configured](#Manifest-file-name)). It includes the hashed output names for the generated `.js` and `.css` chunks
41
+
40
42
#### Options
41
43
42
44
##### Entry points
@@ -93,7 +95,7 @@ Files will be created using the pattern `[name].js` in development mode and `[na
93
95
94
96
##### Manifest file name
95
97
96
-
The name of the generated manifest file can be changed via the configuration file. The default file name is `"manifest.json"`.
98
+
The generated manifest file details the hashed output names for the emitted `.js` and `.css` chunks. The file name can be changed via the configuration file. The default file name is `"manifest.json"`.
97
99
98
100
Usage via configuration file:
99
101
@@ -161,14 +163,22 @@ import { hooks } from '@financial-times/dotcom-page-kit-cli'
161
163
162
164
_Please note: The hooks below are listed in the order they will be executed._
163
165
164
-
##### `WEBPACK_MANIFEST_PLUGIN_OPTIONS`
165
-
166
-
Configuration options for the [assets manifest plugin](https://github.com/webdeveric/webpack-assets-manifest).
167
-
168
166
##### `WEBPACK_CLEAN_PLUGIN_OPTIONS`
169
167
170
168
Configuration options for the [clean plugin](https://github.com/johnagan/clean-webpack-plugin).
171
169
170
+
##### `WEBPACK_COMPRESSION_PLUGIN_OPTIONS`
171
+
172
+
Configuration options for the [compression plugin](https://github.com/webpack-contrib/compression-webpack-plugin)
173
+
174
+
##### `WEBPACK_BROTLI_PLUGIN_OPTIONS`
175
+
176
+
Configuration options for the [brotli compression plugin](https://github.com/mynameiswhm/brotli-webpack-plugin)
177
+
178
+
##### `WEBPACK_MANIFEST_PLUGIN_OPTIONS`
179
+
180
+
Configuration options for the [assets manifest plugin](https://github.com/webdeveric/webpack-assets-manifest) which provides the compilation entrypoints for each bundle by asset type e.g. `scripts` and `styles`.
181
+
172
182
##### `BABEL_CONFIG`
173
183
174
184
Configuration options for [Babel](https://babeljs.io/docs/en/options).
@@ -183,14 +193,6 @@ The Webpack [rule] for handling JavaScript files.
0 commit comments