tonnage 0.1.2 → 0.2.0

package/AGENTS.md

@@ -8,3 +8,5 @@ CI-first runtime JavaScript bundle measurement with checked-in README reports.
 - Peer dependencies stay external by default. Use explicit `external` entries only for additional dependencies intentionally supplied by consumers.
 - Run `tonnage write` to update a generated README section and `tonnage check` in CI to detect drift.
 - Keep marker names stable and use the `tonnage:<name>:start` and `tonnage:<name>:end` comment forms.
+- For a galley.md document, import `Tonnage` from `tonnage/galley`. Its config paths default to the containing document's directory. The component measures and renders a report without writing a README or requiring section markers.
+- Await `renderTonnageMarkdown(report, config)` when using the programmatic API. CLI reports and document components share Galley's table rendering, escaping literal text and aligning byte columns to the right.

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # tonnage
 
+## 0.2.0
+
+### Minor Changes
+
+- 0521e43: Render reports through galley.md 0.1.1 native table elements and expose a Tonnage component from tonnage/galley for MDX documents. Galley is now a runtime dependency, renderTonnageMarkdown returns a Promise and must be awaited, and inline code and table text use Galley's Markdown escaping and column alignment.
+
+## 0.1.3
+
+### Patch Changes
+
+- 9866ade: Upgrade comline, pass full runtime argv, add command and config-path completion with shell installation commands, and report ignored-option warnings on stderr while preserving asynchronous config loading.
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -15,11 +15,43 @@ per bundle.
 Add the generated-section comments to the target README, then create a config
 beside the package manifest. The complete configuration exhibit is in
 [examples/tonnage.config.ts](./examples/tonnage.config.ts).
+
+```ts
+import { defineConfig, type TonnageConfig } from "tonnage"
+
+// @exhibit-region start config
+const config: TonnageConfig = defineConfig({
+	exports: {
+		exclude: [`./package.json`],
+	},
+	marker: `my-package`,
+	recipes: [
+		{
+			entry: `examples/recipes/react-app.ts`,
+			name: `React app`,
+			platform: `browser`,
+		},
+	],
+})
+
+export default config
+// @exhibit-region end config
+
+```
+
 Each recipe points to a reviewable entry file such as
 [examples/recipes/react-app.ts](./examples/recipes/react-app.ts). Use named
 imports in these files to represent the runtime surface a real application uses;
 unused package exports are tree-shaken.
 
+```ts
+// @exhibit-region start recipe
+export { atom } from "my-package"
+export { useO } from "my-package/react"
+// @exhibit-region end recipe
+
+```
+
 The default generated-section marker is `default`; the example uses `my-package`.
 The opening and closing comments use the forms
 `tonnage:my-package:start` and `tonnage:my-package:end`.
@@ -31,12 +63,43 @@ Run `tonnage write` during development to update the README. Run
 nonzero when the README is stale. Run `tonnage --help` to see both commands and
 their optional config-path arguments.
 
+Pass a config path with `tonnage check path/to/tonnage.config.ts` or
+`tonnage write path/to/tonnage.config.ts`. Otherwise, Tonnage looks in the current
+directory for `tonnage.config.ts`, then `tonnage.config.mjs`, then
+`tonnage.config.js`. Config modules may use top-level `await`. Missing configs
+are errors. Use `--` before a config path that starts with a dash.
+
+Unknown options are ignored with warnings on stderr. Warnings do not change the
+exit status; `check` still exits nonzero when the report is stale.
+
 By default the tool reads `package.json`, writes `README.md`, and measures every
 public export except `./package.json`. Paths are resolved relative to the config
 file. Use `exports.include` or `exports.exclude` to select subpaths, recipe entry
 files to describe realistic runtime boundaries, and `external` for non-peer
 imports that the package intentionally leaves to its consumers.
 
+### Shell completion
+
+With `tonnage` available on your shell's `PATH`, install completion for your shell:
+
+```sh
+tonnage completion install bash
+tonnage completion install zsh
+tonnage completion install fish
+tonnage completion install nushell
+tonnage completion install carapace
+```
+
+Choose the integration you use. Completion suggests commands, help options, and
+config paths without loading your config or measuring bundles. Installation
+checks the shell's prerequisites and writes to its completion directory without
+editing shell profiles. It reports any setup needed for your shell. If Nushell
+already uses Carapace, install only the Carapace integration.
+
+Run `tonnage completion bash` (or another target above) to print the integration
+file without installing it. The `completion` command and comline's internal
+completion protocol commands are reserved for shell integration.
+
 ## Report layout
 
 Generated reports adapt to the measurements they contain. An exports-only or
@@ -50,6 +113,23 @@ JavaScript bytes, with declarations, source maps, CSS, and other assets excluded
 Peer dependencies remain external, and shared modules are counted once in each
 bundle.
 
+Reports use Galley's native table elements, with right-aligned byte columns and
+literal escaping for import names, entry paths, and recipe labels.
+
+For programmatic use, await both measurement and Markdown rendering:
+
+```ts
+import {
+	createTonnageReport,
+	defineConfig,
+	renderTonnageMarkdown,
+} from "tonnage"
+
+const config = defineConfig({ platform: "node" })
+const report = await createTonnageReport(config, process.cwd())
+const markdown = await renderTonnageMarkdown(report, config)
+```
+
 ## Package resolution and platforms
 
 Tonnage resolves the package's own public import name from the manifest selected
@@ -67,3 +147,32 @@ commonly fall through to their `default` target. Set `platform` to `browser` or
 `node` when that runtime is what you want to measure; those choices retain
 esbuild's native export conditions and main-field behavior. A recipe's
 `platform` overrides the report-wide setting for that recipe.
