Adding format option for Dll Plugin to get a formatted manifest json. #7992

declarations/plugins/DllPlugin.d.ts

@@ -13,6 +13,10 @@ export interface DllPluginOptions {
 	 * If true, only entry points will be exposed
 	 */
 	entryOnly?: boolean;
+	/**
+	 * If true, manifest json file (output) will be formatted
+	 */
+	format?: boolean;
 	/**
 	 * Name of the exposed dll function (external name, use value of 'output.library')
 	 */

lib/DllPlugin.js

@@ -20,6 +20,10 @@ class DllPlugin {
 	constructor(options) {
 		validateOptions(schema, options, "Dll Plugin");
 		this.options = options;
+
+		if (!options.format) {
+			this.options.format = false;
+		}
 	}
 
 	apply(compiler) {

lib/LibManifestPlugin.js

@@ -67,7 +67,11 @@ class LibManifestPlugin {
 									return obj;
 								}, Object.create(null))
 						};
-						const content = Buffer.from(JSON.stringify(manifest), "utf8");
+						// Apply formatting to content if format flag is true;
+						const manifestContent = this.options.format
+							? JSON.stringify(manifest, null, 2)
+							: JSON.stringify(manifest);
+						const content = Buffer.from(manifestContent, "utf8");
 						compiler.outputFileSystem.mkdirp(path.dirname(targetPath), err => {
 							if (err) return callback(err);
 							compiler.outputFileSystem.writeFile(

schemas/plugins/DllPlugin.json

@@ -12,6 +12,10 @@
       "description": "If true, only entry points will be exposed",
       "type": "boolean"
     },
+    "format": {
+      "description": "If true, manifest json file (output) will be formatted",
+      "type": "boolean"
+    },
     "name": {
       "description": "Name of the exposed dll function (external name, use value of 'output.library')",
       "type": "string",

test/configCases/dll-plugin-format/0-create-dll/dep.js

@@ -0,0 +1 @@
+module.exports = "foo";

test/configCases/dll-plugin-format/0-create-dll/index.js

@@ -0,0 +1,4 @@
+export { add } from "./utility";
+export default "Format";
+
+require("./dep");

test/configCases/dll-plugin-format/0-create-dll/test.config.js

@@ -0,0 +1 @@
+exports.noTests = true;

test/configCases/dll-plugin-format/0-create-dll/utility.js

@@ -0,0 +1,7 @@
+export function add(a, b) {
+	return a + b;
+}
+
+export function diff(a, b) {
+	return a - b;
+}

test/configCases/dll-plugin-format/0-create-dll/webpack.config.js

@@ -0,0 +1,23 @@
+var path = require("path");
+var webpack = require("../../../../");
+
+module.exports = {
+	entry: ["."],
+	resolve: {
+		extensions: [".js"]
+	},
+	output: {
+		filename: "dll.js",
+		chunkFilename: "[id].dll.js",
+		libraryTarget: "commonjs2"
+	},
+	plugins: [
+		new webpack.DllPlugin({
+			path: path.resolve(
+				__dirname,
+				"../../../js/config/dll-plugin-format/manifest0.json"
+			),
+			format: true
+		})
+	]
+};