@node-cli/bundlesize 2.1.4 → 3.0.0

package/README.md

@@ -12,56 +12,74 @@
 
 ## Configuration
 
-A configuration file must be provided via the `-c` parameter, it must export an array of objects with the following properties:
+A configuration file must be provided via the `-c` parameter.
+
+For the size option, it must export an object named "size" which is an array of objects with the following properties:
 
 - `path`: the path to the file to check
 - `limit`: the limit to check against
 
-### Examples
+For the report option, it must export an object named "report" which is an object with the following properties:
+
+- `header`: the header to display (optional, string)
+- `footer`: the footer to display (optional, function receiving a boolean indicating if the limit has been reached, and a value corresponding to the diff. It must return a string)
+- `previous`: the previous path to the report to compare against (required, string)
+- `current`: the current path to the report to compare against (required, string)
+- `columns`: the columns to display (optional, array of objects)
+
+## Examples
+
+### Getting stats from files
 
 #### Single file
 
 ```js
-export default [
-	{
-		path: "dist/some-bundle.js",
-		limit: "10 kB",
-	},
-];
+export default {
+	sizes: [
+		{
+			path: "dist/some-bundle.js",
+			limit: "10 kB",
+		},
+	],
+};
 ```
 
 #### Multiple files
 
 ```js
-export default [
-	{
-		path: "dist/some-bundle.js",
-		limit: "10 kB",
-	},
-	{
-		path: "dist/some-other-bundle.js",
-		limit: "100 kB",
-	},
-];
+export default {
+	sizes: [
+		{
+			path: "dist/some-bundle.js",
+			limit: "10 kB",
+		},
+		{
+			path: "dist/some-other-bundle.js",
+			limit: "100 kB",
+		},
+	],
+};
 ```
 
 #### With glob patterns
 
 ```js
-export default [
-	{
-		path: "dist/**/some-bundle.js",
-		limit: "10 kB",
-	},
-	{
-		path: "dist/**/some-other-bundle-*.js",
-		limit: "100 kB",
-	},
-	{
-		path: "dist/**/extra-+([a-zA-Z0-9]).js",
-		limit: "100 kB",
-	},
-];
+export default {
+	sizes: [
+		{
+			path: "dist/**/some-bundle.js",
+			limit: "10 kB",
+		},
+		{
+			path: "dist/**/some-other-bundle-*.js",
+			limit: "100 kB",
+		},
+		{
+			path: "dist/**/extra-+([a-zA-Z0-9]).js",
+			limit: "100 kB",
+		},
+	],
+};
 ```
 
 #### With a hash
@@ -76,9 +94,65 @@ The special keyword `<hash>` can be used to match a hash in the filename. It can
 | Not OK | `dist/**/some-bundle-<hash>.js` | If multiple files match the pattern  |
 | Not OK | `dist/**/some-bundle-<hash>.*`  | Cannot use `<hash>` with `*`         |
 
+### Printing reports from stats
+
+#### Simple report
+
+```js
+export default {
+	report: {
+		prev: "stats/previous.json",
+		current: "stats/current.json",
+	},
+};
+```
+
+#### Simple report with custom header
+
+```js
+export default {
+	report: {
+		header: "## My custom header",
+		prev: "stats/previous.json",
+		current: "stats/current.json",
+	},
+};
+```
+
+#### Simple report with custom footer
+
+```js
+export default {
+	report: {
+		footer: (limitReached, diff) => {
+			return `## My custom footer: ${limitReached} ${diff}`;
+		},
+		prev: "stats/previous.json",
+		current: "stats/current.json",
+	},
+};
+```
+
+#### Simple report with custom columns
+
+```js
+export default {
+	report: {
+		columns: [
+			{ status: "Status" },
+			{ file: "File" },
+			{ size: "Size" },
+			{ limits: "Limits" },
+		],
+		prev: "stats/previous.json",
+		current: "stats/current.json",
+	},
+};
+```
+
 ## Usage
 
-### Print the results at the command line
+### Print the stats at the command line
 
 ```json
 "scripts": {
@@ -86,7 +160,7 @@ The special keyword `<hash>` can be used to match a hash in the filename. It can
 }
 ```
 
-### Print the results in a file
+### Print the stats in a file
 
 ```json
 "scripts": {
@@ -94,7 +168,7 @@ The special keyword `<hash>` can be used to match a hash in the filename. It can
 }
 ```
 
-### Print the results in a file but do not fail if the limit is reached
+### Print the stats in a file but do not fail if the limit is reached
 
 ```json
 "scripts": {
@@ -102,7 +176,7 @@ The special keyword `<hash>` can be used to match a hash in the filename. It can
 }
 ```
 
-### Add a prefix to the results
+### Add a prefix to the stats
 
 ```json
 "scripts": {
@@ -118,6 +192,14 @@ The special keyword `<hash>` can be used to match a hash in the filename. It can
 }
 ```
 
+### Compare current stats with the previous ones
+
+```json
+"scripts": {
+	"stats": "bundlesize -c bundlesize.config.js --type report"
+}
+```
+
 ## Get help
 
 ```sh

package/dist/bundlesize.js

@@ -1,39 +1,72 @@
 #!/usr/bin/env node
-/* istanbul ignore file */ import { STDOUT, reportStats } from "./utilities.js";
-import { Logger } from "@node-cli/logger";
+/* istanbul ignore file */ import { Logger } from "@node-cli/logger";
+import { STDOUT } from "./utilities.js";
 import { config } from "./parse.js";
 import fs from "fs-extra";
+import { getRawStats } from "./getRawStats.js";
+import { reportStats } from "./reportStats.js";
 const flags = config.flags;
 const log = new Logger({
     boring: flags.boring
 });
