@node-cli/bundlesize 4.5.1 → 4.6.0

package/README.md

@@ -215,16 +215,75 @@ export default {
 
 #### Simple report with custom columns
 
+The `columns` option allows you to customize the report table columns. Each column is defined as an object with a key (column identifier) and value (column header text displayed in the table).
+
+**Available column keys:**
+
+| Key      | Description                                          | Default Header |
+| -------- | ---------------------------------------------------- | -------------- |
+| `status` | Shows ✅ if within limit, 🚫 if limit exceeded       | "Status"       |
+| `file`   | Displays the file name or alias                      | "File"         |
+| `size`   | Shows the gzipped size with diff from previous stats | "Size (Gzip)"  |
+| `limits` | Displays the configured size limit                   | "Limits"       |
+
+**Default columns:**
+
+```js
+columns: [
+  { status: "Status" },
+  { file: "File" },
+  { size: "Size (Gzip)" },
+  { limits: "Limits" }
+];
+```
+
+**Customizing column headers:**
+
+You can change the header text while keeping the same column:
+
+```js
+export default {
+  report: {
+    columns: [
+      { status: "✓/✗" },
+      { file: "Bundle" },
+      { size: "Gzip Size" },
+      { limits: "Max" }
+    ],
+    previous: "stats/previous.json",
+    current: "stats/current.json"
+  }
+};
+```
+
+**Removing columns:**
+
+You can remove columns by omitting them from the array:
+
+```js
+export default {
+  report: {
+    columns: [{ file: "File" }, { size: "Size (Gzip)" }],
+    previous: "stats/previous.json",
+    current: "stats/current.json"
+  }
+};
+```
+
+**Reordering columns:**
+
+You can change the column order by rearranging the array:
+
 ```js
 export default {
   report: {
     columns: [
-      { status: "Status" },
       { file: "File" },
-      { size: "Size" },
-      { limits: "Limits" }
+      { status: "Status" },
+      { limits: "Limits" },
+      { size: "Size (Gzip)" }
     ],
-    prev: "stats/previous.json",
+    previous: "stats/previous.json",
     current: "stats/current.json"
   }
 };

package/dist/config.js

@@ -12,8 +12,8 @@
  *   ]
  * });
  * ```
- */ export function defineConfig(config) {
+ */ /* v8 ignore start */ export function defineConfig(config) {
     return config;
-}
+} /* v8 ignore stop */ 
 
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/config.ts"],"sourcesContent":["import type { FooterProperties } from \"./utilities.js\";\n\n/**\n * Configuration for a single file size entry.\n */\nexport interface SizeEntry {\n\t/**\n\t * Path to the file to check. Supports glob patterns.\n\t * Special placeholders:\n\t * - `<hash>`: matches content hashes (e.g., `bundle-<hash>.js`)\n\t * - `<semver>`: matches semantic versions (e.g., `lib-<semver>.js`)\n\t */\n\tpath: string;\n\t/**\n\t * Maximum allowed size for the file (gzipped).\n\t * Format: number followed by unit (B, kB, KB, MB, GB, TB, PB)\n\t * @example \"10 kB\", \"1.5 MB\", \"500 B\"\n\t */\n\tlimit: string;\n\t/**\n\t * Optional alias for the file in reports.\n\t * Useful for giving meaningful names to files with hash patterns.\n\t */\n\talias?: string;\n}\n\n/**\n * Configuration for a header entry (group separator in reports).\n */\nexport interface HeaderEntry {\n\t/**\n\t * Header text to display as a group separator in reports.\n\t */\n\theader: string;\n}\n\n/**\n * Column definition for the report table.\n */\nexport interface ColumnDefinition {\n\t[key: string]: string;\n}\n\n/**\n * Configuration for generating comparison reports.\n */\nexport interface ReportConfiguration {\n\t/**\n\t * Path to the current stats JSON file (relative to config file).\n\t */\n\tcurrent: string;\n\t/**\n\t * Path to the previous stats JSON file for comparison (relative to config file).\n\t */\n\tprevious: string;\n\t/**\n\t * Custom header text for the report.\n\t * @default \"## Bundle Size\"\n\t */\n\theader?: string;\n\t/**\n\t * Custom footer function for the report.\n\t * Receives an object with limitReached, overallDiff, and totalGzipSize.\n\t */\n\tfooter?: (args: FooterProperties) => string;\n\t/**\n\t * Column definitions for the report table.\n\t * @default [{ status: \"Status\" }, { file: \"File\" }, { size: \"Size (Gzip)\" }, { limits: \"Limits\" }]\n\t */\n\tcolumns?: ColumnDefinition[];\n\t/**\n\t * Minimum gzip size change in bytes to consider as a change.\n\t * Changes below this threshold are treated as no change.\n\t * @default 0\n\t */\n\tthreshold?: number;\n}\n\n/**\n * Bundlesize configuration object.\n */\nexport interface BundlesizeConfig {\n\t/**\n\t * Array of file size entries to check.\n\t * Each entry can be either a SizeEntry (file to check) or HeaderEntry (group separator).\n\t */\n\tsizes?: (SizeEntry | HeaderEntry)[];\n\t/**\n\t * Configuration for generating comparison reports.\n\t */\n\treport?: ReportConfiguration;\n}\n\n/**\n * Helper function to define bundlesize configuration with full type support.\n * Provides IntelliSense and type checking for configuration files.\n *\n * @example\n * ```js\n * import { defineConfig } from \"@node-cli/bundlesize\";\n *\n * export default defineConfig({\n *   sizes: [\n *     { path: \"dist/bundle.js\", limit: \"10 kB\" }\n *   ]\n * });\n * ```\n */\nexport function defineConfig(config: BundlesizeConfig): BundlesizeConfig {\n\treturn config;\n}\n"],"names":["defineConfig","config"],"mappings":"AA6FA;;;;;;;;;;;;;;CAcC,GACD,OAAO,SAASA,aAAaC,MAAwB;IACpD,OAAOA;AACR"}
+{"version":3,"sources":["../src/config.ts"],"sourcesContent":["import type { FooterProperties } from \"./utilities.js\";\n\n/**\n * Configuration for a single file size entry.\n */\nexport interface SizeEntry {\n\t/**\n\t * Path to the file to check. Supports glob patterns.\n\t * Special placeholders:\n\t * - `<hash>`: matches content hashes (e.g., `bundle-<hash>.js`)\n\t * - `<semver>`: matches semantic versions (e.g., `lib-<semver>.js`)\n\t */\n\tpath: string;\n\t/**\n\t * Maximum allowed size for the file (gzipped).\n\t * Format: number followed by unit (B, kB, KB, MB, GB, TB, PB)\n\t * @example \"10 kB\", \"1.5 MB\", \"500 B\"\n\t */\n\tlimit: string;\n\t/**\n\t * Optional alias for the file in reports.\n\t * Useful for giving meaningful names to files with hash patterns.\n\t */\n\talias?: string;\n}\n\n/**\n * Configuration for a header entry (group separator in reports).\n */\nexport interface HeaderEntry {\n\t/**\n\t * Header text to display as a group separator in reports.\n\t */\n\theader: string;\n}\n\n/**\n * Column definition for the report table.\n */\nexport interface ColumnDefinition {\n\t[key: string]: string;\n}\n\n/**\n * Configuration for generating comparison reports.\n */\nexport interface ReportConfiguration {\n\t/**\n\t * Path to the current stats JSON file (relative to config file).\n\t */\n\tcurrent: string;\n\t/**\n\t * Path to the previous stats JSON file for comparison (relative to config file).\n\t */\n\tprevious: string;\n\t/**\n\t * Custom header text for the report.\n\t * @default \"## Bundle Size\"\n\t */\n\theader?: string;\n\t/**\n\t * Custom footer function for the report.\n\t * Receives an object with limitReached, overallDiff, and totalGzipSize.\n\t */\n\tfooter?: (args: FooterProperties) => string;\n\t/**\n\t * Column definitions for the report table.\n\t * @default [{ status: \"Status\" }, { file: \"File\" }, { size: \"Size (Gzip)\" }, { limits: \"Limits\" }]\n\t */\n\tcolumns?: ColumnDefinition[];\n\t/**\n\t * Minimum gzip size change in bytes to consider as a change.\n\t * Changes below this threshold are treated as no change.\n\t * @default 0\n\t */\n\tthreshold?: number;\n}\n\n/**\n * Bundlesize configuration object.\n */\nexport interface BundlesizeConfig {\n\t/**\n\t * Array of file size entries to check.\n\t * Each entry can be either a SizeEntry (file to check) or HeaderEntry (group separator).\n\t */\n\tsizes?: (SizeEntry | HeaderEntry)[];\n\t/**\n\t * Configuration for generating comparison reports.\n\t */\n\treport?: ReportConfiguration;\n}\n\n/**\n * Helper function to define bundlesize configuration with full type support.\n * Provides IntelliSense and type checking for configuration files.\n *\n * @example\n * ```js\n * import { defineConfig } from \"@node-cli/bundlesize\";\n *\n * export default defineConfig({\n *   sizes: [\n *     { path: \"dist/bundle.js\", limit: \"10 kB\" }\n *   ]\n * });\n * ```\n */\n/* v8 ignore start */\nexport function defineConfig(config: BundlesizeConfig): BundlesizeConfig {\n\treturn config;\n}\n/* v8 ignore stop */\n"],"names":["defineConfig","config"],"mappings":"AA6FA;;;;;;;;;;;;;;CAcC,GACD,mBAAmB,GACnB,OAAO,SAASA,aAAaC,MAAwB;IACpD,OAAOA;AACR,EACA,kBAAkB"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/bundlesize",
-	"version": "4.5.1",
+	"version": "4.6.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "Simple CLI tool that checks file(s) size and report if limits have been reached",
@@ -35,20 +35,20 @@
 		"watch": "swc --strip-leading-paths --watch --out-dir dist src"
 	},
 	"dependencies": {
-		"@node-cli/logger": "1.3.2",
-		"@node-cli/parser": "2.4.3",
+		"@node-cli/logger": "1.3.3",
+		"@node-cli/parser": "2.4.4",
 		"bytes": "3.1.2",
-		"fs-extra": "11.3.1",
-		"glob": "11.0.3",
-		"semver": "7.7.2"
+		"fs-extra": "11.3.3",
+		"glob": "13.0.0",
+		"semver": "7.7.3"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
 	"devDependencies": {
-		"@node-cli/comments": "0.2.6",
-		"@vitest/coverage-v8": "3.2.4",
-		"vitest": "3.2.4"
+		"@node-cli/comments": "0.2.8",
+		"@vitest/coverage-v8": "4.0.16",
+		"vitest": "4.0.16"
 	},
-	"gitHead": "b19e02fcb4745190530c693093fe87a5af5517bf"
+	"gitHead": "81c697fb358e4341ae58e5750f7f9503943e4686"
 }