Merge pull request #58 from hawtim/master

feat: support export result to json and support not showing logs

Author: MQuy

README.md

@@ -138,8 +138,28 @@ Whether to run unused export detection or not.
 #### options.log (default: `"all"`)
 
 `"all"`: show all messages.
+
 `"unused"`: only show messages when there are either unused files or unused export.
 
+`"none"`: won't show unused files or unused export messages in the terminal, it can keep terminal clean when set `exportJSON` to `true`
+
+#### options.exportJSON (default: `false`)
+
+`false`: won't create `deadcode.json` for the unused files and unused export.
+
+`true`: create `deadcode.json` for the unused files and unused export at the root of the project.
+
+You can set `exportJSON` to a specific path, and it will generate `deadcode.json` in that path.
+
+```js
+new DeadCodePlugin({
+  patterns: ["*.(js|css)"],
+  exclude: ["**/node_modules/**"],
+  log: "none",
+  exportJSON: "./analysis"
+}),
+```
+
 [npm]: https://img.shields.io/npm/v/webpack-deadcode-plugin.svg
 [npm-url]: https://npmjs.com/package/webpack-deadcode-plugin
 [node]: https://img.shields.io/node/v/webpack-deadcode-plugin.svg

samples/webpack.config.js

@@ -1,5 +1,5 @@
 const webpack = require("webpack");
-const DeadCodePlugin = require("webpack-deadcode-plugin");
+const DeadCodePlugin = require("../src/index");
 const HtmlWebpackPlugin = require("html-webpack-plugin");
 
 module.exports = {

samples/yarn.lock

@@ -921,9 +921,9 @@ camelcase@^5.0.0:
   integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==
 
 caniuse-lite@^1.0.30001254:
-  version "1.0.30001257"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001257.tgz#150aaf649a48bee531104cfeda57f92ce587f6e5"
-  integrity sha512-JN49KplOgHSXpIsVSF+LUyhD8PUp6xPpAXeRrrcBh4KBeP7W864jHn6RvzJgDlrReyeVjMFJL3PLpPvKIxlIHA==
+  version "1.0.30001356"
+  resolved "https://registry.npmmirror.com/caniuse-lite/-/caniuse-lite-1.0.30001356.tgz"
+  integrity sha512-/30854bktMLhxtjieIxsrJBfs2gTM1pel6MXKF3K+RdIVJZcsn2A2QdhsuR4/p9+R204fZw0zCBBhktX8xWuyQ==
 
 chalk@^2.0.0:
   version "2.4.2"
@@ -4057,7 +4057,7 @@ webpack-cli@4.8.0:
     webpack-merge "^5.7.3"
 
 webpack-deadcode-plugin@../:
-  version "0.1.15"
+  version "0.1.16"
   dependencies:
     chalk "^3.0.0"
     fast-glob "^3.1.1"

src/detect.js

@@ -1,6 +1,8 @@
 const path = require("path");
 const chalk = require("chalk");
+const fs = require("fs");
 const fg = require("fast-glob");
+const getDirName = path.dirname;
 
 function detectDeadCode(compilation, options) {
 	const isWebpack5 = compilation.chunkGraph ? true : false;
@@ -13,27 +15,60 @@ function detectDeadCode(compilation, options) {
 
 	if (options.detectUnusedFiles) {
 		unusedFiles = includedFiles.filter(file => !compiledFiles[file]);
-
-		if (Object.keys(unusedFiles).length > 0 || options.log === "all") {
+		if ((Object.keys(unusedFiles).length > 0 && options.log !== "none") || options.log === "all") {
 			logUnusedFiles(unusedFiles);
 		}
 	}
 
 	if (options.detectUnusedExport) {
 		unusedExportMap = getUsedExportMap(convertFilesToDict(includedFiles), compilation, isWebpack5);
 
-		if (Object.keys(unusedExportMap).length > 0 || options.log == "all") {
+		if ((Object.keys(unusedExportMap).length > 0 && options.log !== "none") || options.log === "all") {
 			logUnusedExportMap(unusedExportMap);
 		}
 	}
 
+	if (options.exportJSON) {
+		let exportPath = "deadcode.json";
+		if (typeof options.exportJSON === "string") {
+			exportPath = options.exportJSON + "/" + exportPath;
+		}
+		try {
+			fs.stat(exportPath, err => {
+				if (err == null) {
+					fs.unlinkSync(exportPath);
+					return exportResultToJSON(exportPath, unusedFiles, unusedExportMap);
+				}
+				if (err.code === "ENOENT") {
+					return exportResultToJSON(exportPath, unusedFiles, unusedExportMap);
+				}
+			});
+		} catch (error) {
+			console.error("export result to json error: ", error);
+		}
+	}
+
 	if (unusedFiles.length > 0 || unusedExportMap.length > 0) {
 		if (options.failOnHint) {
 			process.exit(2);
 		}
 	}
 }
 
+function exportResultToJSON(exportPath, unusedFiles, unusedExports) {
+	const data = {
+		unusedFiles,
+		unusedExports,
+	};
+	fs.mkdir(getDirName(exportPath), { recursive: true }, err => {
+		if (err) throw err;
+		fs.writeFile(exportPath, JSON.stringify(data, null, 2), err => {
+			if (err) throw err;
+			console.info(path.resolve(exportPath) + " is generated.");
+		});
+	});
+}
+
 function getPattern({ context, patterns, exclude }) {
 	return patterns
 		.map(pattern => path.resolve(context, pattern))

src/index.js

@@ -16,6 +16,7 @@ class WebpackDeadcodePlugin {
 				detectUnusedFiles: true,
 				detectUnusedExport: true,
 				log: "all",
+				exportJSON: false,
 			},
 			this.options,
 		);