bundle-budget-lite 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tejas Kadam
+
+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,41 @@
+# bundle-budget-lite
+
+Checks file sizes against a budget config and reports pass/fail per entry — pluggable size source, no bundler coupling, ideal for CI.
+
+## Install
+
+```bash
+npm install bundle-budget-lite
+```
+
+## Quick start
+
+```ts
+import { checkBudget, hasFailures, formatReport } from 'bundle-budget-lite';
+import { statSync } from 'fs';
+
+const entries = [
+  { name: 'main.js', maxBytes: 100_000, warnBytes: 80_000 },
+  { name: 'vendor.js', maxBytes: 250_000 }
+];
+
+const sizes = Object.fromEntries(entries.map((e) => [e.name, statSync(`dist/${e.name}`).size]));
+const results = checkBudget(entries, sizes);
+
+console.log(formatReport(results));
+if (hasFailures(results)) process.exit(1);
+```
+
+## Why bundle-budget-lite
+
+Bundle size budgets are usually baked into a specific bundler's plugin ecosystem, which makes them awkward to reuse across projects or CI systems. bundle-budget-lite takes the size numbers as plain input — a `Record<string, number>` you can build from `fs.statSync`, a bundler's stats output, or a gzip size check — and just does the comparison: pass, warn (below max but past an optional warn threshold), fail (over max), or missing (no size reported for that entry). `hasFailures` gives you a one-line CI gate, and `formatReport` renders a readable summary.
+
+## API
+
+- `checkBudget(entries, sizes)` — returns one `BudgetResult` per entry with `status` (`pass` | `warn` | `fail` | `missing`) and `overBytes`.
+- `hasFailures(results)` — true if any result is `fail`.
+- `formatReport(results)` — renders a plain-text summary, one line per entry.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+interface BudgetEntry {
+    /** A label or glob-like path identifying the artifact (informational; matching is by SizeSource key). */
+    name: string;
+    /** Maximum allowed size in bytes. */
+    maxBytes: number;
+    /** Optional warning threshold in bytes, below maxBytes, that produces a 'warn' status instead of 'pass'. */
+    warnBytes?: number;
+}
+type SizeSource = Record<string, number>;
+type BudgetStatus = 'pass' | 'warn' | 'fail' | 'missing';
+interface BudgetResult {
+    name: string;
+    actualBytes: number | null;
+    maxBytes: number;
+    warnBytes?: number;
+    status: BudgetStatus;
+    overBytes: number;
+}
+/** Checks a set of budget entries against actual sizes, returning one result per entry. */
+declare function checkBudget(entries: BudgetEntry[], sizes: SizeSource): BudgetResult[];
+/** True if any result has status 'fail' (useful as a CI exit-code gate). */
+declare function hasFailures(results: BudgetResult[]): boolean;
+/** Renders a plain-text summary table, one line per result. */
+declare function formatReport(results: BudgetResult[]): string;
+
+export { type BudgetEntry, type BudgetResult, type BudgetStatus, type SizeSource, checkBudget, formatReport, hasFailures };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+interface BudgetEntry {
+    /** A label or glob-like path identifying the artifact (informational; matching is by SizeSource key). */
+    name: string;
+    /** Maximum allowed size in bytes. */
+    maxBytes: number;
+    /** Optional warning threshold in bytes, below maxBytes, that produces a 'warn' status instead of 'pass'. */
+    warnBytes?: number;
+}
+type SizeSource = Record<string, number>;
+type BudgetStatus = 'pass' | 'warn' | 'fail' | 'missing';
+interface BudgetResult {
+    name: string;
+    actualBytes: number | null;
+    maxBytes: number;
+    warnBytes?: number;
+    status: BudgetStatus;
+    overBytes: number;
+}
+/** Checks a set of budget entries against actual sizes, returning one result per entry. */
+declare function checkBudget(entries: BudgetEntry[], sizes: SizeSource): BudgetResult[];
+/** True if any result has status 'fail' (useful as a CI exit-code gate). */
+declare function hasFailures(results: BudgetResult[]): boolean;
+/** Renders a plain-text summary table, one line per result. */
+declare function formatReport(results: BudgetResult[]): string;
+
+export { type BudgetEntry, type BudgetResult, type BudgetStatus, type SizeSource, checkBudget, formatReport, hasFailures };

package/dist/index.js

