@node-cli/bundlesize 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Arno Versini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# Node CLI Bundle Size package
+
+![npm](https://img.shields.io/npm/v/@node-cli/bundlesize?label=version&logo=npm)
+
+> Bundlesize is a simple CLI tool that checks file(s) size and report if limits have been reached.
+
+## Installation
+
+```sh
+> npm install --dev @node-cli/bundlesize
+```
+
+## Examples
+
+Assuming there is a `bundlesize.config.js` file in the root of the project with the following content:
+
+```js
+export default [
+	{
+		path: "dist/some-bundle.js",
+		limit: "10 kB",
+	},
+];
+```
+
+### Print the results at the command line
+
+```json
+"scripts": {
+	"stats": "bundlesize -c bundlesize.config.js"
+}
+```
+
+### Print the results in a file
+
+```json
+"scripts": {
+	"stats": "bundlesize -c bundlesize.config.js -o stats.json"
+}
+```
+
+### Print the results in a file but do not fail if the limit is reached
+
+```json
+"scripts": {
+  "stats": "bundlesize -c bundlesize.config.js -o stats.json -s"
+}
+```
+
+### Add a prefix to the results
+
+```json
+"scripts": {
+  "stats": "bundlesize -c bundlesize.config.js -o stats.json -p 'My prefix'"
+}
+```
+
+### Use the current package version as a prefix
+
+```json
+"scripts": {
+  "stats": "bundlesize -c bundlesize.config.js -o stats.json -p \"$npm_package_version\""
+}
+```
+
+## Get help
+
+```sh
+> bundlesize --help
+```
+
+## License
+
+MIT © Arno Versini

package/dist/bundlesize.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bundlesize.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+import { Logger } from "@node-cli/logger";
+import bytes from "bytes";
+import { config } from "./parse.js";
+import fs from "fs-extra";
+import { gzipSizeFromFileSync } from "gzip-size";
+import path from "node:path";
+import { statSync } from "node:fs";
+const STDOUT = "stdout";
+const CWD = process.cwd();
+const flags = config.flags;
+const configurationFile = path.join(CWD, flags.configuration);
+const outputFile = flags.output === "" || flags.output === undefined ? STDOUT : path.join(CWD, flags.output);
+const prefix = flags.prefix || Date.now().toString();
+const resultsMap = new Map();
+const log = new Logger({
+    boring: flags.boring
+});
+let failed = false;
+if (flags.configuration === "") {
+    log.error("Please provide a configuration file");
+    process.exit(0);
+}
+if (fs.existsSync(configurationFile) === false) {
+    log.error("Invalid or missing configuration file!");
+    process.exit(0);
+}
+try {
+    const configuration = await import(configurationFile).then((m)=>m.default);
+    for (const artifact of configuration){
+        const file = path.join(path.dirname(configurationFile), artifact.path);
+        const fileSize = statSync(file).size;
+        const fileSizeGzip = gzipSizeFromFileSync(file);
+        const passed = fileSizeGzip < bytes(artifact.limit);
+        if (passed === false) {
+            failed = true;
+        }
+        resultsMap.set(artifact.path, {
+            path: file,
+            fileSize,
+            fileSizeGzip,
+            limit: artifact.limit,
+            passed
+        });
+    }
+    const results = [
+        ...resultsMap.values()
+    ];
+    let existingResults = {};
+    if (outputFile !== STDOUT) {
+        try {
+            existingResults = fs.readJsonSync(outputFile);
+        } catch  {
+        // nothing to declare officer
+        }
+    }
+    existingResults[prefix] = results;
+    if (outputFile !== STDOUT) {
+        fs.outputJsonSync(outputFile, existingResults, {
+            spaces: 2
+        });
+    }
+    if (outputFile === STDOUT) {
+        log.info(`Configuration: ${flags.configuration}`);
+        log.info(`Output: ${outputFile}`);
+        log.info(`Output prefix: ${prefix}`);
+        log.log(`\n${JSON.stringify(results, undefined, 2)}`);
+    }
+} catch (error) {
+    log.error(error);
+    process.exit(0);
+}
+if (failed && flags.silent === false) {
+    process.exit(1);
+}
+
+//# sourceMappingURL=bundlesize.js.map

package/dist/bundlesize.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/bundlesize.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { Logger } from \"@node-cli/logger\";\nimport bytes from \"bytes\";\nimport { config } from \"./parse.js\";\nimport fs from \"fs-extra\";\nimport { gzipSizeFromFileSync } from \"gzip-size\";\nimport path from \"node:path\";\nimport { statSync } from \"node:fs\";\n\nconst STDOUT = \"stdout\";\nconst CWD = process.cwd();\n\nconst flags = config.flags;\nconst configurationFile = path.join(CWD, flags.configuration);\nconst outputFile =\n\tflags.output === \"\" || flags.output === undefined\n\t\t? STDOUT\n\t\t: path.join(CWD, flags.output);\nconst prefix = flags.prefix || Date.now().toString();\nconst resultsMap = new Map();\nconst log = new Logger({\n\tboring: flags.boring,\n});\n\nlet failed = false;\n\nif (flags.configuration === \"\") {\n\tlog.error(\"Please provide a configuration file\");\n\tprocess.exit(0);\n}\n\nif (fs.existsSync(configurationFile) === false) {\n\tlog.error(\"Invalid or missing configuration file!\");\n\tprocess.exit(0);\n}\n\ntry {\n\tconst configuration = await import(configurationFile).then((m) => m.default);\n\n\tfor (const artifact of configuration) {\n\t\tconst file = path.join(path.dirname(configurationFile), artifact.path);\n\t\tconst fileSize = statSync(file).size;\n\t\tconst fileSizeGzip = gzipSizeFromFileSync(file);\n\t\tconst passed = fileSizeGzip < bytes(artifact.limit);\n\n\t\tif (passed === false) {\n\t\t\tfailed = true;\n\t\t}\n\n\t\tresultsMap.set(artifact.path, {\n\t\t\tpath: file,\n\t\t\tfileSize,\n\t\t\tfileSizeGzip,\n\t\t\tlimit: artifact.limit,\n\t\t\tpassed,\n\t\t});\n\t}\n\n\tconst results = [...resultsMap.values()];\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// nothing to declare officer\n\t\t}\n\t}\n\texistingResults[prefix] = results;\n\tif (outputFile !== STDOUT) {\n\t\tfs.outputJsonSync(outputFile, existingResults, { spaces: 2 });\n\t}\n\n\tif (outputFile === STDOUT) {\n\t\tlog.info(`Configuration: ${flags.configuration}`);\n\t\tlog.info(`Output: ${outputFile}`);\n\t\tlog.info(`Output prefix: ${prefix}`);\n\t\tlog.log(`\\n${JSON.stringify(results, undefined, 2)}`);\n\t}\n} catch (error) {\n\tlog.error(error);\n\tprocess.exit(0);\n}\n\nif (failed && flags.silent === false) {\n\tprocess.exit(1);\n}\n"],"names":["Logger","bytes","config","fs","gzipSizeFromFileSync","path","statSync","STDOUT","CWD","process","cwd","flags","configurationFile","join","configuration","outputFile","output","undefined","prefix","Date","now","toString","resultsMap","Map","log","boring","failed","error","exit","existsSync","then","m","default","artifact","file","dirname","fileSize","size","fileSizeGzip","passed","limit","set","results","values","existingResults","readJsonSync","outputJsonSync","spaces","info","JSON","stringify","silent"],"mappings":";AAEA,SAASA,MAAM,QAAQ,mBAAmB;AAC1C,OAAOC,WAAW,QAAQ;AAC1B,SAASC,MAAM,QAAQ,aAAa;AACpC,OAAOC,QAAQ,WAAW;AAC1B,SAASC,oBAAoB,QAAQ,YAAY;AACjD,OAAOC,UAAU,YAAY;AAC7B,SAASC,QAAQ,QAAQ,UAAU;AAEnC,MAAMC,SAAS;AACf,MAAMC,MAAMC,QAAQC,GAAG;AAEvB,MAAMC,QAAQT,OAAOS,KAAK;AAC1B,MAAMC,oBAAoBP,KAAKQ,IAAI,CAACL,KAAKG,MAAMG,aAAa;AAC5D,MAAMC,aACLJ,MAAMK,MAAM,KAAK,MAAML,MAAMK,MAAM,KAAKC,YACrCV,SACAF,KAAKQ,IAAI,CAACL,KAAKG,MAAMK,MAAM;AAC/B,MAAME,SAASP,MAAMO,MAAM,IAAIC,KAAKC,GAAG,GAAGC,QAAQ;AAClD,MAAMC,aAAa,IAAIC;AACvB,MAAMC,MAAM,IAAIxB,OAAO;IACtByB,QAAQd,MAAMc,MAAM;AACrB;AAEA,IAAIC,SAAS;AAEb,IAAIf,MAAMG,aAAa,KAAK,IAAI;IAC/BU,IAAIG,KAAK,CAAC;IACVlB,QAAQmB,IAAI,CAAC;AACd;AAEA,IAAIzB,GAAG0B,UAAU,CAACjB,uBAAuB,OAAO;IAC/CY,IAAIG,KAAK,CAAC;IACVlB,QAAQmB,IAAI,CAAC;AACd;AAEA,IAAI;IACH,MAAMd,gBAAgB,MAAM,MAAM,CAACF,mBAAmBkB,IAAI,CAAC,CAACC,IAAMA,EAAEC,OAAO;IAE3E,KAAK,MAAMC,YAAYnB,cAAe;QACrC,MAAMoB,OAAO7B,KAAKQ,IAAI,CAACR,KAAK8B,OAAO,CAACvB,oBAAoBqB,SAAS5B,IAAI;QACrE,MAAM+B,WAAW9B,SAAS4B,MAAMG,IAAI;QACpC,MAAMC,eAAelC,qBAAqB8B;QAC1C,MAAMK,SAASD,eAAerC,MAAMgC,SAASO,KAAK;QAElD,IAAID,WAAW,OAAO;YACrBb,SAAS;QACV;QAEAJ,WAAWmB,GAAG,CAACR,SAAS5B,IAAI,EAAE;YAC7BA,MAAM6B;YACNE;YACAE;YACAE,OAAOP,SAASO,KAAK;YACrBD;QACD;IACD;IAEA,MAAMG,UAAU;WAAIpB,WAAWqB,MAAM;KAAG;IACxC,IAAIC,kBAAkB,CAAC;IACvB,IAAI7B,eAAeR,QAAQ;QAC1B,IAAI;YACHqC,kBAAkBzC,GAAG0C,YAAY,CAAC9B;QACnC,EAAE,OAAM;QACP,6BAA6B;QAC9B;IACD;IACA6B,eAAe,CAAC1B,OAAO,GAAGwB;IAC1B,IAAI3B,eAAeR,QAAQ;QAC1BJ,GAAG2C,cAAc,CAAC/B,YAAY6B,iBAAiB;YAAEG,QAAQ;QAAE;IAC5D;IAEA,IAAIhC,eAAeR,QAAQ;QAC1BiB,IAAIwB,IAAI,CAAC,CAAC,eAAe,EAAErC,MAAMG,aAAa,CAAC,CAAC;QAChDU,IAAIwB,IAAI,CAAC,CAAC,QAAQ,EAAEjC,WAAW,CAAC;QAChCS,IAAIwB,IAAI,CAAC,CAAC,eAAe,EAAE9B,OAAO,CAAC;QACnCM,IAAIA,GAAG,CAAC,CAAC,EAAE,EAAEyB,KAAKC,SAAS,CAACR,SAASzB,WAAW,GAAG,CAAC;IACrD;AACD,EAAE,OAAOU,OAAO;IACfH,IAAIG,KAAK,CAACA;IACVlB,QAAQmB,IAAI,CAAC;AACd;AAEA,IAAIF,UAAUf,MAAMwC,MAAM,KAAK,OAAO;IACrC1C,QAAQmB,IAAI,CAAC;AACd"}

