Before sizes npm (#68)

* test: use non-deprecated form `file` in an additional test

* feat: option to check "before" size according to last npm package size

Also applies `rimraf` for cross-platform package script

* - Switch `showBeforeSizes` to preferred API

Author: brettz9

.gitignore

@@ -32,3 +32,6 @@ node_modules
 
 .idea
 dist
+
+# We use to gather npm packages
+.cache

.prettierignore

@@ -1,2 +1,3 @@
+.cache
 .nyc_output
 dist

Readme.md

@@ -48,13 +48,24 @@ default: false
 Whether to show [Brotli](https://www.wikiwand.com/en/Brotli) size or not
 
 #### showBeforeSizes
-type: `boolean`
-default: false
 
-Whether to show a comparison between the `output.file` file size as it was
-and as it is now being written. Useful to compare size of a new release to
-the previous one (though note that if you run Rollup multiple times, this
-info will be lost, except if still in your terminal history).
+type: `"release", ``"build"`, or `"none"`
+default: `"none"`
+
+Indicates how, if any, comparisons will be shown between the
+`output.file` file size as it was and as it is now being written.
+
+If set to `"release"`, will compare the file size at present to that of
+the last npm release.
+
+If set to `"build"`, the size of the file that is now being built will
+be compared to the immediately previous build. This means that if you run
+Rollup multiple times with this option, the info on the previous package
+size will be lost (since Rollup will have overwritten your copy), so with
+this option, you will need to consult your terminal history to see what the
+file size was prior to your changes. This option may be useful if you wish
+to compare size changes incrementally as you are developing rather than
+comparing to your last release.
 
 #### format
 

package.json

@@ -14,7 +14,7 @@
     "test": "nyc ava test/index.test.js",
     "pretest": "rollup -c",
     "prepublish": "npm run test",
-    "prebuild": "rm -rf dist/*"
+    "prebuild": "rimraf dist/*"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -39,13 +39,15 @@
     "colors": "^1.4.0",
     "filesize": "^6.1.0",
     "gzip-size": "^5.1.1",
+    "pacote": "^11.1.4",
     "terser": "^4.6.11"
   },
   "devDependencies": {
     "@babel/core": "^7.9.0",
     "@babel/plugin-syntax-import-meta": "^7.8.3",
     "@babel/preset-env": "^7.9.5",
     "@babel/register": "^7.9.0",
+    "@rollup/plugin-json": "^4.0.3",
     "ava": "^3.7.1",
     "babel-eslint": "^10.1.0",
     "babel-register": "^6.26.0",
@@ -55,6 +57,7 @@
     "esm": "^3.2.25",
     "nyc": "^15.0.1",
     "prettier": "^2.0.4",
+    "rimraf": "^3.0.2",
     "rollup": "^2.6.1",
     "rollup-plugin-babel": "^4.4.0"
   },

rollup.config.js

@@ -1,3 +1,4 @@
+import json from "@rollup/plugin-json";
 import babel from "rollup-plugin-babel";
 import pkg from "./package.json";
 
@@ -19,12 +20,15 @@ export default [
 	{
 		external: ["path", "fs", "util", ...Object.keys(pkg.dependencies)],
 		plugins: [
+			json(),
 			babel({
 				babelrc: false,
 				plugins: ["@babel/plugin-syntax-import-meta"],
 				presets: [["@babel/preset-env", { targets: { node: 8 } }]],
 			}),
-			filesize(),
+			filesize({
+				showBeforeSizes: "release",
+			}),
 		],
 		input: "src/index.js",
 		output: {
@@ -40,7 +44,9 @@ export default [
 					babelrc: false,
 					presets: [["@babel/preset-env", { targets: { node: 8 } }]],
 				}),
-				filesize(),
+				filesize({
+					showBeforeSizes: "release",
+				}),
 			],
 			input: `src/reporters/${reporter}`,
 			output: {

src/index.js

@@ -1,20 +1,23 @@
-import { readFile as origReadFile } from "fs";
+import { readFile as origReadFile, existsSync } from "fs";
 import { promisify } from "util";
-import { dirname, resolve as pathResolve } from "path";
+import { dirname, resolve as pathResolve, join } from "path";
 
 import fileSize from "filesize";
 import gzip from "gzip-size";
 import terser from "terser";
 import brotli from "brotli-size";
+import pacote from "pacote";
 
 const readFile = promisify(origReadFile);
 
+const thisDirectory = dirname(new URL(import.meta.url).pathname);
+
 export default function filesize(options = {}, env) {
 	let {
 		render,
 		format = {},
 		theme = "dark",
-		showBeforeSizes = false,
+		showBeforeSizes = "none",
 		showGzippedSize = true,
 		showBrotliSize = false,
 		showMinifiedSize = true,
@@ -25,14 +28,30 @@ export default function filesize(options = {}, env) {
 		const info = {};
 
 		let codeBefore;
-		if (showBeforeSizes) {
-			try {
-				codeBefore = await readFile(
-					outputOptions.file || outputOptions.dest,
-					"utf8"
+		if (showBeforeSizes !== "none") {
+			let file = outputOptions.file || outputOptions.dest;
+			if (showBeforeSizes !== "build") {
+				const { name, version } = await import(
+					join(process.cwd(), "./package.json")
 				);
-			} catch (err) {
-				// File might not exist
+				try {
+					const output = join(thisDirectory, "../.cache");
+					if (!existsSync(output)) {
+						await pacote.extract(`${name}@${version}`, output);
+					}
+					file = join(output, file);
+				} catch (err) {
+					// Package might not exist
+					file = null;
+				}
+			}
+
+			if (file) {
+				try {
+					codeBefore = await readFile(file, "utf8");
+				} catch (err) {
+					// File might not exist
+				}
 			}
 		}
 

test/fixtures/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@ritz078/nonexistent-package",
+  "version": "0.0.0"
+}

test/index.test.js

@@ -1,14 +1,22 @@
+import { promisify } from "util";
 import test from "ava";
+import rimRaf from "rimraf";
 import colors from "colors/safe";
 import filesize from "../src/index.js";
 
+const rimraf = promisify(rimRaf);
+
 const x = filesize({}, "test");
 
 const bundle = {
 	fileName: "test/fixtures/bundled-file.js",
 	code: "function add(first, second) { return first + second; }",
 };
 
+async function removeCacheDir() {
+	return await rimraf(".cache");
+}
+
 async function getStdout(cb) {
 	const originalStdoutWrite = process.stdout.write.bind(process.stdout);
 
@@ -31,6 +39,10 @@ test("fileSize should return a string", async (t) => {
 	t.is(typeof (await x({ file: "abc.js" }, bundle)), "string");
 });
 
+test("fileSize should return a string (with deprecated `dest`)", async (t) => {
+	t.is(typeof (await x({ dest: "abc.js" }, bundle)), "string");
+});
+
 test("fileSize should allow custom reporter", async (t) => {
 	const getLoggingData = filesize(
 		{
@@ -44,7 +56,7 @@ test("fileSize should allow custom reporter", async (t) => {
 			format: {},
 			theme: "dark",
 			// reporter: [AsyncFunction: customReporter],
-			showBeforeSizes: false,
+			showBeforeSizes: "none",
 			showGzippedSize: true,
 			showBrotliSize: false,
 			showMinifiedSize: true,
@@ -146,30 +158,80 @@ test("fileSize should generate a bundle", async (t) => {
 });
 
 test("fileSize should apply `showBeforeSizes` option", async (t) => {
-	const getLoggingData = filesize({ showBeforeSizes: true }, "test");
-	const val = await getLoggingData(
-		{ file: "./test/fixtures/sample.js" },
-		bundle
-	);
+	const getLoggingData = filesize({ showBeforeSizes: "release" }, "test");
+	const val = await getLoggingData({ file: "./dist/index.js" }, bundle);
 	if (colors.supportsColor()) {
 		// eslint-disable-next-line no-control-regex
-		t.regex(val, /\(was \u001b\[33m21 B/);
+		t.regex(val, /\(was \u001b\[33m[\d.]+ KB/);
 	} else {
-		t.regex(val, /\(was 21 B/);
+		t.regex(val, /\(was [\d.]+ KB/);
+	}
+});
+
+test('fileSize should apply `showBeforeSizes` option as "build"', async (t) => {
+	await removeCacheDir();
+
+	const getLoggingData = filesize({ showBeforeSizes: "build" }, "test");
+	const val = await getLoggingData({ file: "./dist/index.js" }, bundle);
+	if (colors.supportsColor()) {
+		// eslint-disable-next-line no-control-regex
+		t.regex(val, /\(was \u001b\[33m[\d.]+ K?B/);
+	} else {
+		t.regex(val, /\(was [\d.]+ K?B/);
+	}
+});
+
+test('fileSize should ignore before sizes with package-missing file and `showBeforeSizes: "release"`', async (t) => {
+	await removeCacheDir();
+
+	let getLoggingData = filesize({ showBeforeSizes: "release" }, "test");
+	let val = await getLoggingData({ file: "./test/fixtures/sample.js" }, bundle);
+	if (colors.supportsColor()) {
+		// eslint-disable-next-line no-control-regex
+		t.notRegex(val, /\(was /);
+	} else {
+		t.notRegex(val, /\(was /);
+	}
+
+	// Run again (without deleting cache directory) to get coverage of cache
+	getLoggingData = filesize({ showBeforeSizes: "release" }, "test");
+	val = await getLoggingData({ file: "./test/fixtures/sample.js" }, bundle);
+	if (colors.supportsColor()) {
+		// eslint-disable-next-line no-control-regex
+		t.notRegex(val, /\(was /);
+	} else {
+		t.notRegex(val, /\(was /);
+	}
+});
+
+test("fileSize should ignore before sizes with bad package", async (t) => {
+	await removeCacheDir();
+
+	const oldCwd = process.cwd();
+	const getLoggingData = filesize({ showBeforeSizes: "release" }, "test");
+
+	// Change directory without giving a chance for other tests to use
+	process.chdir("./test/fixtures");
+	const prom = getLoggingData({ file: "./sample.js" }, bundle);
+	process.chdir(oldCwd);
+	const val = await prom;
+
+	if (colors.supportsColor()) {
+		// eslint-disable-next-line no-control-regex
+		t.notRegex(val, /\(was /);
+	} else {
+		t.notRegex(val, /\(was /);
 	}
 });
 
 test("fileSize should apply `showBeforeSizes` option (with deprecated `dest`)", async (t) => {
-	const getLoggingData = filesize({ showBeforeSizes: true }, "test");
-	const val = await getLoggingData(
-		{ dest: "./test/fixtures/sample.js" },
-		bundle
-	);
+	const getLoggingData = filesize({ showBeforeSizes: "release" }, "test");
+	const val = await getLoggingData({ dest: "./dist/index.js" }, bundle);
 	if (colors.supportsColor()) {
 		// eslint-disable-next-line no-control-regex
-		t.regex(val, /\(was \u001b\[33m21 B/);
+		t.regex(val, /\(was \u001b\[33m[\d.]+ KB/);
 	} else {
-		t.regex(val, /\(was 21 B/);
+		t.regex(val, /\(was [\d.]+ KB/);
 	}
 });
 
@@ -232,7 +294,7 @@ test("fileSize should show Brotli size when configured", async (t) => {
 test("fileSize should show before Brotli size when configured", async (t) => {
 	let getLoggingData = filesize(
 		{
-			showBeforeSizes: true,
+			showBeforeSizes: "build",
 			showBrotliSize: true,
 		},
 		"test"
@@ -251,7 +313,7 @@ test("fileSize should show before Brotli size when configured", async (t) => {
 
 	getLoggingData = filesize(
 		{
-			showBeforeSizes: true,
+			showBeforeSizes: "build",
 			showBrotliSize: true,
 			showMinifiedSize: false,
 			showGzippedSize: false,
@@ -271,7 +333,7 @@ test("fileSize should show before Brotli size when configured", async (t) => {
 
 	getLoggingData = filesize(
 		{
-			showBeforeSizes: true,
+			showBeforeSizes: "build",
 			showBrotliSize: true,
 			showMinifiedSize: true,
 			showGzippedSize: false,
@@ -292,7 +354,7 @@ test("fileSize should show before Brotli size when configured", async (t) => {
 
 	getLoggingData = filesize(
 		{
-			showBeforeSizes: true,
+			showBeforeSizes: "build",
 			showBrotliSize: true,
 			showMinifiedSize: false,
 			showGzippedSize: true,