-try {
-    const result = await reportStats({
-        flags
-    });
-    if (result.exitMessage !== "") {
-        log.error(result.exitMessage);
+if (flags.type === "size") {
+    try {
+        const result = await getRawStats({
+            flags
+        });
+        if (result.exitMessage !== "") {
+            log.error(result.exitMessage);
+            process.exit(result.exitCode);
+        }
+        if (result.outputFile === STDOUT) {
+            log.info(`Configuration: ${flags.configuration}`);
+            log.info(`Output: ${result.outputFile}`);
+            log.info(`Output prefix: ${result.prefix}`);
+            log.log(result.data);
+        } else {
+            try {
+                fs.outputJsonSync(result.outputFile, result.data, {
+                    spaces: 2
+                });
+            } catch (error) {
+                log.error(`Failed to write to file: ${error.message}`);
+                process.exit(1);
+            }
+        }
         process.exit(result.exitCode);
+    } catch (error) {
+        log.error(error);
+        process.exit(1);
     }
-    if (result.outputFile === STDOUT) {
-        log.info(`Configuration: ${flags.configuration}`);
-        log.info(`Output: ${result.outputFile}`);
-        log.info(`Output prefix: ${result.prefix}`);
-        log.log(result.data);
-    } else {
-        try {
-            fs.outputJsonSync(result.outputFile, result.data, {
-                spaces: 2
-            });
-        } catch (error) {
-            log.error(`Failed to write to file: ${error.message}`);
-            process.exit(1);
+}
+if (flags.type === "report") {
+    try {
+        const result = await reportStats({
+            flags
+        });
+        if (result.exitMessage !== "") {
+            log.error(result.exitMessage);
+            process.exit(result.exitCode);
         }
+        if (result.outputFile === STDOUT) {
+            log.info(`Configuration: ${flags.configuration}`);
+            log.info(`Output: ${result.outputFile}`);
+            log.log(result.data);
+        } else {
+            try {
+                fs.outputFileSync(result.outputFile, result.data);
+            } catch (error) {
+                log.error(`Failed to write to file: ${error.message}`);
+                process.exit(1);
+            }
+        }
+        process.exit(result.exitCode);
+    } catch (error) {
+        log.error(error);
+        process.exit(1);
     }
-    process.exit(result.exitCode);
-} catch (error) {
-    log.error(error);
-    process.exit(1);
 }
+log.error("Invalid type, please use 'size' or 'report'");
+process.exit(1);
 
 //# sourceMappingURL=bundlesize.js.map

package/dist/bundlesize.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/bundlesize.ts"],"sourcesContent":["#!/usr/bin/env node\n/* istanbul ignore file */\n\nimport { STDOUT, reportStats } from \"./utilities.js\";\n\nimport { Logger } from \"@node-cli/logger\";\nimport { config } from \"./parse.js\";\nimport fs from \"fs-extra\";\n\nconst flags = config.flags;\n\nconst log = new Logger({\n\tboring: flags.boring,\n});\n\ntry {\n\tconst result = await reportStats({ flags });\n\n\tif (result.exitMessage !== \"\") {\n\t\tlog.error(result.exitMessage);\n\t\tprocess.exit(result.exitCode);\n\t}\n\n\tif (result.outputFile === STDOUT) {\n\t\tlog.info(`Configuration: ${flags.configuration}`);\n\t\tlog.info(`Output: ${result.outputFile}`);\n\t\tlog.info(`Output prefix: ${result.prefix}`);\n\t\tlog.log(result.data);\n\t} else {\n\t\ttry {\n\t\t\tfs.outputJsonSync(result.outputFile, result.data, { spaces: 2 });\n\t\t} catch (error) {\n\t\t\tlog.error(`Failed to write to file: ${error.message}`);\n\t\t\tprocess.exit(1);\n\t\t}\n\t}\n\tprocess.exit(result.exitCode);\n} catch (error) {\n\tlog.error(error);\n\tprocess.exit(1);\n}\n"],"names":["STDOUT","reportStats","Logger","config","fs","flags","log","boring","result","exitMessage","error","process","exit","exitCode","outputFile","info","configuration","prefix","data","outputJsonSync","spaces","message"],"mappings":";AACA,wBAAwB,GAExB,SAASA,MAAM,EAAEC,WAAW,QAAQ,iBAAiB;AAErD,SAASC,MAAM,QAAQ,mBAAmB;AAC1C,SAASC,MAAM,QAAQ,aAAa;AACpC,OAAOC,QAAQ,WAAW;AAE1B,MAAMC,QAAQF,OAAOE,KAAK;AAE1B,MAAMC,MAAM,IAAIJ,OAAO;IACtBK,QAAQF,MAAME,MAAM;AACrB;AAEA,IAAI;IACH,MAAMC,SAAS,MAAMP,YAAY;QAAEI;IAAM;IAEzC,IAAIG,OAAOC,WAAW,KAAK,IAAI;QAC9BH,IAAII,KAAK,CAACF,OAAOC,WAAW;QAC5BE,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;IAC7B;IAEA,IAAIL,OAAOM,UAAU,KAAKd,QAAQ;QACjCM,IAAIS,IAAI,CAAC,CAAC,eAAe,EAAEV,MAAMW,aAAa,CAAC,CAAC;QAChDV,IAAIS,IAAI,CAAC,CAAC,QAAQ,EAAEP,OAAOM,UAAU,CAAC,CAAC;QACvCR,IAAIS,IAAI,CAAC,CAAC,eAAe,EAAEP,OAAOS,MAAM,CAAC,CAAC;QAC1CX,IAAIA,GAAG,CAACE,OAAOU,IAAI;IACpB,OAAO;QACN,IAAI;YACHd,GAAGe,cAAc,CAACX,OAAOM,UAAU,EAAEN,OAAOU,IAAI,EAAE;gBAAEE,QAAQ;YAAE;QAC/D,EAAE,OAAOV,OAAO;YACfJ,IAAII,KAAK,CAAC,CAAC,yBAAyB,EAAEA,MAAMW,OAAO,CAAC,CAAC;YACrDV,QAAQC,IAAI,CAAC;QACd;IACD;IACAD,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;AAC7B,EAAE,OAAOH,OAAO;IACfJ,IAAII,KAAK,CAACA;IACVC,QAAQC,IAAI,CAAC;AACd"}
+{"version":3,"sources":["../src/bundlesize.ts"],"sourcesContent":["#!/usr/bin/env node\n/* istanbul ignore file */\n\nimport { Logger } from \"@node-cli/logger\";\nimport { STDOUT } from \"./utilities.js\";\nimport { config } from \"./parse.js\";\nimport fs from \"fs-extra\";\nimport { getRawStats } from \"./getRawStats.js\";\nimport { reportStats } from \"./reportStats.js\";\n\nconst flags = config.flags;\n\nconst log = new Logger({\n\tboring: flags.boring,\n});\n\nif (flags.type === \"size\") {\n\ttry {\n\t\tconst result = await getRawStats({ flags });\n\n\t\tif (result.exitMessage !== \"\") {\n\t\t\tlog.error(result.exitMessage);\n\t\t\tprocess.exit(result.exitCode);\n\t\t}\n\n\t\tif (result.outputFile === STDOUT) {\n\t\t\tlog.info(`Configuration: ${flags.configuration}`);\n\t\t\tlog.info(`Output: ${result.outputFile}`);\n\t\t\tlog.info(`Output prefix: ${result.prefix}`);\n\t\t\tlog.log(result.data);\n\t\t} else {\n\t\t\ttry {\n\t\t\t\tfs.outputJsonSync(result.outputFile, result.data, { spaces: 2 });\n\t\t\t} catch (error) {\n\t\t\t\tlog.error(`Failed to write to file: ${error.message}`);\n\t\t\t\tprocess.exit(1);\n\t\t\t}\n\t\t}\n\t\tprocess.exit(result.exitCode);\n\t} catch (error) {\n\t\tlog.error(error);\n\t\tprocess.exit(1);\n\t}\n}\n\nif (flags.type === \"report\") {\n\ttry {\n\t\tconst result = await reportStats({ flags });\n\n\t\tif (result.exitMessage !== \"\") {\n\t\t\tlog.error(result.exitMessage);\n\t\t\tprocess.exit(result.exitCode);\n\t\t}\n\n\t\tif (result.outputFile === STDOUT) {\n\t\t\tlog.info(`Configuration: ${flags.configuration}`);\n\t\t\tlog.info(`Output: ${result.outputFile}`);\n\t\t\tlog.log(result.data);\n\t\t} else {\n\t\t\ttry {\n\t\t\t\tfs.outputFileSync(result.outputFile, result.data);\n\t\t\t} catch (error) {\n\t\t\t\tlog.error(`Failed to write to file: ${error.message}`);\n\t\t\t\tprocess.exit(1);\n\t\t\t}\n\t\t}\n\t\tprocess.exit(result.exitCode);\n\t} catch (error) {\n\t\tlog.error(error);\n\t\tprocess.exit(1);\n\t}\n}\n\nlog.error(\"Invalid type, please use 'size' or 'report'\");\nprocess.exit(1);\n"],"names":["Logger","STDOUT","config","fs","getRawStats","reportStats","flags","log","boring","type","result","exitMessage","error","process","exit","exitCode","outputFile","info","configuration","prefix","data","outputJsonSync","spaces","message","outputFileSync"],"mappings":";AACA,wBAAwB,GAExB,SAASA,MAAM,QAAQ,mBAAmB;AAC1C,SAASC,MAAM,QAAQ,iBAAiB;AACxC,SAASC,MAAM,QAAQ,aAAa;AACpC,OAAOC,QAAQ,WAAW;AAC1B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,MAAMC,QAAQJ,OAAOI,KAAK;AAE1B,MAAMC,MAAM,IAAIP,OAAO;IACtBQ,QAAQF,MAAME,MAAM;AACrB;AAEA,IAAIF,MAAMG,IAAI,KAAK,QAAQ;IAC1B,IAAI;QACH,MAAMC,SAAS,MAAMN,YAAY;YAAEE;QAAM;QAEzC,IAAII,OAAOC,WAAW,KAAK,IAAI;YAC9BJ,IAAIK,KAAK,CAACF,OAAOC,WAAW;YAC5BE,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;QAC7B;QAEA,IAAIL,OAAOM,UAAU,KAAKf,QAAQ;YACjCM,IAAIU,IAAI,CAAC,CAAC,eAAe,EAAEX,MAAMY,aAAa,CAAC,CAAC;YAChDX,IAAIU,IAAI,CAAC,CAAC,QAAQ,EAAEP,OAAOM,UAAU,CAAC,CAAC;YACvCT,IAAIU,IAAI,CAAC,CAAC,eAAe,EAAEP,OAAOS,MAAM,CAAC,CAAC;YAC1CZ,IAAIA,GAAG,CAACG,OAAOU,IAAI;QACpB,OAAO;YACN,IAAI;gBACHjB,GAAGkB,cAAc,CAACX,OAAOM,UAAU,EAAEN,OAAOU,IAAI,EAAE;oBAAEE,QAAQ;gBAAE;YAC/D,EAAE,OAAOV,OAAO;gBACfL,IAAIK,KAAK,CAAC,CAAC,yBAAyB,EAAEA,MAAMW,OAAO,CAAC,CAAC;gBACrDV,QAAQC,IAAI,CAAC;YACd;QACD;QACAD,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;IAC7B,EAAE,OAAOH,OAAO;QACfL,IAAIK,KAAK,CAACA;QACVC,QAAQC,IAAI,CAAC;IACd;AACD;AAEA,IAAIR,MAAMG,IAAI,KAAK,UAAU;IAC5B,IAAI;QACH,MAAMC,SAAS,MAAML,YAAY;YAAEC;QAAM;QAEzC,IAAII,OAAOC,WAAW,KAAK,IAAI;YAC9BJ,IAAIK,KAAK,CAACF,OAAOC,WAAW;YAC5BE,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;QAC7B;QAEA,IAAIL,OAAOM,UAAU,KAAKf,QAAQ;YACjCM,IAAIU,IAAI,CAAC,CAAC,eAAe,EAAEX,MAAMY,aAAa,CAAC,CAAC;YAChDX,IAAIU,IAAI,CAAC,CAAC,QAAQ,EAAEP,OAAOM,UAAU,CAAC,CAAC;YACvCT,IAAIA,GAAG,CAACG,OAAOU,IAAI;QACpB,OAAO;YACN,IAAI;gBACHjB,GAAGqB,cAAc,CAACd,OAAOM,UAAU,EAAEN,OAAOU,IAAI;YACjD,EAAE,OAAOR,OAAO;gBACfL,IAAIK,KAAK,CAAC,CAAC,yBAAyB,EAAEA,MAAMW,OAAO,CAAC,CAAC;gBACrDV,QAAQC,IAAI,CAAC;YACd;QACD;QACAD,QAAQC,IAAI,CAACJ,OAAOK,QAAQ;IAC7B,EAAE,OAAOH,OAAO;QACfL,IAAIK,KAAK,CAACA;QACVC,QAAQC,IAAI,CAAC;IACd;AACD;AAEAP,IAAIK,KAAK,CAAC;AACVC,QAAQC,IAAI,CAAC"}

package/dist/defaults.d.ts

@@ -2,4 +2,5 @@ export declare const defaultFlags: {
     boring: boolean;
     configuration: string;
     silent: boolean;
+    type: string;
 };

package/dist/defaults.js

@@ -1,7 +1,8 @@
 /* istanbul ignore file */ export const defaultFlags = {
     boring: false,
     configuration: "",
-    silent: false
+    silent: false,
+    type: "size"
 };
 
 //# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["/* istanbul ignore file */\n\nexport const defaultFlags = {\n\tboring: false,\n\tconfiguration: \"\",\n\tsilent: false,\n};\n"],"names":["defaultFlags","boring","configuration","silent"],"mappings":"AAAA,wBAAwB,GAExB,OAAO,MAAMA,eAAe;IAC3BC,QAAQ;IACRC,eAAe;IACfC,QAAQ;AACT,EAAE"}
+{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["/* istanbul ignore file */\n\nexport const defaultFlags = {\n\tboring: false,\n\tconfiguration: \"\",\n\tsilent: false,\n\ttype: \"size\",\n};\n"],"names":["defaultFlags","boring","configuration","silent","type"],"mappings":"AAAA,wBAAwB,GAExB,OAAO,MAAMA,eAAe;IAC3BC,QAAQ;IACRC,eAAe;IACfC,QAAQ;IACRC,MAAM;AACP,EAAE"}

package/dist/getRawStats.d.ts

@@ -0,0 +1,12 @@
+type ReportStats = {
+    data: Record<string, unknown>;
+    exitCode: number;
+    exitMessage: string;
+    outputFile: string;
+    pass: boolean;
+    prefix: string;
+};
+export declare const getRawStats: ({ flags }: {
+    flags: any;
+}) => Promise<ReportStats>;
+export {};

package/dist/getRawStats.js

@@ -0,0 +1,96 @@
+import { STDOUT, getOutputFile, gzipSizeFromFileSync, validateConfigurationFile } from "./utilities.js";
+import { basename, dirname, join } from "node:path";
+import bytes from "bytes";
+import fs from "fs-extra";
+import { glob } from "glob";
+import { statSync } from "node:fs";
+export const getRawStats = async ({ flags })=>{
+    const result = {
+        pass: true,
+        exitCode: 0,
+        exitMessage: "",
+        outputFile: "",
+        prefix: "",
+        data: {}
+    };
+    let failed = false;
+    const isValidConfigResult = validateConfigurationFile(flags.configuration);
+    if (isValidConfigResult.exitMessage !== "") {
+        return {
+            ...result,
+            ...isValidConfigResult
+        };
+    }
+    const configurationFile = isValidConfigResult.data;
+    const outputFile = getOutputFile(flags.output);
+    const prefix = flags.prefix || "0.0.0";
+    const currentResults = {};
+    const configuration = await import(configurationFile).then((m)=>m.default);
+    if (configuration.sizes === undefined) {
+        result.exitMessage = "Invalid configuration file: missing sizes object!";
+        result.exitCode = 1;
+        return result;
+    }
+    for (const artifact of configuration.sizes){
+        const rootPath = artifact.path.startsWith("/") ? "" : dirname(configurationFile);
+        const artifactPath = dirname(artifact.path);
+        const globReplace = "+([a-zA-Z0-9_-])";
+        const hasHash = artifact.path.includes("<hash>");
+        /**
+		 * if the artifact.path has the string <hash> in it,
+		 * then we need to check for other characters:
+		 * - Double stars ** are allowed.
+		 * - Single stars * are not allowed.
+		 */ if (hasHash && /(?<!\*)\*(?!\*)/.test(artifact.path)) {
+            result.exitCode = 1;
+            result.exitMessage = `Invalid path: ${artifact.path}.\nSingle stars (*) are not allowed when using the special keyword <hash>`;
+            return result;
+        }
+        const fileGlob = join(rootPath, artifact.path.replace("<hash>", globReplace));
+        const files = glob.sync(fileGlob);
+        if (files.length === 0) {
+            result.exitCode = 1;
+            result.exitMessage = `File not found: ${fileGlob}`;
+            return result;
+        }
+        if (files.length > 1 && hasHash) {
+            result.exitCode = 1;
+            result.exitMessage = `Multiple files found for: ${artifact.path}.\nPlease use a more specific path when using the special keyword <hash>.`;
+            return result;
+        }
+        for (const file of files){
+            const fileSize = statSync(file).size;
+            const fileSizeGzip = gzipSizeFromFileSync(file);
+            const passed = fileSizeGzip < bytes(artifact.limit);
+            if (passed === false) {
+                result.pass = false;
+                failed = true;
+            }
+            let index = hasHash ? artifact.path : join(artifactPath, basename(file));
+            currentResults[index] = {
+                fileSize,
+                fileSizeGzip,
+                limit: artifact.limit,
+                passed
+            };
+        }
+    }
+    let existingResults = {};
+    if (outputFile !== STDOUT) {
+        try {
+            existingResults = fs.readJsonSync(outputFile);
+        } catch  {
+        /**
+			 * There are no existing results, so we can ignore this error,
+			 * and simply write the current results to the output file.
+			 */ }
+    }
+    existingResults[prefix] = currentResults;
+    result.prefix = prefix;
+    result.outputFile = outputFile;
+    result.exitCode = failed && flags.silent === false ? 1 : 0;
+    result.data = existingResults;
+    return result;
+};
+
+//# sourceMappingURL=getRawStats.js.map

package/dist/getRawStats.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/getRawStats.ts"],"sourcesContent":["import {\n\tSTDOUT,\n\tgetOutputFile,\n\tgzipSizeFromFileSync,\n\tvalidateConfigurationFile,\n} from \"./utilities.js\";\nimport { basename, dirname, join } from \"node:path\";\n\nimport bytes from \"bytes\";\nimport fs from \"fs-extra\";\nimport { glob } from \"glob\";\nimport { statSync } from \"node:fs\";\n\ntype SizesConfiguration = {\n\tlimit: string;\n\tpath: string;\n};\n\ntype ReportStats = {\n\tdata: Record<string, unknown>;\n\texitCode: number;\n\texitMessage: string;\n\toutputFile: string;\n\tpass: boolean;\n\tprefix: string;\n};\n\nexport const getRawStats = async ({ flags }): Promise<ReportStats> => {\n\tconst result: ReportStats = {\n\t\tpass: true,\n\t\texitCode: 0,\n\t\texitMessage: \"\",\n\t\toutputFile: \"\",\n\t\tprefix: \"\",\n\t\tdata: {},\n\t};\n\tlet failed = false;\n\tconst isValidConfigResult = validateConfigurationFile(flags.configuration);\n\tif (isValidConfigResult.exitMessage !== \"\") {\n\t\treturn {\n\t\t\t...result,\n\t\t\t...isValidConfigResult,\n\t\t};\n\t}\n\tconst configurationFile = isValidConfigResult.data;\n\tconst outputFile = getOutputFile(flags.output);\n\tconst prefix = flags.prefix || \"0.0.0\";\n\tconst currentResults = {};\n\n\tconst configuration: { sizes: SizesConfiguration[] } = await import(\n\t\tconfigurationFile\n\t).then((m) => m.default);\n\n\tif (configuration.sizes === undefined) {\n\t\tresult.exitMessage = \"Invalid configuration file: missing sizes object!\";\n\t\tresult.exitCode = 1;\n\t\treturn result;\n\t}\n\n\tfor (const artifact of configuration.sizes) {\n\t\tconst rootPath = artifact.path.startsWith(\"/\")\n\t\t\t? \"\"\n\t\t\t: dirname(configurationFile);\n\t\tconst artifactPath = dirname(artifact.path);\n\t\tconst globReplace = \"+([a-zA-Z0-9_-])\";\n\t\tconst hasHash = artifact.path.includes(\"<hash>\");\n\n\t\t/**\n\t\t * if the artifact.path has the string <hash> in it,\n\t\t * then we need to check for other characters:\n\t\t * - Double stars ** are allowed.\n\t\t * - Single stars * are not allowed.\n\t\t */\n\t\tif (hasHash && /(?<!\\*)\\*(?!\\*)/.test(artifact.path)) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `Invalid path: ${artifact.path}.\\nSingle stars (*) are not allowed when using the special keyword <hash>`;\n\t\t\treturn result;\n\t\t}\n\n\t\tconst fileGlob = join(\n\t\t\trootPath,\n\t\t\tartifact.path.replace(\"<hash>\", globReplace),\n\t\t);\n\t\tconst files = glob.sync(fileGlob);\n\n\t\tif (files.length === 0) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `File not found: ${fileGlob}`;\n\t\t\treturn result;\n\t\t}\n\n\t\tif (files.length > 1 && hasHash) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `Multiple files found for: ${artifact.path}.\\nPlease use a more specific path when using the special keyword <hash>.`;\n\t\t\treturn result;\n\t\t}\n\n\t\tfor (const file of files) {\n\t\t\tconst fileSize = statSync(file).size;\n\t\t\tconst fileSizeGzip = gzipSizeFromFileSync(file);\n\t\t\tconst passed = fileSizeGzip < bytes(artifact.limit);\n\n\t\t\tif (passed === false) {\n\t\t\t\tresult.pass = false;\n\t\t\t\tfailed = true;\n\t\t\t}\n\t\t\tlet index = hasHash ? artifact.path : join(artifactPath, basename(file));\n\n\t\t\tcurrentResults[index] = {\n\t\t\t\tfileSize,\n\t\t\t\tfileSizeGzip,\n\t\t\t\tlimit: artifact.limit,\n\t\t\t\tpassed,\n\t\t\t};\n\t\t}\n\t}\n\n\tlet existingResults = {};\n\tif (outputFile !== STDOUT) {\n\t\ttry {\n\t\t\texistingResults = fs.readJsonSync(outputFile);\n\t\t} catch {\n\t\t\t/**\n\t\t\t * There are no existing results, so we can ignore this error,\n\t\t\t * and simply write the current results to the output file.\n\t\t\t */\n\t\t}\n\t}\n\texistingResults[prefix] = currentResults;\n\n\tresult.prefix = prefix;\n\tresult.outputFile = outputFile;\n\tresult.exitCode = failed && flags.silent === false ? 1 : 0;\n\tresult.data = existingResults;\n\treturn result;\n};\n"],"names":["STDOUT","getOutputFile","gzipSizeFromFileSync","validateConfigurationFile","basename","dirname","join","bytes","fs","glob","statSync","getRawStats","flags","result","pass","exitCode","exitMessage","outputFile","prefix","data","failed","isValidConfigResult","configuration","configurationFile","output","currentResults","then","m","default","sizes","undefined","artifact","rootPath","path","startsWith","artifactPath","globReplace","hasHash","includes","test","fileGlob","replace","files","sync","length","file","fileSize","size","fileSizeGzip","passed","limit","index","existingResults","readJsonSync","silent"],"mappings":"AAAA,SACCA,MAAM,EACNC,aAAa,EACbC,oBAAoB,EACpBC,yBAAyB,QACnB,iBAAiB;AACxB,SAASC,QAAQ,EAAEC,OAAO,EAAEC,IAAI,QAAQ,YAAY;AAEpD,OAAOC,WAAW,QAAQ;AAC1B,OAAOC,QAAQ,WAAW;AAC1B,SAASC,IAAI,QAAQ,OAAO;AAC5B,SAASC,QAAQ,QAAQ,UAAU;AAgBnC,OAAO,MAAMC,cAAc,OAAO,EAAEC,KAAK,EAAE;IAC1C,MAAMC,SAAsB;QAC3BC,MAAM;QACNC,UAAU;QACVC,aAAa;QACbC,YAAY;QACZC,QAAQ;QACRC,MAAM,CAAC;IACR;IACA,IAAIC,SAAS;IACb,MAAMC,sBAAsBlB,0BAA0BS,MAAMU,aAAa;IACzE,IAAID,oBAAoBL,WAAW,KAAK,IAAI;QAC3C,OAAO;YACN,GAAGH,MAAM;YACT,GAAGQ,mBAAmB;QACvB;IACD;IACA,MAAME,oBAAoBF,oBAAoBF,IAAI;IAClD,MAAMF,aAAahB,cAAcW,MAAMY,MAAM;IAC7C,MAAMN,SAASN,MAAMM,MAAM,IAAI;IAC/B,MAAMO,iBAAiB,CAAC;IAExB,MAAMH,gBAAiD,MAAM,MAAM,CAClEC,mBACCG,IAAI,CAAC,CAACC,IAAMA,EAAEC,OAAO;IAEvB,IAAIN,cAAcO,KAAK,KAAKC,WAAW;QACtCjB,OAAOG,WAAW,GAAG;QACrBH,OAAOE,QAAQ,GAAG;QAClB,OAAOF;IACR;IAEA,KAAK,MAAMkB,YAAYT,cAAcO,KAAK,CAAE;QAC3C,MAAMG,WAAWD,SAASE,IAAI,CAACC,UAAU,CAAC,OACvC,KACA7B,QAAQkB;QACX,MAAMY,eAAe9B,QAAQ0B,SAASE,IAAI;QAC1C,MAAMG,cAAc;QACpB,MAAMC,UAAUN,SAASE,IAAI,CAACK,QAAQ,CAAC;QAEvC;;;;;GAKC,GACD,IAAID,WAAW,kBAAkBE,IAAI,CAACR,SAASE,IAAI,GAAG;YACrDpB,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,cAAc,EAAEe,SAASE,IAAI,CAAC,yEAAyE,CAAC;YAC9H,OAAOpB;QACR;QAEA,MAAM2B,WAAWlC,KAChB0B,UACAD,SAASE,IAAI,CAACQ,OAAO,CAAC,UAAUL;QAEjC,MAAMM,QAAQjC,KAAKkC,IAAI,CAACH;QAExB,IAAIE,MAAME,MAAM,KAAK,GAAG;YACvB/B,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,gBAAgB,EAAEwB,SAAS,CAAC;YAClD,OAAO3B;QACR;QAEA,IAAI6B,MAAME,MAAM,GAAG,KAAKP,SAAS;YAChCxB,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,0BAA0B,EAAEe,SAASE,IAAI,CAAC,yEAAyE,CAAC;YAC1I,OAAOpB;QACR;QAEA,KAAK,MAAMgC,QAAQH,MAAO;YACzB,MAAMI,WAAWpC,SAASmC,MAAME,IAAI;YACpC,MAAMC,eAAe9C,qBAAqB2C;YAC1C,MAAMI,SAASD,eAAezC,MAAMwB,SAASmB,KAAK;YAElD,IAAID,WAAW,OAAO;gBACrBpC,OAAOC,IAAI,GAAG;gBACdM,SAAS;YACV;YACA,IAAI+B,QAAQd,UAAUN,SAASE,IAAI,GAAG3B,KAAK6B,cAAc/B,SAASyC;YAElEpB,cAAc,CAAC0B,MAAM,GAAG;gBACvBL;gBACAE;gBACAE,OAAOnB,SAASmB,KAAK;gBACrBD;YACD;QACD;IACD;IAEA,IAAIG,kBAAkB,CAAC;IACvB,IAAInC,eAAejB,QAAQ;QAC1B,IAAI;YACHoD,kBAAkB5C,GAAG6C,YAAY,CAACpC;QACnC,EAAE,OAAM;QACP;;;IAGC,GACF;IACD;IACAmC,eAAe,CAAClC,OAAO,GAAGO;IAE1BZ,OAAOK,MAAM,GAAGA;IAChBL,OAAOI,UAAU,GAAGA;IACpBJ,OAAOE,QAAQ,GAAGK,UAAUR,MAAM0C,MAAM,KAAK,QAAQ,IAAI;IACzDzC,OAAOM,IAAI,GAAGiC;IACd,OAAOvC;AACR,EAAE"}

package/dist/index.d.ts

@@ -4,5 +4,7 @@
 
 export * from "./bundlesize";
 export * from "./defaults";
+export * from "./getRawStats";
 export * from "./parse";
+export * from "./reportStats";
 export * from "./utilities";

package/dist/parse.d.ts

@@ -6,6 +6,7 @@ export type Flags = {
     output?: string;
     prefix?: string;
     silent?: boolean;
+    type?: "size" | "report";
 };
 export type Configuration = {
     flags?: Flags;

package/dist/parse.js

@@ -4,6 +4,12 @@ import { parser } from "@node-cli/parser";
     meta: import.meta,
     examples: [],
     flags: {
+        type: {
+            shortFlag: "t",
+            description: "Specify the type of output: size or report",
+            type: "string",
+            default: defaultFlags.type
+        },
         configuration: {
             shortFlag: "c",
             description: "Specify a configuration file",

package/dist/parse.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/parse.ts"],"sourcesContent":["import { defaultFlags } from \"./defaults.js\";\nimport { parser } from \"@node-cli/parser\";\n\nexport type Flags = {\n\tboring?: boolean;\n\thelp?: boolean;\n\tversion?: boolean;\n\tconfiguration?: string;\n\toutput?: string;\n\tprefix?: string;\n\tsilent?: boolean;\n};\n\nexport type Configuration = {\n\tflags?: Flags;\n\tusage?: boolean;\n\tshowHelp?: () => void;\n};\n\n/* istanbul ignore next */\nexport const config: Configuration = parser({\n\tmeta: import.meta,\n\texamples: [],\n\tflags: {\n\t\tconfiguration: {\n\t\t\tshortFlag: \"c\",\n\t\t\tdescription: \"Specify a configuration file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\toutput: {\n\t\t\tshortFlag: \"o\",\n\t\t\tdescription: \"Specify the output file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\tprefix: {\n\t\t\tshortFlag: \"p\",\n\t\t\tdescription: \"Specify a prefix to use in the output file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\tsilent: {\n\t\t\tshortFlag: \"s\",\n\t\t\tdefault: defaultFlags.silent,\n\t\t\tdescription: \"Do not exit in error when a limit is exceeded\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tboring: {\n\t\t\tshortFlag: \"b\",\n\t\t\tdefault: defaultFlags.boring,\n\t\t\tdescription: \"Do not use color output\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\thelp: {\n\t\t\tshortFlag: \"h\",\n\t\t\tdescription: \"Display help instructions\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tversion: {\n\t\t\tshortFlag: \"v\",\n\t\t\tdescription: \"Output the current version\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t},\n\tusage: true,\n\tdefaultFlags,\n});\n"],"names":["defaultFlags","parser","config","meta","examples","flags","configuration","shortFlag","description","type","output","prefix","silent","default","boring","help","version","usage"],"mappings":"AAAA,SAASA,YAAY,QAAQ,gBAAgB;AAC7C,SAASC,MAAM,QAAQ,mBAAmB;AAkB1C,wBAAwB,GACxB,OAAO,MAAMC,SAAwBD,OAAO;IAC3CE,MAAM;IACNC,UAAU,EAAE;IACZC,OAAO;QACNC,eAAe;YACdC,WAAW;YACXC,aAAa;YACbC,MAAM;QACP;QACAC,QAAQ;YACPH,WAAW;YACXC,aAAa;YACbC,MAAM;QACP;QACAE,QAAQ;YACPJ,WAAW;YACXC,aAAa;YACbC,MAAM;QACP;QACAG,QAAQ;YACPL,WAAW;YACXM,SAASb,aAAaY,MAAM;YAC5BJ,aAAa;YACbC,MAAM;QACP;QACAK,QAAQ;YACPP,WAAW;YACXM,SAASb,aAAac,MAAM;YAC5BN,aAAa;YACbC,MAAM;QACP;QACAM,MAAM;YACLR,WAAW;YACXC,aAAa;YACbC,MAAM;QACP;QACAO,SAAS;YACRT,WAAW;YACXC,aAAa;YACbC,MAAM;QACP;IACD;IACAQ,OAAO;IACPjB;AACD,GAAG"}
+{"version":3,"sources":["../src/parse.ts"],"sourcesContent":["import { defaultFlags } from \"./defaults.js\";\nimport { parser } from \"@node-cli/parser\";\n\nexport type Flags = {\n\tboring?: boolean;\n\thelp?: boolean;\n\tversion?: boolean;\n\tconfiguration?: string;\n\toutput?: string;\n\tprefix?: string;\n\tsilent?: boolean;\n\ttype?: \"size\" | \"report\";\n};\n\nexport type Configuration = {\n\tflags?: Flags;\n\tusage?: boolean;\n\tshowHelp?: () => void;\n};\n\n/* istanbul ignore next */\nexport const config: Configuration = parser({\n\tmeta: import.meta,\n\texamples: [],\n\tflags: {\n\t\ttype: {\n\t\t\tshortFlag: \"t\",\n\t\t\tdescription: \"Specify the type of output: size or report\",\n\t\t\ttype: \"string\",\n\t\t\tdefault: defaultFlags.type,\n\t\t},\n\t\tconfiguration: {\n\t\t\tshortFlag: \"c\",\n\t\t\tdescription: \"Specify a configuration file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\toutput: {\n\t\t\tshortFlag: \"o\",\n\t\t\tdescription: \"Specify the output file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\tprefix: {\n\t\t\tshortFlag: \"p\",\n\t\t\tdescription: \"Specify a prefix to use in the output file\",\n\t\t\ttype: \"string\",\n\t\t},\n\t\tsilent: {\n\t\t\tshortFlag: \"s\",\n\t\t\tdefault: defaultFlags.silent,\n\t\t\tdescription: \"Do not exit in error when a limit is exceeded\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tboring: {\n\t\t\tshortFlag: \"b\",\n\t\t\tdefault: defaultFlags.boring,\n\t\t\tdescription: \"Do not use color output\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\thelp: {\n\t\t\tshortFlag: \"h\",\n\t\t\tdescription: \"Display help instructions\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t\tversion: {\n\t\t\tshortFlag: \"v\",\n\t\t\tdescription: \"Output the current version\",\n\t\t\ttype: \"boolean\",\n\t\t},\n\t},\n\tusage: true,\n\tdefaultFlags,\n});\n"],"names":["defaultFlags","parser","config","meta","examples","flags","type","shortFlag","description","default","configuration","output","prefix","silent","boring","help","version","usage"],"mappings":"AAAA,SAASA,YAAY,QAAQ,gBAAgB;AAC7C,SAASC,MAAM,QAAQ,mBAAmB;AAmB1C,wBAAwB,GACxB,OAAO,MAAMC,SAAwBD,OAAO;IAC3CE,MAAM;IACNC,UAAU,EAAE;IACZC,OAAO;QACNC,MAAM;YACLC,WAAW;YACXC,aAAa;YACbF,MAAM;YACNG,SAAST,aAAaM,IAAI;QAC3B;QACAI,eAAe;YACdH,WAAW;YACXC,aAAa;YACbF,MAAM;QACP;QACAK,QAAQ;YACPJ,WAAW;YACXC,aAAa;YACbF,MAAM;QACP;QACAM,QAAQ;YACPL,WAAW;YACXC,aAAa;YACbF,MAAM;QACP;QACAO,QAAQ;YACPN,WAAW;YACXE,SAAST,aAAaa,MAAM;YAC5BL,aAAa;YACbF,MAAM;QACP;QACAQ,QAAQ;YACPP,WAAW;YACXE,SAAST,aAAac,MAAM;YAC5BN,aAAa;YACbF,MAAM;QACP;QACAS,MAAM;YACLR,WAAW;YACXC,aAAa;YACbF,MAAM;QACP;QACAU,SAAS;YACRT,WAAW;YACXC,aAAa;YACbF,MAAM;QACP;IACD;IACAW,OAAO;IACPjB;AACD,GAAG"}

package/dist/reportStats.d.ts

@@ -0,0 +1,10 @@
+type ReportCompare = {
+    data: string;
+    exitCode: number;
+    exitMessage: string;
+    outputFile: string;
+};
+export declare const reportStats: ({ flags }: {
+    flags: any;
+}) => Promise<ReportCompare>;
+export {};

package/dist/reportStats.js

@@ -0,0 +1,108 @@
+import { addMDrow, formatFooter, getMostRecentVersion, getOutputFile, percentFormatter, readJSONFile, validateConfigurationFile } from "./utilities.js";
+import { basename, dirname, join } from "node:path";
+import bytes from "bytes";
+export const reportStats = async ({ flags })=>{
+    const result = {
+        exitCode: 0,
+        exitMessage: "",
+        outputFile: "",
+        data: ""
+    };
+    let previousStats, previousVersion;
+    const isValidConfigResult = validateConfigurationFile(flags.configuration);
+    if (isValidConfigResult.exitMessage !== "") {
+        return {
+            ...result,
+            ...isValidConfigResult
+        };
+    }
+    const configurationFile = isValidConfigResult.data;
+    const outputFile = getOutputFile(flags.output);
+    result.outputFile = outputFile;
+    const configuration = await import(configurationFile).then((m)=>m.default);
+    const currentStats = readJSONFile(join(dirname(configurationFile), configuration.report.current));
+    if (currentStats.exitMessage !== "") {
+        return {
+            ...result,
+            ...currentStats
+        };
+    }
+    try {
+        previousStats = readJSONFile(join(dirname(configurationFile), configuration.report.previous));
+        if (previousStats.exitMessage !== "") {
+            return {
+                ...result,
+                ...previousStats
+            };
+        }
+        previousVersion = getMostRecentVersion(previousStats.data);
+    } catch  {
+    // nothing to declare officer
+    }
+    const currentVersion = getMostRecentVersion(currentStats.data);
+    let limitReached = false;
+    let overallDiff = 0;
+    const headerString = configuration.report.header || "## Bundle Size";
+    const footerFormatter = configuration.report.footer || formatFooter;
+    const columns = configuration.report.columns || [
+        {
+            status: "Status"
+        },
+        {
+            file: "File"
+        },
+        {
+            size: "Size (Gzip)"
+        },
+        {
+            limits: "Limits"
+        }
+    ];
+    const rowsMD = [];
+    rowsMD.push(addMDrow({
+        type: "header",
+        columns
+    }));
+    for (const key of Object.keys(currentStats.data[currentVersion])){
+        const item = currentStats.data[currentVersion][key];
+        const name = basename(key);
+        if (!item.passed) {
+            limitReached = true;
+        }
+        let diffString = "";
+        if (previousStats && previousVersion) {
+            const previousFileStats = previousStats.data[previousVersion] && previousStats.data[previousVersion][key];
+            const previousFileSizeGzip = previousFileStats.fileSizeGzip;
+            const diff = item.fileSizeGzip - previousFileSizeGzip;
+            overallDiff += diff;
+            diffString = diff === 0 ? "" : ` (${diff > 0 ? "+" : "-"}${bytes(Math.abs(diff), {
+                unitSeparator: " "
+            })} ${percentFormatter.format(diff / previousFileSizeGzip)})`;
+        }
+        rowsMD.push(addMDrow({
+            type: "row",
+            passed: item.passed,
+            name: name,
+            size: item.fileSizeGzip,
+            diff: diffString,
+            limit: item.limit,
+            columns
+        }));
+    }
+    const overallDiffString = overallDiff === 0 ? "" : `(${overallDiff > 0 ? "+" : "-"}${bytes(Math.abs(overallDiff), {
+        unitSeparator: " "
+    })})`;
+    const template = `
+${headerString}
+${rowsMD.join("\n")}
+
+${footerFormatter(limitReached, overallDiffString).trim()}
+`;
+    if (limitReached) {
+        result.exitCode = 1;
+    }
+    result.data = template;
+    return result;
+};
+
+//# sourceMappingURL=reportStats.js.map

package/dist/reportStats.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/reportStats.ts"],"sourcesContent":["import {\n\taddMDrow,\n\tformatFooter,\n\tgetMostRecentVersion,\n\tgetOutputFile,\n\tpercentFormatter,\n\treadJSONFile,\n\tvalidateConfigurationFile,\n} from \"./utilities.js\";\nimport { basename, dirname, join } from \"node:path\";\n\nimport bytes from \"bytes\";\n\ntype ReportConfiguration = {\n\tcurrent: string;\n\tprevious: string;\n\n\theader?: string;\n\tfooter?: (limit: boolean, diff: string | number) => string;\n\tcolumns?: { [key: string]: string }[];\n};\n\ntype ReportCompare = {\n\tdata: string;\n\texitCode: number;\n\texitMessage: string;\n\toutputFile: string;\n};\n\nexport const reportStats = async ({ flags }): Promise<ReportCompare> => {\n\tconst result: ReportCompare = {\n\t\texitCode: 0,\n\t\texitMessage: \"\",\n\t\toutputFile: \"\",\n\t\tdata: \"\",\n\t};\n\tlet previousStats, previousVersion: string;\n\tconst isValidConfigResult = validateConfigurationFile(flags.configuration);\n\tif (isValidConfigResult.exitMessage !== \"\") {\n\t\treturn {\n\t\t\t...result,\n\t\t\t...isValidConfigResult,\n\t\t};\n\t}\n\tconst configurationFile = isValidConfigResult.data;\n\tconst outputFile = getOutputFile(flags.output);\n\tresult.outputFile = outputFile;\n\n\tconst configuration: { report: ReportConfiguration } = await import(\n\t\tconfigurationFile\n\t).then((m) => m.default);\n\n\tconst currentStats = readJSONFile(\n\t\tjoin(dirname(configurationFile), configuration.report.current),\n\t);\n\tif (currentStats.exitMessage !== \"\") {\n\t\treturn {\n\t\t\t...result,\n\t\t\t...currentStats,\n\t\t};\n\t}\n\n\ttry {\n\t\tpreviousStats = readJSONFile(\n\t\t\tjoin(dirname(configurationFile), configuration.report.previous),\n\t\t);\n\t\tif (previousStats.exitMessage !== \"\") {\n\t\t\treturn {\n\t\t\t\t...result,\n\t\t\t\t...previousStats,\n\t\t\t};\n\t\t}\n\t\tpreviousVersion = getMostRecentVersion(previousStats.data);\n\t} catch {\n\t\t// nothing to declare officer\n\t}\n\tconst currentVersion = getMostRecentVersion(currentStats.data);\n\n\tlet limitReached = false;\n\tlet overallDiff = 0;\n\tconst headerString = configuration.report.header || \"## Bundle Size\";\n\tconst footerFormatter = configuration.report.footer || formatFooter;\n\tconst columns = configuration.report.columns || [\n\t\t{ status: \"Status\" },\n\t\t{ file: \"File\" },\n\t\t{ size: \"Size (Gzip)\" },\n\t\t{ limits: \"Limits\" },\n\t];\n\n\tconst rowsMD = [];\n\trowsMD.push(addMDrow({ type: \"header\", columns }));\n\n\tfor (const key of Object.keys(currentStats.data[currentVersion])) {\n\t\tconst item = currentStats.data[currentVersion][key];\n\t\tconst name = basename(key);\n\t\tif (!item.passed) {\n\t\t\tlimitReached = true;\n\t\t}\n\n\t\tlet diffString = \"\";\n\t\tif (previousStats && previousVersion) {\n\t\t\tconst previousFileStats =\n\t\t\t\tpreviousStats.data[previousVersion] &&\n\t\t\t\tpreviousStats.data[previousVersion][key];\n\t\t\tconst previousFileSizeGzip = previousFileStats.fileSizeGzip;\n\t\t\tconst diff = item.fileSizeGzip - previousFileSizeGzip;\n\n\t\t\toverallDiff += diff;\n\t\t\tdiffString =\n\t\t\t\tdiff === 0\n\t\t\t\t\t? \"\"\n\t\t\t\t\t: ` (${diff > 0 ? \"+\" : \"-\"}${bytes(Math.abs(diff), {\n\t\t\t\t\t\t\tunitSeparator: \" \",\n\t\t\t\t\t\t})} ${percentFormatter.format(diff / previousFileSizeGzip)})`;\n\t\t}\n\n\t\trowsMD.push(\n\t\t\taddMDrow({\n\t\t\t\ttype: \"row\",\n\t\t\t\tpassed: item.passed,\n\t\t\t\tname: name,\n\t\t\t\tsize: item.fileSizeGzip,\n\t\t\t\tdiff: diffString,\n\t\t\t\tlimit: item.limit,\n\t\t\t\tcolumns,\n\t\t\t}),\n\t\t);\n\t}\n\n\tconst overallDiffString =\n\t\toverallDiff === 0\n\t\t\t? \"\"\n\t\t\t: `(${overallDiff > 0 ? \"+\" : \"-\"}${bytes(Math.abs(overallDiff), {\n\t\t\t\t\tunitSeparator: \" \",\n\t\t\t\t})})`;\n\n\tconst template = `\n${headerString}\n${rowsMD.join(\"\\n\")}\n\n${footerFormatter(limitReached, overallDiffString).trim()}\n`;\n\n\tif (limitReached) {\n\t\tresult.exitCode = 1;\n\t}\n\n\tresult.data = template;\n\n\treturn result;\n};\n"],"names":["addMDrow","formatFooter","getMostRecentVersion","getOutputFile","percentFormatter","readJSONFile","validateConfigurationFile","basename","dirname","join","bytes","reportStats","flags","result","exitCode","exitMessage","outputFile","data","previousStats","previousVersion","isValidConfigResult","configuration","configurationFile","output","then","m","default","currentStats","report","current","previous","currentVersion","limitReached","overallDiff","headerString","header","footerFormatter","footer","columns","status","file","size","limits","rowsMD","push","type","key","Object","keys","item","name","passed","diffString","previousFileStats","previousFileSizeGzip","fileSizeGzip","diff","Math","abs","unitSeparator","format","limit","overallDiffString","template","trim"],"mappings":"AAAA,SACCA,QAAQ,EACRC,YAAY,EACZC,oBAAoB,EACpBC,aAAa,EACbC,gBAAgB,EAChBC,YAAY,EACZC,yBAAyB,QACnB,iBAAiB;AACxB,SAASC,QAAQ,EAAEC,OAAO,EAAEC,IAAI,QAAQ,YAAY;AAEpD,OAAOC,WAAW,QAAQ;AAkB1B,OAAO,MAAMC,cAAc,OAAO,EAAEC,KAAK,EAAE;IAC1C,MAAMC,SAAwB;QAC7BC,UAAU;QACVC,aAAa;QACbC,YAAY;QACZC,MAAM;IACP;IACA,IAAIC,eAAeC;IACnB,MAAMC,sBAAsBd,0BAA0BM,MAAMS,aAAa;IACzE,IAAID,oBAAoBL,WAAW,KAAK,IAAI;QAC3C,OAAO;YACN,GAAGF,MAAM;YACT,GAAGO,mBAAmB;QACvB;IACD;IACA,MAAME,oBAAoBF,oBAAoBH,IAAI;IAClD,MAAMD,aAAab,cAAcS,MAAMW,MAAM;IAC7CV,OAAOG,UAAU,GAAGA;IAEpB,MAAMK,gBAAiD,MAAM,MAAM,CAClEC,mBACCE,IAAI,CAAC,CAACC,IAAMA,EAAEC,OAAO;IAEvB,MAAMC,eAAetB,aACpBI,KAAKD,QAAQc,oBAAoBD,cAAcO,MAAM,CAACC,OAAO;IAE9D,IAAIF,aAAaZ,WAAW,KAAK,IAAI;QACpC,OAAO;YACN,GAAGF,MAAM;YACT,GAAGc,YAAY;QAChB;IACD;IAEA,IAAI;QACHT,gBAAgBb,aACfI,KAAKD,QAAQc,oBAAoBD,cAAcO,MAAM,CAACE,QAAQ;QAE/D,IAAIZ,cAAcH,WAAW,KAAK,IAAI;YACrC,OAAO;gBACN,GAAGF,MAAM;gBACT,GAAGK,aAAa;YACjB;QACD;QACAC,kBAAkBjB,qBAAqBgB,cAAcD,IAAI;IAC1D,EAAE,OAAM;IACP,6BAA6B;IAC9B;IACA,MAAMc,iBAAiB7B,qBAAqByB,aAAaV,IAAI;IAE7D,IAAIe,eAAe;IACnB,IAAIC,cAAc;IAClB,MAAMC,eAAeb,cAAcO,MAAM,CAACO,MAAM,IAAI;IACpD,MAAMC,kBAAkBf,cAAcO,MAAM,CAACS,MAAM,IAAIpC;IACvD,MAAMqC,UAAUjB,cAAcO,MAAM,CAACU,OAAO,IAAI;QAC/C;YAAEC,QAAQ;QAAS;QACnB;YAAEC,MAAM;QAAO;QACf;YAAEC,MAAM;QAAc;QACtB;YAAEC,QAAQ;QAAS;KACnB;IAED,MAAMC,SAAS,EAAE;IACjBA,OAAOC,IAAI,CAAC5C,SAAS;QAAE6C,MAAM;QAAUP;IAAQ;IAE/C,KAAK,MAAMQ,OAAOC,OAAOC,IAAI,CAACrB,aAAaV,IAAI,CAACc,eAAe,EAAG;QACjE,MAAMkB,OAAOtB,aAAaV,IAAI,CAACc,eAAe,CAACe,IAAI;QACnD,MAAMI,OAAO3C,SAASuC;QACtB,IAAI,CAACG,KAAKE,MAAM,EAAE;YACjBnB,eAAe;QAChB;QAEA,IAAIoB,aAAa;QACjB,IAAIlC,iBAAiBC,iBAAiB;YACrC,MAAMkC,oBACLnC,cAAcD,IAAI,CAACE,gBAAgB,IACnCD,cAAcD,IAAI,CAACE,gBAAgB,CAAC2B,IAAI;YACzC,MAAMQ,uBAAuBD,kBAAkBE,YAAY;YAC3D,MAAMC,OAAOP,KAAKM,YAAY,GAAGD;YAEjCrB,eAAeuB;YACfJ,aACCI,SAAS,IACN,KACA,CAAC,EAAE,EAAEA,OAAO,IAAI,MAAM,IAAI,EAAE9C,MAAM+C,KAAKC,GAAG,CAACF,OAAO;gBAClDG,eAAe;YAChB,GAAG,CAAC,EAAEvD,iBAAiBwD,MAAM,CAACJ,OAAOF,sBAAsB,CAAC,CAAC;QACjE;QAEAX,OAAOC,IAAI,CACV5C,SAAS;YACR6C,MAAM;YACNM,QAAQF,KAAKE,MAAM;YACnBD,MAAMA;YACNT,MAAMQ,KAAKM,YAAY;YACvBC,MAAMJ;YACNS,OAAOZ,KAAKY,KAAK;YACjBvB;QACD;IAEF;IAEA,MAAMwB,oBACL7B,gBAAgB,IACb,KACA,CAAC,CAAC,EAAEA,cAAc,IAAI,MAAM,IAAI,EAAEvB,MAAM+C,KAAKC,GAAG,CAACzB,cAAc;QAC/D0B,eAAe;IAChB,GAAG,CAAC,CAAC;IAER,MAAMI,WAAW,CAAC;AACnB,EAAE7B,aAAa;AACf,EAAES,OAAOlC,IAAI,CAAC,MAAM;;AAEpB,EAAE2B,gBAAgBJ,cAAc8B,mBAAmBE,IAAI,GAAG;AAC1D,CAAC;IAEA,IAAIhC,cAAc;QACjBnB,OAAOC,QAAQ,GAAG;IACnB;IAEAD,OAAOI,IAAI,GAAG8C;IAEd,OAAOlD;AACR,EAAE"}

package/dist/utilities.d.ts

@@ -1,13 +1,17 @@
-type ReportStats = {
-    pass: boolean;
-    exitCode: number;
-    exitMessage: string;
-    outputFile: string;
-    prefix: string;
-    data: Record<string, unknown>;
-};
 export declare const STDOUT = "stdout";
-export declare const reportStats: ({ flags }: {
-    flags: any;
-}) => Promise<ReportStats>;
-export {};
+export declare const gzipSizeFromFileSync: (file: string) => number;
+export declare const getOutputFile: (file: string) => string;
+export declare const validateConfigurationFile: (file: string) => any;
+export declare const readJSONFile: (file: string) => any;
+export declare const getMostRecentVersion: (data: []) => any;
+export declare const percentFormatter: Intl.NumberFormat;
+export declare const formatFooter: (limit: boolean, diff: number | string) => string;
+export declare const addMDrow: ({ type, passed, name, size, diff, limit, columns, }: {
+    columns: any;
+    type: "header" | "row";
+    passed?: boolean;
+    name?: string;
+    size?: number;
+    diff?: string;
+    limit?: string;
+}) => string;

package/dist/utilities.js

@@ -1,96 +1,97 @@
 import bytes from "bytes";
 import fs from "fs-extra";
-import { glob } from "glob";
-import { gzipSizeFromFileSync } from "gzip-size";
-import path from "node:path";
-import { statSync } from "node:fs";
+import { join } from "node:path";
+import semver from "semver";
+import zlib from "node:zlib";
 export const STDOUT = "stdout";
 const CWD = process.cwd();
-export const reportStats = async ({ flags })=>{
+export const gzipSizeFromFileSync = (file)=>{
+    return zlib.gzipSync(fs.readFileSync(file)).length;
+};
+export const getOutputFile = (file)=>{
+    return file === "" || file === undefined ? STDOUT : join(CWD, file);
+};
+export const validateConfigurationFile = (file)=>{
     const result = {
-        pass: true,
         exitCode: 0,
         exitMessage: "",
-        outputFile: "",
-        prefix: "",
         data: {}
     };
-    let failed = false;
-    const configurationFile = flags.configuration.startsWith("/") ? flags.configuration : path.join(CWD, flags.configuration);
-    const outputFile = flags.output === "" || flags.output === undefined ? STDOUT : path.join(CWD, flags.output);
-    const prefix = flags.prefix || "0.0.0";
-    const currentResults = {};
-    if (flags.configuration === "") {
+    if (file === "") {
         result.exitMessage = "Please provide a configuration file";
         result.exitCode = 1;
         return result;
     }
+    const configurationFile = file.startsWith("/") ? file : join(CWD, file);
     if (fs.existsSync(configurationFile) === false) {
-        result.exitMessage = "Invalid or missing configuration file!";
+        result.exitMessage = `Invalid or missing configuration file!\n${configurationFile}`;
         result.exitCode = 1;
         return result;
     }
-    const configuration = await import(configurationFile).then((m)=>m.default);
-    for (const artifact of configuration){
-        const rootPath = artifact.path.startsWith("/") ? "" : path.dirname(configurationFile);
-        const artifactPath = path.dirname(artifact.path);
-        const globReplace = "+([a-zA-Z0-9_-])";
-        const hasHash = artifact.path.includes("<hash>");
-        /**
-		 * if the artifact.path has the string <hash> in it,
-		 * then we need to check for other characters:
-		 * - Double stars ** are allowed.
-		 * - Single stars * are not allowed.
-		 */ if (hasHash && /(?<!\*)\*(?!\*)/.test(artifact.path)) {
-            result.exitCode = 1;
-            result.exitMessage = `Invalid path: ${artifact.path}.\nSingle stars (*) are not allowed when using the special keyword <hash>`;
-            return result;
-        }
-        const fileGlob = path.join(rootPath, artifact.path.replace("<hash>", globReplace));
-        const files = glob.sync(fileGlob);
-        if (files.length === 0) {
-            result.exitCode = 1;
-            result.exitMessage = `File not found: ${fileGlob}`;
-            return result;
-        }
-        if (files.length > 1 && hasHash) {
-            result.exitCode = 1;
-            result.exitMessage = `Multiple files found for: ${artifact.path}.\nPlease use a more specific path when using the special keyword <hash>.`;
-            return result;
-        }
-        for (const file of files){
-            const fileSize = statSync(file).size;
-            const fileSizeGzip = gzipSizeFromFileSync(file);
-            const passed = fileSizeGzip < bytes(artifact.limit);
-            if (passed === false) {
-                result.pass = false;
-                failed = true;
-            }
-            let index = hasHash ? artifact.path : path.join(artifactPath, path.basename(file));
-            currentResults[index] = {
-                fileSize,
-                fileSizeGzip,
-                limit: artifact.limit,
-                passed
-            };
-        }
+    return {
+        ...result,
+        data: configurationFile
+    };
+};
+export const readJSONFile = (file)=>{
+    try {
+        return {
+            exitCode: 0,
+            exitMessage: "",
+            data: fs.readJsonSync(file)
+        };
+    } catch (error) {
+        return {
+            exitCode: 1,
+            exitMessage: `Failed to read JSON file: ${error.message}`
+        };
+    }
+};
+export const getMostRecentVersion = (data)=>{
+    const keys = [];
+    for (const key of Object.keys(data)){
+        keys.push(key);
     }
-    let existingResults = {};
-    if (outputFile !== STDOUT) {
-        try {
-            existingResults = fs.readJsonSync(outputFile);
-        } catch  {
-        /**
-			 * There are no existing results, so we can ignore this error,
-			 * and simply write the current results to the output file.
-			 */ }
+    keys.sort(semver.rcompare);
+    return keys[0];
+};
+export const percentFormatter = new Intl.NumberFormat("en", {
+    style: "percent",
+    signDisplay: "exceptZero",
+    minimumFractionDigits: 2,
+    maximumFractionDigits: 2
+});
+export const formatFooter = (limit, diff)=>{
+    return `Overall status: ${limit ? "🚫" : "✅"} ${diff}`;
+};
+export const addMDrow = ({ type, passed = true, name = "", size = 0, diff = "", limit = "", columns })=>{
+    const totalColumns = columns.length;
+    if (type === "header") {
+        const separator = " --- |".repeat(totalColumns);
+        const header = columns.map((column)=>column[Object.keys(column)[0]]);
+        return `| ${header.join(" | ")} |\n|${separator}`;
+    }
+    if (type === "row") {
+        const row = columns.map((column)=>{
+            const key = Object.keys(column)[0];
+            if (key === "status") {
+                return passed ? "✅" : "🚫";
+            }
+            if (key === "file") {
+                return name.replaceAll("<", "[").replaceAll(">", "]");
+            }
+            if (key === "size") {
+                return `${bytes(size, {
+                    unitSeparator: " "
+                })}${diff}`;
+            }
+            if (key === "limits") {
+                return limit;
+            }
+            return "";
+        });
+        return `| ${row.join(" | ")} |`;
     }
-    existingResults[prefix] = currentResults;
-    result.prefix = prefix;
-    result.outputFile = outputFile;
-    result.exitCode = failed && flags.silent === false ? 1 : 0;
-    result.data = existingResults;
-    return result;
 };
 
 //# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["import bytes from \"bytes\";\nimport fs from \"fs-extra\";\nimport { glob } from \"glob\";\nimport { gzipSizeFromFileSync } from \"gzip-size\";\nimport path from \"node:path\";\nimport { statSync } from \"node:fs\";\n\ntype Artifact = {\n\tpath: string;\n\tlimit: string;\n};\n\ntype ReportStats = {\n\tpass: boolean;\n\texitCode: number;\n\texitMessage: string;\n\toutputFile: string;\n\tprefix: string;\n\tdata: Record<string, unknown>;\n};\n\nexport const STDOUT = \"stdout\";\nconst CWD = process.cwd();\n\nexport const reportStats = async ({ flags }): Promise<ReportStats> => {\n\tconst result = {\n\t\tpass: true,\n\t\texitCode: 0,\n\t\texitMessage: \"\",\n\t\toutputFile: \"\",\n\t\tprefix: \"\",\n\t\tdata: {},\n\t};\n\tlet failed = false;\n\tconst configurationFile = flags.configuration.startsWith(\"/\")\n\t\t? flags.configuration\n\t\t: path.join(CWD, flags.configuration);\n\n\tconst outputFile =\n\t\tflags.output === \"\" || flags.output === undefined\n\t\t\t? STDOUT\n\t\t\t: path.join(CWD, flags.output);\n\tconst prefix = flags.prefix || \"0.0.0\";\n\tconst currentResults = {};\n\n\tif (flags.configuration === \"\") {\n\t\tresult.exitMessage = \"Please provide a configuration file\";\n\t\tresult.exitCode = 1;\n\t\treturn result;\n\t}\n\n\tif (fs.existsSync(configurationFile) === false) {\n\t\tresult.exitMessage = \"Invalid or missing configuration file!\";\n\t\tresult.exitCode = 1;\n\t\treturn result;\n\t}\n\tconst configuration: Artifact[] = await import(configurationFile).then(\n\t\t(m) => m.default,\n\t);\n\n\tfor (const artifact of configuration) {\n\t\tconst rootPath = artifact.path.startsWith(\"/\")\n\t\t\t? \"\"\n\t\t\t: path.dirname(configurationFile);\n\t\tconst artifactPath = path.dirname(artifact.path);\n\t\tconst globReplace = \"+([a-zA-Z0-9_-])\";\n\t\tconst hasHash = artifact.path.includes(\"<hash>\");\n\n\t\t/**\n\t\t * if the artifact.path has the string <hash> in it,\n\t\t * then we need to check for other characters:\n\t\t * - Double stars ** are allowed.\n\t\t * - Single stars * are not allowed.\n\t\t */\n\t\tif (hasHash && /(?<!\\*)\\*(?!\\*)/.test(artifact.path)) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `Invalid path: ${artifact.path}.\\nSingle stars (*) are not allowed when using the special keyword <hash>`;\n\t\t\treturn result;\n\t\t}\n\n\t\tconst fileGlob = path.join(\n\t\t\trootPath,\n\t\t\tartifact.path.replace(\"<hash>\", globReplace),\n\t\t);\n\t\tconst files = glob.sync(fileGlob);\n\n\t\tif (files.length === 0) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `File not found: ${fileGlob}`;\n\t\t\treturn result;\n\t\t}\n\n\t\tif (files.length > 1 && hasHash) {\n\t\t\tresult.exitCode = 1;\n\t\t\tresult.exitMessage = `Multiple files found for: ${artifact.path}.\\nPlease use a more specific path when using the special keyword <hash>.`;\n\t\t\treturn result;\n\t\t}\n\n\t\tfor (const file of files) {\n\t\t\tconst fileSize = statSync(file).size;\n\t\t\tconst fileSizeGzip = gzipSizeFromFileSync(file);\n\t\t\tconst passed = fileSizeGzip < bytes(artifact.limit);\n\n\t\t\tif (passed === false) {\n\t\t\t\tresult.pass = false;\n\t\t\t\tfailed = true;\n\t\t\t}\n\t\t\tlet index = hasHash\n\t\t\t\t? artifact.path\n\t\t\t\t: path.join(artifactPath, path.basename(file));\n\n\t\t\tcurrentResults[index] = {\n\t\t\t\tfileSize,\n\t\t\t\tfileSizeGzip,\n\t\t\t\tlimit: artifact.limit,\n\t\t\t\tpassed,\n\t\t\t};\n\t\t}\n\t}\n\n\tlet existingResults = {};\n\tif (outputFile !== STDOUT) {\n\t\ttry {\n\t\t\texistingResults = fs.readJsonSync(outputFile);\n\t\t} catch {\n\t\t\t/**\n\t\t\t * There are no existing results, so we can ignore this error,\n\t\t\t * and simply write the current results to the output file.\n\t\t\t */\n\t\t}\n\t}\n\texistingResults[prefix] = currentResults;\n\n\tresult.prefix = prefix;\n\tresult.outputFile = outputFile;\n\tresult.exitCode = failed && flags.silent === false ? 1 : 0;\n\tresult.data = existingResults;\n\treturn result;\n};\n"],"names":["bytes","fs","glob","gzipSizeFromFileSync","path","statSync","STDOUT","CWD","process","cwd","reportStats","flags","result","pass","exitCode","exitMessage","outputFile","prefix","data","failed","configurationFile","configuration","startsWith","join","output","undefined","currentResults","existsSync","then","m","default","artifact","rootPath","dirname","artifactPath","globReplace","hasHash","includes","test","fileGlob","replace","files","sync","length","file","fileSize","size","fileSizeGzip","passed","limit","index","basename","existingResults","readJsonSync","silent"],"mappings":"AAAA,OAAOA,WAAW,QAAQ;AAC1B,OAAOC,QAAQ,WAAW;AAC1B,SAASC,IAAI,QAAQ,OAAO;AAC5B,SAASC,oBAAoB,QAAQ,YAAY;AACjD,OAAOC,UAAU,YAAY;AAC7B,SAASC,QAAQ,QAAQ,UAAU;AAgBnC,OAAO,MAAMC,SAAS,SAAS;AAC/B,MAAMC,MAAMC,QAAQC,GAAG;AAEvB,OAAO,MAAMC,cAAc,OAAO,EAAEC,KAAK,EAAE;IAC1C,MAAMC,SAAS;QACdC,MAAM;QACNC,UAAU;QACVC,aAAa;QACbC,YAAY;QACZC,QAAQ;QACRC,MAAM,CAAC;IACR;IACA,IAAIC,SAAS;IACb,MAAMC,oBAAoBT,MAAMU,aAAa,CAACC,UAAU,CAAC,OACtDX,MAAMU,aAAa,GACnBjB,KAAKmB,IAAI,CAAChB,KAAKI,MAAMU,aAAa;IAErC,MAAML,aACLL,MAAMa,MAAM,KAAK,MAAMb,MAAMa,MAAM,KAAKC,YACrCnB,SACAF,KAAKmB,IAAI,CAAChB,KAAKI,MAAMa,MAAM;IAC/B,MAAMP,SAASN,MAAMM,MAAM,IAAI;IAC/B,MAAMS,iBAAiB,CAAC;IAExB,IAAIf,MAAMU,aAAa,KAAK,IAAI;QAC/BT,OAAOG,WAAW,GAAG;QACrBH,OAAOE,QAAQ,GAAG;QAClB,OAAOF;IACR;IAEA,IAAIX,GAAG0B,UAAU,CAACP,uBAAuB,OAAO;QAC/CR,OAAOG,WAAW,GAAG;QACrBH,OAAOE,QAAQ,GAAG;QAClB,OAAOF;IACR;IACA,MAAMS,gBAA4B,MAAM,MAAM,CAACD,mBAAmBQ,IAAI,CACrE,CAACC,IAAMA,EAAEC,OAAO;IAGjB,KAAK,MAAMC,YAAYV,cAAe;QACrC,MAAMW,WAAWD,SAAS3B,IAAI,CAACkB,UAAU,CAAC,OACvC,KACAlB,KAAK6B,OAAO,CAACb;QAChB,MAAMc,eAAe9B,KAAK6B,OAAO,CAACF,SAAS3B,IAAI;QAC/C,MAAM+B,cAAc;QACpB,MAAMC,UAAUL,SAAS3B,IAAI,CAACiC,QAAQ,CAAC;QAEvC;;;;;GAKC,GACD,IAAID,WAAW,kBAAkBE,IAAI,CAACP,SAAS3B,IAAI,GAAG;YACrDQ,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,cAAc,EAAEgB,SAAS3B,IAAI,CAAC,yEAAyE,CAAC;YAC9H,OAAOQ;QACR;QAEA,MAAM2B,WAAWnC,KAAKmB,IAAI,CACzBS,UACAD,SAAS3B,IAAI,CAACoC,OAAO,CAAC,UAAUL;QAEjC,MAAMM,QAAQvC,KAAKwC,IAAI,CAACH;QAExB,IAAIE,MAAME,MAAM,KAAK,GAAG;YACvB/B,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,gBAAgB,EAAEwB,SAAS,CAAC;YAClD,OAAO3B;QACR;QAEA,IAAI6B,MAAME,MAAM,GAAG,KAAKP,SAAS;YAChCxB,OAAOE,QAAQ,GAAG;YAClBF,OAAOG,WAAW,GAAG,CAAC,0BAA0B,EAAEgB,SAAS3B,IAAI,CAAC,yEAAyE,CAAC;YAC1I,OAAOQ;QACR;QAEA,KAAK,MAAMgC,QAAQH,MAAO;YACzB,MAAMI,WAAWxC,SAASuC,MAAME,IAAI;YACpC,MAAMC,eAAe5C,qBAAqByC;YAC1C,MAAMI,SAASD,eAAe/C,MAAM+B,SAASkB,KAAK;YAElD,IAAID,WAAW,OAAO;gBACrBpC,OAAOC,IAAI,GAAG;gBACdM,SAAS;YACV;YACA,IAAI+B,QAAQd,UACTL,SAAS3B,IAAI,GACbA,KAAKmB,IAAI,CAACW,cAAc9B,KAAK+C,QAAQ,CAACP;YAEzClB,cAAc,CAACwB,MAAM,GAAG;gBACvBL;gBACAE;gBACAE,OAAOlB,SAASkB,KAAK;gBACrBD;YACD;QACD;IACD;IAEA,IAAII,kBAAkB,CAAC;IACvB,IAAIpC,eAAeV,QAAQ;QAC1B,IAAI;YACH8C,kBAAkBnD,GAAGoD,YAAY,CAACrC;QACnC,EAAE,OAAM;QACP;;;IAGC,GACF;IACD;IACAoC,eAAe,CAACnC,OAAO,GAAGS;IAE1Bd,OAAOK,MAAM,GAAGA;IAChBL,OAAOI,UAAU,GAAGA;IACpBJ,OAAOE,QAAQ,GAAGK,UAAUR,MAAM2C,MAAM,KAAK,QAAQ,IAAI;IACzD1C,OAAOM,IAAI,GAAGkC;IACd,OAAOxC;AACR,EAAE"}
+{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["import bytes from \"bytes\";\nimport fs from \"fs-extra\";\nimport { join } from \"node:path\";\nimport semver from \"semver\";\nimport zlib from \"node:zlib\";\n\nexport const STDOUT = \"stdout\";\nconst CWD = process.cwd();\n\nexport const gzipSizeFromFileSync = (file: string): number => {\n\treturn zlib.gzipSync(fs.readFileSync(file)).length;\n};\n\nexport const getOutputFile = (file: string): string => {\n\treturn file === \"\" || file === undefined ? STDOUT : join(CWD, file);\n};\n\nexport const validateConfigurationFile = (file: string): any => {\n\tconst result = {\n\t\texitCode: 0,\n\t\texitMessage: \"\",\n\t\tdata: {},\n\t};\n\tif (file === \"\") {\n\t\tresult.exitMessage = \"Please provide a configuration file\";\n\t\tresult.exitCode = 1;\n\t\treturn result;\n\t}\n\n\tconst configurationFile = file.startsWith(\"/\") ? file : join(CWD, file);\n\n\tif (fs.existsSync(configurationFile) === false) {\n\t\tresult.exitMessage = `Invalid or missing configuration file!\\n${configurationFile}`;\n\t\tresult.exitCode = 1;\n\t\treturn result;\n\t}\n\n\treturn {\n\t\t...result,\n\t\tdata: configurationFile,\n\t};\n};\n\nexport const readJSONFile = (file: string): any => {\n\ttry {\n\t\treturn {\n\t\t\texitCode: 0,\n\t\t\texitMessage: \"\",\n\t\t\tdata: fs.readJsonSync(file),\n\t\t};\n\t} catch (error) {\n\t\treturn {\n\t\t\texitCode: 1,\n\t\t\texitMessage: `Failed to read JSON file: ${error.message}`,\n\t\t};\n\t}\n};\n\nexport const getMostRecentVersion = (data: []) => {\n\tconst keys = [];\n\tfor (const key of Object.keys(data)) {\n\t\tkeys.push(key);\n\t}\n\tkeys.sort(semver.rcompare);\n\treturn keys[0];\n};\n\nexport const percentFormatter = new Intl.NumberFormat(\"en\", {\n\tstyle: \"percent\",\n\tsignDisplay: \"exceptZero\",\n\tminimumFractionDigits: 2,\n\tmaximumFractionDigits: 2,\n});\n\nexport const formatFooter = (limit: boolean, diff: number | string): string => {\n\treturn `Overall status: ${limit ? \"🚫\" : \"✅\"} ${diff}`;\n};\n\nexport const addMDrow = ({\n\ttype,\n\tpassed = true,\n\tname = \"\",\n\tsize = 0,\n\tdiff = \"\",\n\tlimit = \"\",\n\tcolumns,\n}: {\n\tcolumns: any;\n\ttype: \"header\" | \"row\";\n\tpassed?: boolean;\n\tname?: string;\n\tsize?: number;\n\tdiff?: string;\n\tlimit?: string;\n}) => {\n\tconst totalColumns = columns.length;\n\n\tif (type === \"header\") {\n\t\tconst separator = \" --- |\".repeat(totalColumns);\n\t\tconst header = columns.map((column) => column[Object.keys(column)[0]]);\n\t\treturn `| ${header.join(\" | \")} |\\n|${separator}`;\n\t}\n\tif (type === \"row\") {\n\t\tconst row = columns.map((column) => {\n\t\t\tconst key = Object.keys(column)[0];\n\t\t\tif (key === \"status\") {\n\t\t\t\treturn passed ? \"✅\" : \"🚫\";\n\t\t\t}\n\t\t\tif (key === \"file\") {\n\t\t\t\treturn name.replaceAll(\"<\", \"[\").replaceAll(\">\", \"]\");\n\t\t\t}\n\t\t\tif (key === \"size\") {\n\t\t\t\treturn `${bytes(size, {\n\t\t\t\t\tunitSeparator: \" \",\n\t\t\t\t})}${diff}`;\n\t\t\t}\n\t\t\tif (key === \"limits\") {\n\t\t\t\treturn limit;\n\t\t\t}\n\t\t\treturn \"\";\n\t\t});\n\n\t\treturn `| ${row.join(\" | \")} |`;\n\t}\n};\n"],"names":["bytes","fs","join","semver","zlib","STDOUT","CWD","process","cwd","gzipSizeFromFileSync","file","gzipSync","readFileSync","length","getOutputFile","undefined","validateConfigurationFile","result","exitCode","exitMessage","data","configurationFile","startsWith","existsSync","readJSONFile","readJsonSync","error","message","getMostRecentVersion","keys","key","Object","push","sort","rcompare","percentFormatter","Intl","NumberFormat","style","signDisplay","minimumFractionDigits","maximumFractionDigits","formatFooter","limit","diff","addMDrow","type","passed","name","size","columns","totalColumns","separator","repeat","header","map","column","row","replaceAll","unitSeparator"],"mappings":"AAAA,OAAOA,WAAW,QAAQ;AAC1B,OAAOC,QAAQ,WAAW;AAC1B,SAASC,IAAI,QAAQ,YAAY;AACjC,OAAOC,YAAY,SAAS;AAC5B,OAAOC,UAAU,YAAY;AAE7B,OAAO,MAAMC,SAAS,SAAS;AAC/B,MAAMC,MAAMC,QAAQC,GAAG;AAEvB,OAAO,MAAMC,uBAAuB,CAACC;IACpC,OAAON,KAAKO,QAAQ,CAACV,GAAGW,YAAY,CAACF,OAAOG,MAAM;AACnD,EAAE;AAEF,OAAO,MAAMC,gBAAgB,CAACJ;IAC7B,OAAOA,SAAS,MAAMA,SAASK,YAAYV,SAASH,KAAKI,KAAKI;AAC/D,EAAE;AAEF,OAAO,MAAMM,4BAA4B,CAACN;IACzC,MAAMO,SAAS;QACdC,UAAU;QACVC,aAAa;QACbC,MAAM,CAAC;IACR;IACA,IAAIV,SAAS,IAAI;QAChBO,OAAOE,WAAW,GAAG;QACrBF,OAAOC,QAAQ,GAAG;QAClB,OAAOD;IACR;IAEA,MAAMI,oBAAoBX,KAAKY,UAAU,CAAC,OAAOZ,OAAOR,KAAKI,KAAKI;IAElE,IAAIT,GAAGsB,UAAU,CAACF,uBAAuB,OAAO;QAC/CJ,OAAOE,WAAW,GAAG,CAAC,wCAAwC,EAAEE,kBAAkB,CAAC;QACnFJ,OAAOC,QAAQ,GAAG;QAClB,OAAOD;IACR;IAEA,OAAO;QACN,GAAGA,MAAM;QACTG,MAAMC;IACP;AACD,EAAE;AAEF,OAAO,MAAMG,eAAe,CAACd;IAC5B,IAAI;QACH,OAAO;YACNQ,UAAU;YACVC,aAAa;YACbC,MAAMnB,GAAGwB,YAAY,CAACf;QACvB;IACD,EAAE,OAAOgB,OAAO;QACf,OAAO;YACNR,UAAU;YACVC,aAAa,CAAC,0BAA0B,EAAEO,MAAMC,OAAO,CAAC,CAAC;QAC1D;IACD;AACD,EAAE;AAEF,OAAO,MAAMC,uBAAuB,CAACR;IACpC,MAAMS,OAAO,EAAE;IACf,KAAK,MAAMC,OAAOC,OAAOF,IAAI,CAACT,MAAO;QACpCS,KAAKG,IAAI,CAACF;IACX;IACAD,KAAKI,IAAI,CAAC9B,OAAO+B,QAAQ;IACzB,OAAOL,IAAI,CAAC,EAAE;AACf,EAAE;AAEF,OAAO,MAAMM,mBAAmB,IAAIC,KAAKC,YAAY,CAAC,MAAM;IAC3DC,OAAO;IACPC,aAAa;IACbC,uBAAuB;IACvBC,uBAAuB;AACxB,GAAG;AAEH,OAAO,MAAMC,eAAe,CAACC,OAAgBC;IAC5C,OAAO,CAAC,gBAAgB,EAAED,QAAQ,OAAO,IAAI,CAAC,EAAEC,KAAK,CAAC;AACvD,EAAE;AAEF,OAAO,MAAMC,WAAW,CAAC,EACxBC,IAAI,EACJC,SAAS,IAAI,EACbC,OAAO,EAAE,EACTC,OAAO,CAAC,EACRL,OAAO,EAAE,EACTD,QAAQ,EAAE,EACVO,OAAO,EASP;IACA,MAAMC,eAAeD,QAAQrC,MAAM;IAEnC,IAAIiC,SAAS,UAAU;QACtB,MAAMM,YAAY,SAASC,MAAM,CAACF;QAClC,MAAMG,SAASJ,QAAQK,GAAG,CAAC,CAACC,SAAWA,MAAM,CAACzB,OAAOF,IAAI,CAAC2B,OAAO,CAAC,EAAE,CAAC;QACrE,OAAO,CAAC,EAAE,EAAEF,OAAOpD,IAAI,CAAC,OAAO,KAAK,EAAEkD,UAAU,CAAC;IAClD;IACA,IAAIN,SAAS,OAAO;QACnB,MAAMW,MAAMP,QAAQK,GAAG,CAAC,CAACC;YACxB,MAAM1B,MAAMC,OAAOF,IAAI,CAAC2B,OAAO,CAAC,EAAE;YAClC,IAAI1B,QAAQ,UAAU;gBACrB,OAAOiB,SAAS,MAAM;YACvB;YACA,IAAIjB,QAAQ,QAAQ;gBACnB,OAAOkB,KAAKU,UAAU,CAAC,KAAK,KAAKA,UAAU,CAAC,KAAK;YAClD;YACA,IAAI5B,QAAQ,QAAQ;gBACnB,OAAO,CAAC,EAAE9B,MAAMiD,MAAM;oBACrBU,eAAe;gBAChB,GAAG,EAAEf,KAAK,CAAC;YACZ;YACA,IAAId,QAAQ,UAAU;gBACrB,OAAOa;YACR;YACA,OAAO;QACR;QAEA,OAAO,CAAC,EAAE,EAAEc,IAAIvD,IAAI,CAAC,OAAO,EAAE,CAAC;IAChC;AACD,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/bundlesize",
-	"version": "2.1.4",
+	"version": "3.0.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "Simple CLI tool that checks file(s) size and report if limits have been reached",
@@ -32,10 +32,10 @@
 		"bytes": "3.1.2",
 		"fs-extra": "11.2.0",
 		"glob": "10.3.10",
-		"gzip-size": "7.0.0"
+		"semver": "7.5.4"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "e7e1567e048693bb1665e6402291df2d16cfe69e"
+	"gitHead": "852bffa76c7fb0ad5bb594c7b71ffe68f8c8faff"
 }