package/dist/defaults.d.ts

@@ -0,0 +1,5 @@
+export declare const defaultFlags: {
+    boring: boolean;
+    configuration: string;
+    silent: boolean;
+};

package/dist/defaults.js

@@ -0,0 +1,7 @@
+export const defaultFlags = {
+    boring: false,
+    configuration: "",
+    silent: false
+};
+
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["export const defaultFlags = {\n\tboring: false,\n\tconfiguration: \"\",\n\tsilent: false,\n};\n"],"names":["defaultFlags","boring","configuration","silent"],"mappings":"AAAA,OAAO,MAAMA,eAAe;IAC3BC,QAAQ;IACRC,eAAe;IACfC,QAAQ;AACT,EAAE"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./bundlesize";
+export * from "./defaults";
+export * from "./parse";

package/dist/parse.d.ts

@@ -0,0 +1,15 @@
+export type Flags = {
+    boring?: boolean;
+    help?: boolean;
+    version?: boolean;
+    configuration?: string;
+    output?: string;
+    prefix?: string;
+    silent?: boolean;
+};
+export type Configuration = {
+    flags?: Flags;
+    usage?: boolean;
+    showHelp?: () => void;
+};
+export declare const config: Configuration;

package/dist/parse.js

@@ -0,0 +1,49 @@
+import { defaultFlags } from "./defaults.js";
+import { parser } from "@node-cli/parser";
+/* istanbul ignore next */ export const config = parser({
+    meta: import.meta,
+    examples: [],
+    flags: {
+        configuration: {
+            shortFlag: "c",
+            description: "Specify a configuration file",
+            type: "string"
+        },
+        output: {
+            shortFlag: "o",
+            description: "Specify the output file",
+            type: "string"
+        },
+        prefix: {
+            shortFlag: "p",
+            description: "Specify a prefix to use in the output file",
+            type: "string"
+        },
+        silent: {
+            shortFlag: "s",
+            default: defaultFlags.silent,
+            description: "Do not exit in error when a limit is exceeded",
+            type: "boolean"
+        },
+        boring: {
+            shortFlag: "b",
+            default: defaultFlags.boring,
+            description: "Do not use color output",
+            type: "boolean"
+        },
+        help: {
+            shortFlag: "h",
+            description: "Display help instructions",
+            type: "boolean"
+        },
+        version: {
+            shortFlag: "v",
+            description: "Output the current version",
+            type: "boolean"
+        }
+    },
+    usage: true,
+    defaultFlags
+});
+
+//# sourceMappingURL=parse.js.map