+
+## MDX documents
+
+Use [galley.md](https://www.npmjs.com/package/galley.md) to compose a README from source examples and reports:
+
+```mdx
+import { Tonnage } from "tonnage/galley"
+import config from "./tonnage.config.ts"
+import Example from "./examples/recipes/react-app.ts" with { type: "code", lang: "ts" }
+
+<Example />
+
+<Tonnage config={config} />
+```
+
+The component resolves paths relative to the containing document. Pass `directory` to measure another package. It produces the same tables as the CLI without writing a README or requiring generated-section markers. Tonnage includes Galley as a runtime dependency; add `galley.md` directly to your project's development dependencies to run `galley write` and `galley check` when authoring documents.
+
+## Bundle size
+
+Package export sizes include complete runtime export surfaces.
+
+Sizes are exact minified and level-9 gzip JavaScript byte counts. Declarations, source maps, CSS, and other assets are excluded. Peer dependencies stay external, and shared modules are counted once per bundle.
+
+| Import           | Minified JS |   Gzip JS |
+| ---------------- | ----------: | --------: |
+| `tonnage`        |   491,915 B | 153,965 B |
+| `tonnage/galley` |   484,581 B | 151,561 B |
+
+Report maintained with [tonnage](https://github.com/jeremybanka/tonnage).

package/README.mdx

@@ -0,0 +1,143 @@
+import { Tonnage } from "tonnage/galley"
+import Configuration from "./examples/tonnage.config.ts" with { type: "code", lang: "ts" }
+import Recipe from "./examples/recipes/react-app.ts" with { type: "code", lang: "ts" }
+
+# tonnage
+
+Keep exact bundle size tables in a package README and fail CI when the checked-in
+numbers drift.
+
+The tool bundles real public package imports with esbuild, minifies the result,
+and reports JavaScript bytes before and after level-9 gzip. Public-module rows
+retain every runtime export; recipe entry files can select named exports and
+tree-shake the rest. Declarations, source maps, CSS, and other assets are not
+counted. Peer dependencies stay external, and shared modules are counted once
+per bundle.
+
+## Configure
+
+Add the generated-section comments to the target README, then create a config
+beside the package manifest. The complete configuration exhibit is in
+[examples/tonnage.config.ts](./examples/tonnage.config.ts).
+<Configuration />
+
+Each recipe points to a reviewable entry file such as
+[examples/recipes/react-app.ts](./examples/recipes/react-app.ts). Use named
+imports in these files to represent the runtime surface a real application uses;
+unused package exports are tree-shaken.
+
+<Recipe />
+
+The default generated-section marker is `default`; the example uses `my-package`.
+The opening and closing comments use the forms
+`tonnage:my-package:start` and `tonnage:my-package:end`.
+
+## Run
+
+Run `tonnage write` during development to update the README. Run
+`tonnage check` in CI to recompute the same report without writing and exit
+nonzero when the README is stale. Run `tonnage --help` to see both commands and
+their optional config-path arguments.
+
+Pass a config path with `tonnage check path/to/tonnage.config.ts` or
+`tonnage write path/to/tonnage.config.ts`. Otherwise, Tonnage looks in the current
+directory for `tonnage.config.ts`, then `tonnage.config.mjs`, then
+`tonnage.config.js`. Config modules may use top-level `await`. Missing configs
+are errors. Use `--` before a config path that starts with a dash.
+
+Unknown options are ignored with warnings on stderr. Warnings do not change the
+exit status; `check` still exits nonzero when the report is stale.
+
+By default the tool reads `package.json`, writes `README.md`, and measures every
+public export except `./package.json`. Paths are resolved relative to the config
+file. Use `exports.include` or `exports.exclude` to select subpaths, recipe entry
+files to describe realistic runtime boundaries, and `external` for non-peer
+imports that the package intentionally leaves to its consumers.
+
+### Shell completion
+
+With `tonnage` available on your shell's `PATH`, install completion for your shell:
+
+```sh
+tonnage completion install bash
+tonnage completion install zsh
+tonnage completion install fish
+tonnage completion install nushell
+tonnage completion install carapace
+```
+
+Choose the integration you use. Completion suggests commands, help options, and
+config paths without loading your config or measuring bundles. Installation
+checks the shell's prerequisites and writes to its completion directory without
+editing shell profiles. It reports any setup needed for your shell. If Nushell
+already uses Carapace, install only the Carapace integration.
+
+Run `tonnage completion bash` (or another target above) to print the integration
+file without installing it. The `completion` command and comline's internal
+completion protocol commands are reserved for shell integration.
+
+## Report layout
+
+Generated reports adapt to the measurements they contain. An exports-only or
+recipes-only report puts its table directly below the configured report heading
+and describes only that type of measurement. A report with both types labels the
+tables `Package exports` and `Usage examples` so readers can distinguish complete
+runtime export surfaces from tree-shaken recipe bundles.
+
+Every layout states the exact measurement semantics: minified and level-9 gzip
+JavaScript bytes, with declarations, source maps, CSS, and other assets excluded.
+Peer dependencies remain external, and shared modules are counted once in each
+bundle.
+
+Reports use Galley's native table elements, with right-aligned byte columns and
+literal escaping for import names, entry paths, and recipe labels.
+
+For programmatic use, await both measurement and Markdown rendering:
+
+```ts
+import {
+	createTonnageReport,
+	defineConfig,
+	renderTonnageMarkdown,
+} from "tonnage"
+
+const config = defineConfig({ platform: "node" })
+const report = await createTonnageReport(config, process.cwd())
+const markdown = await renderTonnageMarkdown(report, config)
+```
+
+## Package resolution and platforms
+
+Tonnage resolves the package's own public import name from the manifest selected
+by `packageJson`; a workspace package does not need to install or declare itself
+as a dependency. Root and subpath imports still go through esbuild's package
+resolver, so the manifest's `exports` restrictions and conditions apply. Runtime
+dependencies resolve from the measured package, while its peer dependencies stay
+external.
+
+The default `platform` is `neutral`. For packages without `exports`, Tonnage
+configures neutral resolution to try the `module` field and then `main`, so
+main-only packages and dependencies are actionable by default. With conditional
+`exports`, neutral does not enable the `browser` or `node` condition, so exports
+commonly fall through to their `default` target. Set `platform` to `browser` or
+`node` when that runtime is what you want to measure; those choices retain
+esbuild's native export conditions and main-field behavior. A recipe's
+`platform` overrides the report-wide setting for that recipe.
+
+## MDX documents
+
+Use [galley.md](https://www.npmjs.com/package/galley.md) to compose a README from source examples and reports:
+
+```mdx
+import { Tonnage } from "tonnage/galley"
+import config from "./tonnage.config.ts"
+import Example from "./examples/recipes/react-app.ts" with { type: "code", lang: "ts" }
+
+<Example />
+
+<Tonnage config={config} />
+```
+
+The component resolves paths relative to the containing document. Pass `directory` to measure another package. It produces the same tables as the CLI without writing a README or requiring generated-section markers. Tonnage includes Galley as a runtime dependency; add `galley.md` directly to your project's development dependencies to run `galley write` and `galley check` when authoring documents.
+
+<Tonnage config={{ platform: "node", exports: { include: [".", "./galley"] } }} />

package/dist/cli.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
-import { t as runTonnage } from "./run-CZ_FO4C7.mjs";
+import { t as runTonnage } from "./run-BJN1MXRf.mjs";
 import fs from "node:fs/promises";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
-import { cli, help, helpOption, optional } from "comline";
+import { cli, completionResponse, help, helpOption, logWarnings, optional } from "comline";
 //#region src/command-line.ts
 const ROOT_MANUAL = helpOption(`Show help for the tonnage command line.`);
 const WRITE_MANUAL = helpOption(`Update the configured README report.`);
@@ -22,20 +22,32 @@ const tonnageCli = cli({
 		write: WRITE_MANUAL,
 		"write/$configPath": WRITE_MANUAL
 	},
+	positionalCompletions: {
+		"check/$configPath": { fileSystem: `files` },
+		"write/$configPath": { fileSystem: `files` }
+	},
 	discoverConfigPath: () => void 0
 });
+function completeTonnageCli(args) {
+	return completionResponse(tonnageCli.definition, args);
+}
 function parseTonnageCli(args) {
-	const { inputs } = tonnageCli(args);
-	if (inputs.case === `` || inputs.opts.help) return { kind: `help` };
+	const { inputs, warnings } = tonnageCli(args);
+	if (inputs.case === `` || inputs.opts.help) return {
+		kind: `help`,
+		warnings
+	};
 	const mode = inputs.case === `write` || inputs.case === `write/$configPath` ? `write` : `check`;
 	const configArgument = inputs.path[1];
 	return configArgument === void 0 ? {
 		kind: `run`,
-		mode
+		mode,
+		warnings
 	} : {
 		configArgument,
 		kind: `run`,
-		mode
+		mode,
+		warnings
 	};
 }
 function renderTonnageCliHelp() {
@@ -49,7 +61,13 @@ const DEFAULT_CONFIG_FILES = [
 	`tonnage.config.js`
 ];
 async function main() {
-	const invocation = parseTonnageCli([`tonnage`, ...process.argv.slice(2)]);
+	const completion = await completeTonnageCli(process.argv);
+	if (completion !== void 0) {
+		process.stdout.write(completion);
+		return;
+	}
+	const invocation = parseTonnageCli(process.argv);
+	logWarnings(invocation.warnings);
 	if (invocation.kind === `help`) {
 		process.stdout.write(renderTonnageCliHelp());
 		return;

package/dist/cli.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"cli.mjs","names":[],"sources":["../src/command-line.ts","../src/cli.ts"],"sourcesContent":["import { cli, help, helpOption, optional } from \"comline\"\n\nimport type { TonnageMode } from \"./types.ts\"\n\nconst ROOT_MANUAL = helpOption(`Show help for the tonnage command line.`)\nconst WRITE_MANUAL = helpOption(`Update the configured README report.`)\nconst CHECK_MANUAL = helpOption(\n\t`Check that the configured README report is up to date.`,\n)\n\nconst tonnageCli = cli({\n\tcliName: `tonnage`,\n\tcliDescription: `Keep deterministic bundle size reports in README files and CI.`,\n\troutes: optional({\n\t\tcheck: optional({ $configPath: null }),\n\t\twrite: optional({ $configPath: null }),\n\t}),\n\trouteOptions: {\n\t\t\"\": ROOT_MANUAL,\n\t\tcheck: CHECK_MANUAL,\n\t\t\"check/$configPath\": CHECK_MANUAL,\n\t\twrite: WRITE_MANUAL,\n\t\t\"write/$configPath\": WRITE_MANUAL,\n\t},\n\tdiscoverConfigPath: () => undefined,\n})\n\nexport type TonnageCliInvocation =\n\t| { kind: `help` }\n\t| { configArgument?: string; kind: `run`; mode: TonnageMode }\n\nexport function parseTonnageCli(args: string[]): TonnageCliInvocation {\n\tconst { inputs } = tonnageCli(args)\n\n\tif (inputs.case === `` || inputs.opts.help) {\n\t\treturn { kind: `help` }\n\t}\n\n\tconst mode =\n\t\tinputs.case === `write` || inputs.case === `write/$configPath`\n\t\t\t? `write`\n\t\t\t: `check`\n\tconst configArgument = inputs.path[1]\n\n\treturn configArgument === undefined\n\t\t? { kind: `run`, mode }\n\t\t: { configArgument, kind: `run`, mode }\n}\n\nexport function renderTonnageCliHelp(): string {\n\treturn help(tonnageCli.definition)\n}\n","#!/usr/bin/env node\n\nimport fs from \"node:fs/promises\"\nimport path from \"node:path\"\nimport { pathToFileURL } from \"node:url\"\n\nimport { parseTonnageCli, renderTonnageCliHelp } from \"./command-line.ts\"\nimport { runTonnage } from \"./run.ts\"\nimport type { TonnageConfig } from \"./types.ts\"\n\nconst DEFAULT_CONFIG_FILES = [\n\t`tonnage.config.ts`,\n\t`tonnage.config.mjs`,\n\t`tonnage.config.js`,\n]\n\nasync function main(): Promise<void> {\n\tconst invocation = parseTonnageCli([`tonnage`, ...process.argv.slice(2)])\n\tif (invocation.kind === `help`) {\n\t\tprocess.stdout.write(renderTonnageCliHelp())\n\t\treturn\n\t}\n\n\tconst { configArgument, mode } = invocation\n\tconst configPath = await findConfig(configArgument)\n\tconst config = await loadConfig(configPath)\n\tconst result = await runTonnage(config, {\n\t\tconfigDirectory: path.dirname(configPath),\n\t\tmode,\n\t})\n\n\tif (mode === `check` && result.changed) {\n\t\tprocess.stderr.write(\n\t\t\t`${path.relative(process.cwd(), result.readmePath)} is out of date. Run tonnage write.\\n`,\n\t\t)\n\t\tprocess.exitCode = 1\n\t\treturn\n\t}\n\n\tconst readme = path.relative(process.cwd(), result.readmePath)\n\tprocess.stdout.write(\n\t\tresult.changed\n\t\t\t? `Updated ${readme}.\\n`\n\t\t\t: `${readme} is already up to date.\\n`,\n\t)\n}\n\nasync function findConfig(configArgument: string | undefined): Promise<string> {\n\tif (configArgument) {\n\t\treturn path.resolve(configArgument)\n\t}\n\n\tfor (const filename of DEFAULT_CONFIG_FILES) {\n\t\tconst candidate = path.resolve(filename)\n\t\ttry {\n\t\t\tawait fs.access(candidate)\n\t\t\treturn candidate\n\t\t} catch {\n\t\t\t// Keep looking for the next supported config filename.\n\t\t}\n\t}\n\n\tthrow new Error(\n\t\t`Could not find a tonnage config (${DEFAULT_CONFIG_FILES.join(`, `)}).`,\n\t)\n}\n\nasync function loadConfig(configPath: string): Promise<TonnageConfig> {\n\tconst imported = (await import(pathToFileURL(configPath).href)) as {\n\t\tdefault?: unknown\n\t}\n\tif (!imported.default || typeof imported.default !== `object`) {\n\t\tthrow new Error(`${configPath} must default-export a tonnage config.`)\n\t}\n\treturn imported.default\n}\n\nmain().catch((error: unknown) => {\n\tprocess.stderr.write(\n\t\t`${error instanceof Error ? error.message : String(error)}\\n`,\n\t)\n\tprocess.exitCode = 1\n})\n"],"mappings":";;;;;;;AAIA,MAAM,cAAc,WAAW,yCAAyC;AACxE,MAAM,eAAe,WAAW,sCAAsC;AACtE,MAAM,eAAe,WACpB,wDACD;AAEA,MAAM,aAAa,IAAI;CACtB,SAAS;CACT,gBAAgB;CAChB,QAAQ,SAAS;EAChB,OAAO,SAAS,EAAE,aAAa,KAAK,CAAC;EACrC,OAAO,SAAS,EAAE,aAAa,KAAK,CAAC;CACtC,CAAC;CACD,cAAc;EACb,IAAI;EACJ,OAAO;EACP,qBAAqB;EACrB,OAAO;EACP,qBAAqB;CACtB;CACA,0BAA0B,KAAA;AAC3B,CAAC;AAMD,SAAgB,gBAAgB,MAAsC;CACrE,MAAM,EAAE,WAAW,WAAW,IAAI;CAElC,IAAI,OAAO,SAAS,MAAM,OAAO,KAAK,MACrC,OAAO,EAAE,MAAM,OAAO;CAGvB,MAAM,OACL,OAAO,SAAS,WAAW,OAAO,SAAS,sBACxC,UACA;CACJ,MAAM,iBAAiB,OAAO,KAAK;CAEnC,OAAO,mBAAmB,KAAA,IACvB;EAAE,MAAM;EAAO;CAAK,IACpB;EAAE;EAAgB,MAAM;EAAO;CAAK;AACxC;AAEA,SAAgB,uBAA+B;CAC9C,OAAO,KAAK,WAAW,UAAU;AAClC;;;ACzCA,MAAM,uBAAuB;CAC5B;CACA;CACA;AACD;AAEA,eAAe,OAAsB;CACpC,MAAM,aAAa,gBAAgB,CAAC,WAAW,GAAG,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC;CACxE,IAAI,WAAW,SAAS,QAAQ;EAC/B,QAAQ,OAAO,MAAM,qBAAqB,CAAC;EAC3C;CACD;CAEA,MAAM,EAAE,gBAAgB,SAAS;CACjC,MAAM,aAAa,MAAM,WAAW,cAAc;CAClD,MAAM,SAAS,MAAM,WAAW,UAAU;CAC1C,MAAM,SAAS,MAAM,WAAW,QAAQ;EACvC,iBAAiB,KAAK,QAAQ,UAAU;EACxC;CACD,CAAC;CAED,IAAI,SAAS,WAAW,OAAO,SAAS;EACvC,QAAQ,OAAO,MACd,GAAG,KAAK,SAAS,QAAQ,IAAI,GAAG,OAAO,UAAU,EAAE,sCACpD;EACA,QAAQ,WAAW;EACnB;CACD;CAEA,MAAM,SAAS,KAAK,SAAS,QAAQ,IAAI,GAAG,OAAO,UAAU;CAC7D,QAAQ,OAAO,MACd,OAAO,UACJ,WAAW,OAAO,OAClB,GAAG,OAAO,0BACd;AACD;AAEA,eAAe,WAAW,gBAAqD;CAC9E,IAAI,gBACH,OAAO,KAAK,QAAQ,cAAc;CAGnC,KAAK,MAAM,YAAY,sBAAsB;EAC5C,MAAM,YAAY,KAAK,QAAQ,QAAQ;EACvC,IAAI;GACH,MAAM,GAAG,OAAO,SAAS;GACzB,OAAO;EACR,QAAQ,CAER;CACD;CAEA,MAAM,IAAI,MACT,oCAAoC,qBAAqB,KAAK,IAAI,EAAE,GACrE;AACD;AAEA,eAAe,WAAW,YAA4C;CACrE,MAAM,WAAY,MAAM,OAAO,cAAc,UAAU,CAAC,CAAC;CAGzD,IAAI,CAAC,SAAS,WAAW,OAAO,SAAS,YAAY,UACpD,MAAM,IAAI,MAAM,GAAG,WAAW,uCAAuC;CAEtE,OAAO,SAAS;AACjB;AAEA,KAAK,CAAC,CAAC,OAAO,UAAmB;CAChC,QAAQ,OAAO,MACd,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,GAC3D;CACA,QAAQ,WAAW;AACpB,CAAC"}
+{"version":3,"file":"cli.mjs","names":[],"sources":["../src/command-line.ts","../src/cli.ts"],"sourcesContent":["import {\n\ttype CliWarning,\n\tcli,\n\tcompletionResponse,\n\thelp,\n\thelpOption,\n\toptional,\n} from \"comline\"\n\nimport type { TonnageMode } from \"./types.ts\"\n\nconst ROOT_MANUAL = helpOption(`Show help for the tonnage command line.`)\nconst WRITE_MANUAL = helpOption(`Update the configured README report.`)\nconst CHECK_MANUAL = helpOption(\n\t`Check that the configured README report is up to date.`,\n)\n\nconst tonnageCli = cli({\n\tcliName: `tonnage`,\n\tcliDescription: `Keep deterministic bundle size reports in README files and CI.`,\n\troutes: optional({\n\t\tcheck: optional({ $configPath: null }),\n\t\twrite: optional({ $configPath: null }),\n\t}),\n\trouteOptions: {\n\t\t\"\": ROOT_MANUAL,\n\t\tcheck: CHECK_MANUAL,\n\t\t\"check/$configPath\": CHECK_MANUAL,\n\t\twrite: WRITE_MANUAL,\n\t\t\"write/$configPath\": WRITE_MANUAL,\n\t},\n\tpositionalCompletions: {\n\t\t\"check/$configPath\": { fileSystem: `files` },\n\t\t\"write/$configPath\": { fileSystem: `files` },\n\t},\n\tdiscoverConfigPath: () => undefined,\n})\n\nexport type TonnageCliInvocation = { warnings: CliWarning[] } & (\n\t| { kind: `help` }\n\t| { configArgument?: string; kind: `run`; mode: TonnageMode }\n)\n\nexport function completeTonnageCli(\n\targs: string[],\n): Promise<string | undefined> {\n\treturn completionResponse(tonnageCli.definition, args)\n}\n\nexport function parseTonnageCli(args: string[]): TonnageCliInvocation {\n\tconst { inputs, warnings } = tonnageCli(args)\n\n\tif (inputs.case === `` || inputs.opts.help) {\n\t\treturn { kind: `help`, warnings }\n\t}\n\n\tconst mode =\n\t\tinputs.case === `write` || inputs.case === `write/$configPath`\n\t\t\t? `write`\n\t\t\t: `check`\n\tconst configArgument = inputs.path[1]\n\n\treturn configArgument === undefined\n\t\t? { kind: `run`, mode, warnings }\n\t\t: { configArgument, kind: `run`, mode, warnings }\n}\n\nexport function renderTonnageCliHelp(): string {\n\treturn help(tonnageCli.definition)\n}\n","#!/usr/bin/env node\n\nimport fs from \"node:fs/promises\"\nimport path from \"node:path\"\nimport { pathToFileURL } from \"node:url\"\n\nimport { logWarnings } from \"comline\"\n\nimport {\n\tcompleteTonnageCli,\n\tparseTonnageCli,\n\trenderTonnageCliHelp,\n} from \"./command-line.ts\"\nimport { runTonnage } from \"./run.ts\"\nimport type { TonnageConfig } from \"./types.ts\"\n\nconst DEFAULT_CONFIG_FILES = [\n\t`tonnage.config.ts`,\n\t`tonnage.config.mjs`,\n\t`tonnage.config.js`,\n]\n\nasync function main(): Promise<void> {\n\tconst completion = await completeTonnageCli(process.argv)\n\tif (completion !== undefined) {\n\t\tprocess.stdout.write(completion)\n\t\treturn\n\t}\n\n\tconst invocation = parseTonnageCli(process.argv)\n\tlogWarnings(invocation.warnings)\n\tif (invocation.kind === `help`) {\n\t\tprocess.stdout.write(renderTonnageCliHelp())\n\t\treturn\n\t}\n\n\tconst { configArgument, mode } = invocation\n\tconst configPath = await findConfig(configArgument)\n\tconst config = await loadConfig(configPath)\n\tconst result = await runTonnage(config, {\n\t\tconfigDirectory: path.dirname(configPath),\n\t\tmode,\n\t})\n\n\tif (mode === `check` && result.changed) {\n\t\tprocess.stderr.write(\n\t\t\t`${path.relative(process.cwd(), result.readmePath)} is out of date. Run tonnage write.\\n`,\n\t\t)\n\t\tprocess.exitCode = 1\n\t\treturn\n\t}\n\n\tconst readme = path.relative(process.cwd(), result.readmePath)\n\tprocess.stdout.write(\n\t\tresult.changed\n\t\t\t? `Updated ${readme}.\\n`\n\t\t\t: `${readme} is already up to date.\\n`,\n\t)\n}\n\nasync function findConfig(configArgument: string | undefined): Promise<string> {\n\tif (configArgument) {\n\t\treturn path.resolve(configArgument)\n\t}\n\n\tfor (const filename of DEFAULT_CONFIG_FILES) {\n\t\tconst candidate = path.resolve(filename)\n\t\ttry {\n\t\t\tawait fs.access(candidate)\n\t\t\treturn candidate\n\t\t} catch {\n\t\t\t// Keep looking for the next supported config filename.\n\t\t}\n\t}\n\n\tthrow new Error(\n\t\t`Could not find a tonnage config (${DEFAULT_CONFIG_FILES.join(`, `)}).`,\n\t)\n}\n\nasync function loadConfig(configPath: string): Promise<TonnageConfig> {\n\tconst imported = (await import(pathToFileURL(configPath).href)) as {\n\t\tdefault?: unknown\n\t}\n\tif (!imported.default || typeof imported.default !== `object`) {\n\t\tthrow new Error(`${configPath} must default-export a tonnage config.`)\n\t}\n\treturn imported.default\n}\n\nmain().catch((error: unknown) => {\n\tprocess.stderr.write(\n\t\t`${error instanceof Error ? error.message : String(error)}\\n`,\n\t)\n\tprocess.exitCode = 1\n})\n"],"mappings":";;;;;;;AAWA,MAAM,cAAc,WAAW,yCAAyC;AACxE,MAAM,eAAe,WAAW,sCAAsC;AACtE,MAAM,eAAe,WACpB,wDACD;AAEA,MAAM,aAAa,IAAI;CACtB,SAAS;CACT,gBAAgB;CAChB,QAAQ,SAAS;EAChB,OAAO,SAAS,EAAE,aAAa,KAAK,CAAC;EACrC,OAAO,SAAS,EAAE,aAAa,KAAK,CAAC;CACtC,CAAC;CACD,cAAc;EACb,IAAI;EACJ,OAAO;EACP,qBAAqB;EACrB,OAAO;EACP,qBAAqB;CACtB;CACA,uBAAuB;EACtB,qBAAqB,EAAE,YAAY,QAAQ;EAC3C,qBAAqB,EAAE,YAAY,QAAQ;CAC5C;CACA,0BAA0B,KAAA;AAC3B,CAAC;AAOD,SAAgB,mBACf,MAC8B;CAC9B,OAAO,mBAAmB,WAAW,YAAY,IAAI;AACtD;AAEA,SAAgB,gBAAgB,MAAsC;CACrE,MAAM,EAAE,QAAQ,aAAa,WAAW,IAAI;CAE5C,IAAI,OAAO,SAAS,MAAM,OAAO,KAAK,MACrC,OAAO;EAAE,MAAM;EAAQ;CAAS;CAGjC,MAAM,OACL,OAAO,SAAS,WAAW,OAAO,SAAS,sBACxC,UACA;CACJ,MAAM,iBAAiB,OAAO,KAAK;CAEnC,OAAO,mBAAmB,KAAA,IACvB;EAAE,MAAM;EAAO;EAAM;CAAS,IAC9B;EAAE;EAAgB,MAAM;EAAO;EAAM;CAAS;AAClD;AAEA,SAAgB,uBAA+B;CAC9C,OAAO,KAAK,WAAW,UAAU;AAClC;;;ACrDA,MAAM,uBAAuB;CAC5B;CACA;CACA;AACD;AAEA,eAAe,OAAsB;CACpC,MAAM,aAAa,MAAM,mBAAmB,QAAQ,IAAI;CACxD,IAAI,eAAe,KAAA,GAAW;EAC7B,QAAQ,OAAO,MAAM,UAAU;EAC/B;CACD;CAEA,MAAM,aAAa,gBAAgB,QAAQ,IAAI;CAC/C,YAAY,WAAW,QAAQ;CAC/B,IAAI,WAAW,SAAS,QAAQ;EAC/B,QAAQ,OAAO,MAAM,qBAAqB,CAAC;EAC3C;CACD;CAEA,MAAM,EAAE,gBAAgB,SAAS;CACjC,MAAM,aAAa,MAAM,WAAW,cAAc;CAClD,MAAM,SAAS,MAAM,WAAW,UAAU;CAC1C,MAAM,SAAS,MAAM,WAAW,QAAQ;EACvC,iBAAiB,KAAK,QAAQ,UAAU;EACxC;CACD,CAAC;CAED,IAAI,SAAS,WAAW,OAAO,SAAS;EACvC,QAAQ,OAAO,MACd,GAAG,KAAK,SAAS,QAAQ,IAAI,GAAG,OAAO,UAAU,EAAE,sCACpD;EACA,QAAQ,WAAW;EACnB;CACD;CAEA,MAAM,SAAS,KAAK,SAAS,QAAQ,IAAI,GAAG,OAAO,UAAU;CAC7D,QAAQ,OAAO,MACd,OAAO,UACJ,WAAW,OAAO,OAClB,GAAG,OAAO,0BACd;AACD;AAEA,eAAe,WAAW,gBAAqD;CAC9E,IAAI,gBACH,OAAO,KAAK,QAAQ,cAAc;CAGnC,KAAK,MAAM,YAAY,sBAAsB;EAC5C,MAAM,YAAY,KAAK,QAAQ,QAAQ;EACvC,IAAI;GACH,MAAM,GAAG,OAAO,SAAS;GACzB,OAAO;EACR,QAAQ,CAER;CACD;CAEA,MAAM,IAAI,MACT,oCAAoC,qBAAqB,KAAK,IAAI,EAAE,GACrE;AACD;AAEA,eAAe,WAAW,YAA4C;CACrE,MAAM,WAAY,MAAM,OAAO,cAAc,UAAU,CAAC,CAAC;CAGzD,IAAI,CAAC,SAAS,WAAW,OAAO,SAAS,YAAY,UACpD,MAAM,IAAI,MAAM,GAAG,WAAW,uCAAuC;CAEtE,OAAO,SAAS;AACjB;AAEA,KAAK,CAAC,CAAC,OAAO,UAAmB;CAChC,QAAQ,OAAO,MACd,GAAG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,EAAE,GAC3D;CACA,QAAQ,WAAW;AACpB,CAAC"}

package/dist/galley.d.mts

@@ -0,0 +1,12 @@
+import { r as TonnageConfig } from "./types-Ddtp95Z3.mjs";
+import { DocumentContext, Element } from "galley.md";
+//#region src/galley.d.ts
+export type TonnageProps = {
+  config?: TonnageConfig;
+  /** Override the document directory when measuring a different package. */
+  directory?: string;
+};
+/** Measure bundles and include the report in a galley.md document. */
+export declare function Tonnage({ config, directory }: TonnageProps, context: DocumentContext): Promise<Element[]>;
+//#endregion
+//# sourceMappingURL=galley.d.mts.map

package/dist/galley.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"galley.d.mts","names":[],"sources":["../src/galley.ts"],"mappings":";;;YAQY;EACX,SAAS;;EAET;;;wBAIqB,UACnB,QAAa,aAAa,cAC5B,SAAS,kBACP,QAAQ"}

package/dist/galley.mjs

@@ -0,0 +1,12 @@
+import { r as reportContent, t as createTonnageReport } from "./report-B3HrJ4UQ.mjs";
+import path from "node:path";
+//#region src/galley.ts
+/** Measure bundles and include the report in a galley.md document. */
+async function Tonnage({ config = {}, directory }, context) {
+	const report = await createTonnageReport(config, path.resolve(context.directory, directory ?? "."));
+	return reportContent(report, config);
+}
+//#endregion
+export { Tonnage };
+
+//# sourceMappingURL=galley.mjs.map

package/dist/galley.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"galley.mjs","names":[],"sources":["../src/galley.ts"],"sourcesContent":["import path from \"node:path\"\n\nimport type { DocumentContext, Element } from \"galley.md\"\n\nimport { createTonnageReport } from \"./report.ts\"\nimport { reportContent } from \"./report-content.ts\"\nimport type { TonnageConfig } from \"./types.ts\"\n\nexport type TonnageProps = {\n\tconfig?: TonnageConfig\n\t/** Override the document directory when measuring a different package. */\n\tdirectory?: string\n}\n\n/** Measure bundles and include the report in a galley.md document. */\nexport async function Tonnage(\n\t{ config = {}, directory }: TonnageProps,\n\tcontext: DocumentContext,\n): Promise<Element[]> {\n\tconst report = await createTonnageReport(\n\t\tconfig,\n\t\tpath.resolve(context.directory, directory ?? \".\"),\n\t)\n\treturn reportContent(report, config)\n}\n"],"mappings":";;;;AAeA,eAAsB,QACrB,EAAE,SAAS,CAAC,GAAG,aACf,SACqB;CACrB,MAAM,SAAS,MAAM,oBACpB,QACA,KAAK,QAAQ,QAAQ,WAAW,aAAa,GAAG,CACjD;CACA,OAAO,cAAc,QAAQ,MAAM;AACpC"}

package/dist/index.d.mts

@@ -1,53 +1,7 @@
+import { a as TonnageMode, c as TonnageReport, i as TonnageExports, l as TonnageRow, n as BundlePlatform, o as TonnageRecipe, r as TonnageConfig, s as TonnageRecipeRow, t as BundleMeasurement, u as TonnageRunResult } from "./types-Ddtp95Z3.mjs";
 import "esbuild";
-//#region src/types.d.ts
-type BundlePlatform = `browser` | `neutral` | `node`;
-type TonnageExports = {
-  exclude?: readonly string[];
-  include?: readonly string[];
-};
-type TonnageRecipe = {
-  entry: string;
-  external?: readonly string[];
-  name: string;
-  platform?: BundlePlatform;
-};
-type TonnageConfig = {
-  exports?: boolean | TonnageExports;
-  external?: readonly string[];
-  heading?: string;
-  marker?: string;
-  packageJson?: string;
-  platform?: BundlePlatform;
-  readme?: string;
-  recipes?: readonly TonnageRecipe[];
-  target?: string;
-};
-type BundleMeasurement = {
-  gzipBytes: number;
-  rawBytes: number;
-};
-type TonnageRow = BundleMeasurement & {
-  imports: readonly string[];
-  name: string;
-};
-type TonnageRecipeRow = BundleMeasurement & {
-  entry: string;
-  name: string;
-};
-type TonnageReport = {
-  exports: readonly TonnageRow[];
-  packageName: string;
-  recipes: readonly TonnageRecipeRow[];
-};
-type TonnageMode = `check` | `write`;
-type TonnageRunResult = {
-  changed: boolean;
-  readmePath: string;
-  report: TonnageReport;
-};
-//#endregion
 //#region src/define-config.d.ts
-declare function defineConfig(config: TonnageConfig): TonnageConfig;
+export declare function defineConfig(config: TonnageConfig): TonnageConfig;
 //#endregion
 //#region src/measure.d.ts
 type MeasureImportsOptions = {
@@ -57,25 +11,26 @@ type MeasureImportsOptions = {
   target?: string | undefined;
 };
 type MeasureEntryOptions = MeasureImportsOptions;
-declare function measureEntry(entry: string, options: MeasureEntryOptions): Promise<BundleMeasurement>;
-declare function measureImports(imports: readonly string[], options: MeasureImportsOptions): Promise<BundleMeasurement>;
+export declare function measureEntry(entry: string, options: MeasureEntryOptions): Promise<BundleMeasurement>;
+export declare function measureImports(imports: readonly string[], options: MeasureImportsOptions): Promise<BundleMeasurement>;
 //#endregion
 //#region src/readme.d.ts
-declare function tonnageMarkers(marker?: string): {
+export declare function tonnageMarkers(marker?: string): {
   end: string;
   start: string;
 };
-declare function updateGeneratedSection(readme: string, markdown: string, marker?: string): string;
+export declare function updateGeneratedSection(readme: string, markdown: string, marker?: string): string;
 //#endregion
 //#region src/report.d.ts
-declare function createTonnageReport(config: TonnageConfig, configDirectory: string): Promise<TonnageReport>;
-declare function renderTonnageMarkdown(report: TonnageReport, config?: TonnageConfig): string;
+export declare function createTonnageReport(config: TonnageConfig, configDirectory: string): Promise<TonnageReport>;
+/** Serialize a report with the same Galley elements used by the document component. */
+export declare function renderTonnageMarkdown(report: TonnageReport, config?: TonnageConfig): Promise<string>;
 //#endregion
 //#region src/run.d.ts
-declare function runTonnage(config: TonnageConfig, options: {
+export declare function runTonnage(config: TonnageConfig, options: {
   configDirectory?: string;
   mode: TonnageMode;
 }): Promise<TonnageRunResult>;
 //#endregion
-export { type BundleMeasurement, type BundlePlatform, type MeasureEntryOptions, type MeasureImportsOptions, type TonnageConfig, type TonnageExports, type TonnageMode, type TonnageRecipe, type TonnageRecipeRow, type TonnageReport, type TonnageRow, type TonnageRunResult, createTonnageReport, defineConfig, measureEntry, measureImports, renderTonnageMarkdown, runTonnage, tonnageMarkers, updateGeneratedSection };
+export type { BundleMeasurement, BundlePlatform, MeasureEntryOptions, MeasureImportsOptions, TonnageConfig, TonnageExports, TonnageMode, TonnageRecipe, TonnageRecipeRow, TonnageReport, TonnageRow, TonnageRunResult };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/define-config.ts","../src/measure.ts","../src/readme.ts","../src/report.ts","../src/run.ts"],"mappings":";;KAAY;KAEA;EACX;EACA;;KAGW;EACX;EACA;EACA;EACA,WAAW;;KAGA;EACX,oBAAoB;EACpB;EACA;EACA;EACA;EACA,WAAW;EACX;EACA,mBAAmB;EACnB;;KAGW;EACX;EACA;;KAGW,aAAa;EACxB;EACA;;KAGW,mBAAmB;EAC9B;EACA;;KAGW;EACX,kBAAkB;EAClB;EACA,kBAAkB;;KAGP;KAEA;EACX;EACA;EACA,QAAQ;;;;iBClDO,aAAa,QAAQ,gBAAgB;;;KCKzC;EACX;EACA,WAAW;EACX;EACA;;KAGW,sBAAsB;iBAMZ,aACrB,eACA,SAAS,sBACP,QAAQ;iBAcW,eACrB,4BACA,SAAS,wBACP,QAAQ;;;iBCxCK,eAAe;EAC9B;EACA;;iBASe,uBACf,gBACA,kBACA;;;iBCOqB,oBACrB,QAAQ,eACR,0BACE,QAAQ;iBA+DK,sBACf,QAAQ,eACR,SAAQ;;;iBClFa,WACrB,QAAQ,eACR;EACC;EACA,MAAM;IAEL,QAAQ"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/define-config.ts","../src/measure.ts","../src/readme.ts","../src/report.ts","../src/run.ts"],"mappings":";;;wBAEgB,aAAa,QAAQ,gBAAgB;;;KCKzC;EACX;EACA,WAAW;EACX;EACA;;KAGW,sBAAsB;wBAMZ,aACrB,eACA,SAAS,sBACP,QAAQ;wBAcW,eACrB,4BACA,SAAS,wBACP,QAAQ;;;wBCxCK,eAAe;EAC9B;EACA;;wBASe,uBACf,gBACA,kBACA;;;wBCUqB,oBACrB,QAAQ,eACR,0BACE,QAAQ;;wBAgEW,sBACrB,QAAQ,eACR,SAAQ,gBACN;;;wBCvFmB,WACrB,QAAQ,eACR;EACC;EACA,MAAM;IAEL,QAAQ"}

package/dist/index.mjs

@@ -1,4 +1,5 @@
-import { a as measureImports, i as measureEntry, n as createTonnageReport, o as tonnageMarkers, r as renderTonnageMarkdown, s as updateGeneratedSection, t as runTonnage } from "./run-CZ_FO4C7.mjs";
+import { n as tonnageMarkers, r as updateGeneratedSection, t as runTonnage } from "./run-BJN1MXRf.mjs";
+import { a as measureImports, i as measureEntry, n as renderTonnageMarkdown, t as createTonnageReport } from "./report-B3HrJ4UQ.mjs";
 //#region src/define-config.ts
 function defineConfig(config) {
 	return config;

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/define-config.ts"],"sourcesContent":["import type { TonnageConfig } from \"./types.ts\"\n\nexport function defineConfig(config: TonnageConfig): TonnageConfig {\n\treturn config\n}\n"],"mappings":";;AAEA,SAAgB,aAAa,QAAsC;CAClE,OAAO;AACR"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/define-config.ts"],"sourcesContent":["import type { TonnageConfig } from \"./types.ts\"\n\nexport function defineConfig(config: TonnageConfig): TonnageConfig {\n\treturn config\n}\n"],"mappings":";;;AAEA,SAAgB,aAAa,QAAsC;CAClE,OAAO;AACR"}