@@ -0,0 +1,71 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  checkBudget: () => checkBudget,
+  formatReport: () => formatReport,
+  hasFailures: () => hasFailures
+});
+module.exports = __toCommonJS(index_exports);
+function checkBudget(entries, sizes) {
+  return entries.map((entry) => {
+    const actualBytes = Object.prototype.hasOwnProperty.call(sizes, entry.name) ? sizes[entry.name] : null;
+    if (actualBytes === null) {
+      return { name: entry.name, actualBytes: null, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "missing", overBytes: 0 };
+    }
+    if (actualBytes > entry.maxBytes) {
+      return {
+        name: entry.name,
+        actualBytes,
+        maxBytes: entry.maxBytes,
+        warnBytes: entry.warnBytes,
+        status: "fail",
+        overBytes: actualBytes - entry.maxBytes
+      };
+    }
+    if (entry.warnBytes !== void 0 && actualBytes > entry.warnBytes) {
+      return { name: entry.name, actualBytes, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "warn", overBytes: 0 };
+    }
+    return { name: entry.name, actualBytes, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "pass", overBytes: 0 };
+  });
+}
+function hasFailures(results) {
+  return results.some((r) => r.status === "fail");
+}
+function formatBytes(bytes) {
+  if (bytes < 1024) return `${bytes} B`;
+  return `${(bytes / 1024).toFixed(1)} KB`;
+}
+function formatReport(results) {
+  return results.map((r) => {
+    const actual = r.actualBytes === null ? "MISSING" : formatBytes(r.actualBytes);
+    const budget = formatBytes(r.maxBytes);
+    const marker = r.status === "pass" ? "OK" : r.status.toUpperCase();
+    const overNote = r.overBytes > 0 ? ` (+${formatBytes(r.overBytes)} over)` : "";
+    return `[${marker}] ${r.name}: ${actual} / ${budget}${overNote}`;
+  }).join("\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  checkBudget,
+  formatReport,
+  hasFailures
+});

package/dist/index.mjs

@@ -0,0 +1,44 @@
+// src/index.ts
+function checkBudget(entries, sizes) {
+  return entries.map((entry) => {
+    const actualBytes = Object.prototype.hasOwnProperty.call(sizes, entry.name) ? sizes[entry.name] : null;
+    if (actualBytes === null) {
+      return { name: entry.name, actualBytes: null, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "missing", overBytes: 0 };
+    }
+    if (actualBytes > entry.maxBytes) {
+      return {
+        name: entry.name,
+        actualBytes,
+        maxBytes: entry.maxBytes,
+        warnBytes: entry.warnBytes,
+        status: "fail",
+        overBytes: actualBytes - entry.maxBytes
+      };
+    }
+    if (entry.warnBytes !== void 0 && actualBytes > entry.warnBytes) {
+      return { name: entry.name, actualBytes, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "warn", overBytes: 0 };
+    }
+    return { name: entry.name, actualBytes, maxBytes: entry.maxBytes, warnBytes: entry.warnBytes, status: "pass", overBytes: 0 };
+  });
+}
+function hasFailures(results) {
+  return results.some((r) => r.status === "fail");
+}
+function formatBytes(bytes) {
+  if (bytes < 1024) return `${bytes} B`;
+  return `${(bytes / 1024).toFixed(1)} KB`;
+}
+function formatReport(results) {
+  return results.map((r) => {
+    const actual = r.actualBytes === null ? "MISSING" : formatBytes(r.actualBytes);
+    const budget = formatBytes(r.maxBytes);
+    const marker = r.status === "pass" ? "OK" : r.status.toUpperCase();
+    const overNote = r.overBytes > 0 ? ` (+${formatBytes(r.overBytes)} over)` : "";
+    return `[${marker}] ${r.name}: ${actual} / ${budget}${overNote}`;
+  }).join("\n");
+}
+export {
+  checkBudget,
+  formatReport,
+  hasFailures
+};

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "bundle-budget-lite",
+  "version": "0.1.0",
+  "description": "Checks file sizes against a budget config and reports pass/fail per entry — pluggable size source, no bundler coupling, ideal for CI.",
+  "main": "dist/index.js", "module": "dist/index.mjs", "types": "dist/index.d.ts", "files": ["dist"],
+  "license": "MIT", "author": "Tejas Kadam",
+  "repository": { "type": "git", "url": "git+https://github.com/tejas821/bundle-budget-lite.git" },
+  "keywords": ["bundle-size", "ci", "performance", "typescript"],
+  "scripts": { "build": "tsup src/index.ts --format cjs,esm --dts", "test": "jest", "typecheck": "tsc --noEmit" },
+  "devDependencies": { "typescript": "^5.5.4", "tsup": "^8.2.4", "jest": "^29.7.0", "ts-jest": "^29.2.5", "@types/jest": "^29.5.12" }
+}