package/dist/parse.js.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "@node-cli/bundlesize",
+	"version": "0.0.0",
+	"license": "MIT",
+	"author": "Arno Versini",
+	"description": "Simple CLI tool that checks file(s) size and report if limits have been reached",
+	"type": "module",
+	"types": "./dist/index.d.ts",
+	"exports": "./dist/bundlesize.js",
+	"bin": "dist/bundlesize.js",
+	"files": [
+		"dist"
+	],
+	"node": ">=18",
+	"scripts": {
+		"build": "yarn run clean && yarn run build:types && yarn run build:js && yarn run build:barrel",
+		"build:barrel": "barrelsby --delete --directory dist --pattern \"**/*.d.ts\" --name \"index.d\"",
+		"build:js": "swc --source-maps --out-dir dist src",
+		"build:types": "tsc",
+		"clean": "rimraf dist types coverage",
+		"lint": "prettier --write \"src/*.ts\" && eslint --fix \"src/*.ts\"",
+		"stats": "bundlesize -c bundlesize.config.js",
+		"watch": "swc --watch --out-dir dist src"
+	},
+	"dependencies": {
+		"@node-cli/logger": ">=1.2.0",
+		"@node-cli/parser": ">=2.2.1",
+		"bytes": "3.1.2",
+		"fs-extra": "11.2.0",
+		"gzip-size": "7.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "128145d5b6fe5e3f142343cb494466700d85071c"
+}