@mandujs/core 0.53.3 → 0.54.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +654 -654
- package/package.json +1 -1
- package/src/a11y/__tests__/run-audit.test.ts +333 -333
- package/src/a11y/fix-hints.ts +76 -76
- package/src/a11y/index.ts +18 -18
- package/src/a11y/run-audit.ts +394 -394
- package/src/a11y/types.ts +125 -125
- package/src/auth/__tests__/login.test.ts +1 -1
- package/src/auth/__tests__/password.test.ts +122 -122
- package/src/auth/__tests__/tokens.test.ts +274 -274
- package/src/auth/__tests__/verification.test.ts +274 -274
- package/src/auth/index.ts +76 -76
- package/src/auth/login.ts +225 -225
- package/src/auth/password.ts +120 -120
- package/src/auth/reset.ts +243 -243
- package/src/auth/tokens.ts +612 -612
- package/src/auth/verification.ts +253 -253
- package/src/brain/__tests__/redactor.test.ts +94 -94
- package/src/brain/adapters/__tests__/_helpers.ts +83 -83
- package/src/brain/adapters/__tests__/anthropic-oauth.test.ts +196 -196
- package/src/brain/adapters/__tests__/chatgpt-auth.test.ts +193 -193
- package/src/brain/adapters/__tests__/openai-oauth.test.ts +209 -209
- package/src/brain/adapters/__tests__/resolver.test.ts +143 -143
- package/src/brain/adapters/anthropic-oauth.ts +1 -1
- package/src/brain/adapters/chatgpt-auth.ts +300 -300
- package/src/brain/adapters/index.ts +319 -319
- package/src/brain/adapters/oauth-flow.ts +439 -439
- package/src/brain/consent.ts +240 -240
- package/src/brain/credentials.ts +396 -396
- package/src/bundler/__tests__/build-runner.ts +113 -113
- package/src/bundler/__tests__/dev-reliability.test.ts +619 -619
- package/src/bundler/__tests__/extended-watch.test.ts +711 -711
- package/src/bundler/__tests__/fast-refresh.test.ts +10 -10
- package/src/bundler/__tests__/hdr.test.ts +353 -353
- package/src/bundler/__tests__/hmr-client.test.ts +532 -532
- package/src/bundler/__tests__/manifest-schema.test.ts +266 -266
- package/src/bundler/__tests__/prod-smoke.test.ts +138 -138
- package/src/bundler/__tests__/reverse-import-graph.test.ts +519 -519
- package/src/bundler/__tests__/slot-dispatch.test.ts +573 -573
- package/src/bundler/__tests__/url-cap-and-slot-regex.test.ts +286 -286
- package/src/bundler/__tests__/vendor-cache.test.ts +455 -455
- package/src/bundler/budget.ts +404 -404
- package/src/bundler/build.test.ts +179 -179
- package/src/bundler/build.ts +55 -55
- package/src/bundler/dev.ts +42 -42
- package/src/bundler/manifest-schema.ts +301 -301
- package/src/bundler/plugins/__tests__/block-generated-imports.test.ts +263 -263
- package/src/bundler/plugins/__tests__/react-compiler-config.test.ts +83 -83
- package/src/bundler/plugins/__tests__/react-compiler-lint.test.ts +110 -110
- package/src/bundler/plugins/block-generated-imports.ts +155 -155
- package/src/bundler/plugins/index.ts +83 -83
- package/src/bundler/plugins/react-compiler-config.ts +108 -108
- package/src/bundler/plugins/react-compiler-lint.ts +253 -253
- package/src/bundler/plugins/react-compiler.ts +162 -162
- package/src/bundler/reverse-import-graph.ts +339 -339
- package/src/bundler/safe-build.test.ts +201 -201
- package/src/bundler/safe-build.ts +103 -103
- package/src/bundler/scenario-matrix.ts +229 -229
- package/src/bundler/types.ts +10 -10
- package/src/bundler/vendor-cache-types.ts +130 -130
- package/src/bundler/vendor-cache.ts +526 -526
- package/src/change/snapshot.ts +18 -18
- package/src/client/Form.tsx +105 -105
- package/src/client/Link.tsx +9 -9
- package/src/client/__tests__/use-sse.test.ts +153 -153
- package/src/client/globals.ts +1 -1
- package/src/client/hooks.ts +362 -362
- package/src/client/hydrate.ts +340 -340
- package/src/client/prefetch-helper.ts +55 -55
- package/src/client/router.ts +11 -11
- package/src/client/runtime.ts +47 -47
- package/src/client/serialize.ts +404 -404
- package/src/client/use-fetch.ts +6 -6
- package/src/client/use-head.ts +197 -197
- package/src/client/use-sse.ts +378 -378
- package/src/client/window-state.ts +101 -101
- package/src/components/Image.tsx +162 -162
- package/src/config/validate.ts +3 -3
- package/src/config/watcher.ts +311 -311
- package/src/constants.ts +40 -40
- package/src/content/collection.ts +8 -8
- package/src/content/content-layer.ts +7 -7
- package/src/content/data-store.ts +245 -245
- package/src/content/frontmatter.ts +189 -189
- package/src/content/loader-context.ts +171 -171
- package/src/content/loaders/api.ts +216 -216
- package/src/content/loaders/file.ts +172 -172
- package/src/content/loaders/glob.ts +253 -253
- package/src/content/loaders/index.ts +34 -34
- package/src/content/loaders/types.ts +137 -137
- package/src/content/meta-store.ts +209 -209
- package/src/content/prebuild.test.ts +571 -571
- package/src/content/prebuild.ts +636 -636
- package/src/content/schema.ts +20 -20
- package/src/content/sidebar.ts +630 -630
- package/src/content/slug.ts +110 -110
- package/src/content/types.ts +282 -282
- package/src/content/watcher.ts +135 -135
- package/src/contract/client-safe.test.ts +42 -42
- package/src/contract/client-safe.ts +114 -114
- package/src/contract/define.ts +11 -11
- package/src/contract/index.ts +1 -1
- package/src/contract/normalize.test.ts +276 -276
- package/src/contract/normalize.ts +410 -410
- package/src/contract/registry.test.ts +206 -206
- package/src/contract/route-helpers.ts +1 -1
- package/src/contract/rpc.ts +443 -443
- package/src/contract/schema.ts +48 -48
- package/src/contract/types.ts +58 -58
- package/src/db/__tests__/db.test.ts +482 -482
- package/src/db/index.ts +138 -138
- package/src/db/migrations/history-table.ts +345 -345
- package/src/db/migrations/index.ts +3 -3
- package/src/db/migrations/lock.ts +324 -324
- package/src/db/migrations/runner.ts +650 -650
- package/src/deploy/cache.ts +140 -140
- package/src/deploy/compile/vercel.ts +344 -344
- package/src/deploy/index.ts +87 -87
- package/src/deploy/inference/brain.ts +268 -268
- package/src/deploy/inference/context.ts +182 -182
- package/src/deploy/inference/filling-extract.ts +245 -245
- package/src/deploy/inference/heuristic.ts +182 -182
- package/src/deploy/intent.ts +173 -173
- package/src/deploy/plan.ts +178 -178
- package/src/design/__tests__/agents-link.test.ts +109 -109
- package/src/design/__tests__/extract-patch-diff.test.ts +265 -265
- package/src/design/__tests__/lint.test.ts +110 -110
- package/src/design/__tests__/parser.test.ts +195 -195
- package/src/design/__tests__/tailwind-theme.test.ts +229 -229
- package/src/design/agents-link.ts +165 -165
- package/src/design/diff.ts +138 -138
- package/src/design/extract.ts +285 -285
- package/src/design/index.ts +102 -102
- package/src/design/lint.ts +209 -209
- package/src/design/parser.ts +555 -555
- package/src/design/patch.ts +241 -241
- package/src/design/scaffold.ts +147 -147
- package/src/design/tailwind-theme.ts +441 -441
- package/src/design/types.ts +210 -210
- package/src/desktop/__tests__/webview-fallback.test.ts +254 -254
- package/src/desktop/__tests__/window.test.ts +248 -248
- package/src/desktop/__tests__/worker.test.ts +266 -266
- package/src/desktop/index.ts +43 -43
- package/src/desktop/types.ts +158 -158
- package/src/desktop/worker.ts +180 -180
- package/src/dev-error-overlay/__tests__/overlay-injector.test.ts +241 -241
- package/src/dev-error-overlay/index.ts +30 -30
- package/src/dev-error-overlay/overlay-injector.ts +243 -243
- package/src/dev-error-overlay/overlay-styles.ts +52 -52
- package/src/dev-error-overlay/types.ts +66 -66
- package/src/devtools/ai/context-builder.ts +375 -375
- package/src/devtools/ai/index.ts +25 -25
- package/src/devtools/ai/mcp-connector.ts +25 -25
- package/src/devtools/client/catchers/error-catcher.ts +344 -344
- package/src/devtools/client/catchers/index.ts +18 -18
- package/src/devtools/client/components/index.ts +39 -39
- package/src/devtools/client/components/mandu-character.tsx +331 -331
- package/src/devtools/client/components/overlay.tsx +368 -368
- package/src/devtools/client/components/panel/errors-panel.tsx +259 -259
- package/src/devtools/client/components/panel/guard-panel.tsx +30 -30
- package/src/devtools/client/components/panel/islands-panel.tsx +320 -320
- package/src/devtools/client/components/panel/network-panel.tsx +291 -291
- package/src/devtools/client/components/panel/panel-container.tsx +500 -500
- package/src/devtools/client/components/panel/preview-panel.tsx +46 -46
- package/src/devtools/client/filters/context-filters.ts +282 -282
- package/src/devtools/client/filters/index.ts +16 -16
- package/src/devtools/client/index.ts +63 -63
- package/src/devtools/client/persistence.ts +335 -335
- package/src/devtools/hook/create-hook.ts +207 -207
- package/src/devtools/hook/index.ts +13 -13
- package/src/devtools/index.ts +439 -439
- package/src/devtools/init.ts +265 -265
- package/src/devtools/protocol.ts +237 -237
- package/src/devtools/server/index.ts +17 -17
- package/src/devtools/server/source-context.ts +450 -450
- package/src/devtools/types.ts +35 -35
- package/src/devtools/worker/index.ts +25 -25
- package/src/devtools/worker/redaction-worker.ts +233 -233
- package/src/devtools/worker/worker-manager.ts +410 -410
- package/src/diagnose/__tests__/checks.test.ts +451 -451
- package/src/diagnose/checks.ts +832 -832
- package/src/diagnose/index.ts +17 -17
- package/src/diagnose/run.ts +93 -93
- package/src/diagnose/types.ts +53 -53
- package/src/email/__tests__/email.test.ts +355 -355
- package/src/email/index.ts +282 -282
- package/src/email/smtp.ts +64 -64
- package/src/error/domains.ts +265 -265
- package/src/error/result.ts +60 -60
- package/src/error/types.ts +6 -6
- package/src/errors/extractor.ts +409 -409
- package/src/errors/index.ts +19 -19
- package/src/filling/__tests__/session-sqlite.test.ts +454 -454
- package/src/filling/auth.ts +308 -308
- package/src/filling/cookie-codec.ts +299 -299
- package/src/filling/deps.ts +265 -265
- package/src/filling/session-sqlite.ts +617 -617
- package/src/filling/sse.ts +5 -5
- package/src/filling/ws.ts +78 -78
- package/src/generator/index.ts +3 -3
- package/src/guard/__tests__/design-inline-class.test.ts +219 -219
- package/src/guard/__tests__/tsgolint-bridge.test.ts +347 -347
- package/src/guard/analyzer.ts +360 -360
- package/src/guard/auto-correct.ts +1 -1
- package/src/guard/contract-guard.ts +9 -9
- package/src/guard/define-rule.ts +243 -243
- package/src/guard/design-inline-class.ts +393 -393
- package/src/guard/file-type.test.ts +24 -24
- package/src/guard/graph.ts +1 -1
- package/src/guard/healing.ts +36 -36
- package/src/guard/presets/atomic.ts +70 -70
- package/src/guard/presets/clean.ts +77 -77
- package/src/guard/presets/fsd.ts +79 -79
- package/src/guard/presets/hexagonal.ts +68 -68
- package/src/guard/reporter.ts +442 -442
- package/src/guard/rule-presets.ts +379 -379
- package/src/guard/semantic-slots.ts +1 -1
- package/src/guard/suggestions.ts +358 -358
- package/src/guard/tsgolint-bridge.ts +512 -512
- package/src/guard/types.ts +348 -348
- package/src/guard/watcher.ts +405 -405
- package/src/i18n/define.ts +126 -126
- package/src/i18n/index.ts +52 -52
- package/src/i18n/message-registry.ts +173 -173
- package/src/i18n/types.ts +112 -112
- package/src/id/index.ts +105 -105
- package/src/index.ts +2 -2
- package/src/kitchen/api/agent-devtools-api.ts +779 -544
- package/src/kitchen/api/errors-grouping.ts +126 -0
- package/src/kitchen/kitchen-handler.ts +192 -63
- package/src/kitchen/kitchen-ui.ts +842 -464
- package/src/logging/index.ts +22 -22
- package/src/logging/transports.ts +365 -365
- package/src/middleware/bridge.ts +147 -147
- package/src/middleware/compose.ts +134 -134
- package/src/middleware/compress.ts +62 -62
- package/src/middleware/cors.ts +47 -47
- package/src/middleware/csrf.ts +328 -328
- package/src/middleware/define.ts +132 -132
- package/src/middleware/jwt.ts +134 -134
- package/src/middleware/logger.ts +58 -58
- package/src/middleware/oauth/__tests__/oauth.test.ts +1 -1
- package/src/middleware/oauth/index.ts +505 -505
- package/src/middleware/oauth/providers.ts +115 -115
- package/src/middleware/rate-limit/index.ts +522 -522
- package/src/middleware/rate-limit/sqlite-store.ts +382 -382
- package/src/middleware/scheduler-cron.ts +96 -96
- package/src/middleware/secure/__tests__/secure.test.ts +360 -360
- package/src/middleware/secure/csp.ts +193 -193
- package/src/middleware/session.ts +174 -174
- package/src/middleware/timeout.ts +55 -55
- package/src/observability/logger-adapter.ts +36 -36
- package/src/observability/sqlite-store.ts +254 -254
- package/src/openapi/generator.ts +1 -1
- package/src/openapi/openapi.test.ts +43 -43
- package/src/perf/__tests__/user-marks.test.ts +354 -354
- package/src/perf/index.ts +133 -133
- package/src/plugins/__tests__/lifecycle-integration.test.ts +272 -272
- package/src/plugins/__tests__/runner.test.ts +409 -409
- package/src/plugins/define.ts +124 -124
- package/src/plugins/examples/dep-check-plugin.ts +80 -80
- package/src/plugins/examples/prerender-cache-plugin.ts +111 -111
- package/src/plugins/examples/sitemap-plugin.ts +65 -65
- package/src/plugins/runner.ts +361 -361
- package/src/plugins/types.ts +368 -368
- package/src/report/index.ts +1 -1
- package/src/resource/__tests__/generator.test.ts +32 -32
- package/src/resource/ddl/__tests__/diff.test.ts +639 -639
- package/src/resource/ddl/__tests__/emit.test.ts +823 -823
- package/src/resource/ddl/__tests__/snapshot.test.ts +499 -499
- package/src/resource/ddl/emit.ts +559 -559
- package/src/resource/ddl/persistence-types.ts +218 -218
- package/src/resource/ddl/type-map.ts +223 -223
- package/src/resource/ddl/types.ts +232 -232
- package/src/resource/generator-repo.ts +630 -630
- package/src/resource/schema.ts +1 -1
- package/src/router/fs-patterns.test.ts +96 -96
- package/src/router/fs-routes.ts +6 -6
- package/src/routes/index.ts +74 -74
- package/src/routes/metadata-routes.ts +427 -427
- package/src/routes/types.ts +341 -341
- package/src/runtime/__tests__/error-boundary-redaction.test.ts +141 -141
- package/src/runtime/__tests__/hdr-client.test.ts +223 -223
- package/src/runtime/__tests__/http-errors.test.ts +117 -117
- package/src/runtime/__tests__/not-found.test.ts +152 -152
- package/src/runtime/adapter.ts +47 -47
- package/src/runtime/boundary.tsx +252 -252
- package/src/runtime/cache.ts +494 -494
- package/src/runtime/compose.ts +222 -222
- package/src/runtime/fast-refresh-runtime.ts +322 -322
- package/src/runtime/handler.ts +65 -65
- package/src/runtime/handlers.ts +300 -300
- package/src/runtime/http-errors.ts +113 -113
- package/src/runtime/image-handler.ts +1 -1
- package/src/runtime/lifecycle.ts +381 -381
- package/src/runtime/logger.test.ts +345 -345
- package/src/runtime/middleware.ts +264 -264
- package/src/runtime/not-found.ts +93 -93
- package/src/runtime/openapi-endpoint.ts +236 -236
- package/src/runtime/ppr.ts +74 -74
- package/src/runtime/registry.ts +171 -171
- package/src/runtime/router.ts +105 -105
- package/src/runtime/server.ts +67 -67
- package/src/runtime/shims.ts +48 -48
- package/src/runtime/trace.ts +144 -144
- package/src/scheduler/validate.ts +169 -169
- package/src/seo/index.ts +219 -219
- package/src/seo/integration/ssr.ts +306 -306
- package/src/seo/render/basic.ts +435 -435
- package/src/seo/render/index.ts +143 -143
- package/src/seo/render/jsonld.ts +539 -539
- package/src/seo/render/opengraph.ts +197 -197
- package/src/seo/render/robots.ts +116 -116
- package/src/seo/render/sitemap.ts +137 -137
- package/src/seo/render/twitter.ts +127 -127
- package/src/seo/resolve/opengraph.ts +143 -143
- package/src/seo/resolve/robots.ts +73 -73
- package/src/seo/resolve/title.ts +94 -94
- package/src/seo/resolve/twitter.ts +73 -73
- package/src/seo/resolve/url.ts +104 -104
- package/src/seo/routes/index.ts +290 -290
- package/src/seo/types.ts +588 -588
- package/src/slot/validator.ts +39 -39
- package/src/storage/s3/__tests__/s3.test.ts +479 -479
- package/src/storage/s3/index.ts +412 -412
- package/src/testing/__tests__/assertions.test.ts +632 -632
- package/src/testing/__tests__/reporter.test.ts +454 -454
- package/src/testing/assertions.ts +986 -986
- package/src/testing/db.ts +157 -157
- package/src/testing/mocks.ts +203 -203
- package/src/testing/session.ts +190 -190
- package/src/types/branded.ts +56 -56
- package/src/types/index.ts +1 -1
- package/src/utils/safe-io.ts +188 -188
- package/src/utils/string-safe.ts +298 -298
- package/src/watcher/watcher.ts +18 -18
package/src/bundler/budget.ts
CHANGED
|
@@ -1,404 +1,404 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Phase 18.φ — Bundle size budget.
|
|
3
|
-
*
|
|
4
|
-
* `ManduConfig.build.budget` declares bundle-size ceilings. The CLI
|
|
5
|
-
* (`mandu build`) evaluates every post-bundled island + total against the
|
|
6
|
-
* budget and either fails (`mode: 'error'`) or warns (`mode: 'warning'`,
|
|
7
|
-
* default) when a limit is exceeded.
|
|
8
|
-
*
|
|
9
|
-
* ── Design ─────────────────────────────────────────────────────────────────
|
|
10
|
-
*
|
|
11
|
-
* - Pure function. `evaluateBudget(report, budget)` is side-effect free:
|
|
12
|
-
* it consumes the analyzer {@link AnalyzeReport} (already has raw / gz
|
|
13
|
-
* bytes measured by Phase 18.η) and produces a {@link BudgetReport}.
|
|
14
|
-
* Serialization / exit-code selection is the CLI's job.
|
|
15
|
-
* - Zero runtime deps. The analyzer already uses `zlib` for real gzip
|
|
16
|
-
* sizing — we consume its output rather than recompressing.
|
|
17
|
-
* - Semi-reasonable default. When a user declares `build.budget: {}`
|
|
18
|
-
* (empty) they opt out of the default 250 KB gzip ceiling. When the
|
|
19
|
-
* whole field is omitted (the common case today) the CLI passes
|
|
20
|
-
* `undefined` and this module is never called — zero overhead.
|
|
21
|
-
* - Strict schema. See `config/validate.ts` → `BuildBudgetConfigSchema`.
|
|
22
|
-
*
|
|
23
|
-
* ── What this module deliberately does NOT do ──────────────────────────────
|
|
24
|
-
*
|
|
25
|
-
* - No tree-shaking suggestions. (see analyzer.ts design doc.)
|
|
26
|
-
* - No historical delta. `mandu build --analyze` already emits
|
|
27
|
-
* `.mandu/analyze/report.json` which a separate job can diff.
|
|
28
|
-
* - No I/O. Everything is in-memory so tests don't need tmpdirs.
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
|
-
import type { AnalyzeReport } from "./analyzer";
|
|
32
|
-
|
|
33
|
-
// ============================================================================
|
|
34
|
-
// Types
|
|
35
|
-
// ============================================================================
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* User-declared budget (from `ManduConfig.build.budget`). Every field is
|
|
39
|
-
* optional; omitting `mode` defaults to `'warning'` so a first-time user
|
|
40
|
-
* isn't surprised by a failing build. An entirely empty object (`{}`) is
|
|
41
|
-
* a valid opt-out signal — "I know about budgets, please don't apply the
|
|
42
|
-
* default ceiling".
|
|
43
|
-
*/
|
|
44
|
-
export interface BundleBudget {
|
|
45
|
-
/** Per-island raw-byte ceiling. */
|
|
46
|
-
maxRawBytes?: number;
|
|
47
|
-
/** Per-island gzip-byte ceiling. */
|
|
48
|
-
maxGzBytes?: number;
|
|
49
|
-
/** Project-wide raw-byte ceiling (sum of islands + shared). */
|
|
50
|
-
maxTotalRawBytes?: number;
|
|
51
|
-
/** Project-wide gzip-byte ceiling. */
|
|
52
|
-
maxTotalGzBytes?: number;
|
|
53
|
-
/**
|
|
54
|
-
* Per-island override. Keys are route/island ids as they appear in
|
|
55
|
-
* {@link AnalyzeReport.islands[].name}. A value of `{ raw: 0 }` /
|
|
56
|
-
* `{ gz: 0 }` is valid — it pins the island to 0 bytes, useful for
|
|
57
|
-
* "this island should never be generated" assertions.
|
|
58
|
-
*/
|
|
59
|
-
perIsland?: Record<string, { raw?: number; gz?: number }>;
|
|
60
|
-
/**
|
|
61
|
-
* Enforcement mode.
|
|
62
|
-
* - `'warning'` (default): print issues, continue build.
|
|
63
|
-
* - `'error'`: print issues, exit non-zero.
|
|
64
|
-
*
|
|
65
|
-
* The CLI owns the exit-code decision; this module only surfaces
|
|
66
|
-
* `mode` so reporters can colour-code output consistently.
|
|
67
|
-
*/
|
|
68
|
-
mode?: "error" | "warning";
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
/**
|
|
72
|
-
* Severity of a single budget comparison outcome. `within10` is the yellow
|
|
73
|
-
* "approaching" band (≥90% of the limit) the HTML report uses to colour
|
|
74
|
-
* bars amber. The CLI treats `within10` as a non-failing warning even
|
|
75
|
-
* under `mode: 'error'` — the build only fails on `exceeded`.
|
|
76
|
-
*/
|
|
77
|
-
export type BudgetStatus = "within" | "within10" | "exceeded";
|
|
78
|
-
|
|
79
|
-
export interface BudgetIslandCheck {
|
|
80
|
-
/** Island / route id. */
|
|
81
|
-
name: string;
|
|
82
|
-
/** Raw bytes measured by the analyzer. */
|
|
83
|
-
raw: number;
|
|
84
|
-
/** Gzip bytes measured by the analyzer. */
|
|
85
|
-
gz: number;
|
|
86
|
-
/** Active raw ceiling for this island (per-island override or global). `null` when no raw ceiling applies. */
|
|
87
|
-
rawLimit: number | null;
|
|
88
|
-
/** Active gzip ceiling. `null` when no gzip ceiling applies. */
|
|
89
|
-
gzLimit: number | null;
|
|
90
|
-
/** Status derived from the stricter of `rawStatus` / `gzStatus`. */
|
|
91
|
-
status: BudgetStatus;
|
|
92
|
-
/** Per-axis status. */
|
|
93
|
-
rawStatus: BudgetStatus;
|
|
94
|
-
gzStatus: BudgetStatus;
|
|
95
|
-
/** True when a `perIsland[name]` entry overrode a global limit. */
|
|
96
|
-
overridden: boolean;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
export interface BudgetTotalCheck {
|
|
100
|
-
raw: number;
|
|
101
|
-
gz: number;
|
|
102
|
-
rawLimit: number | null;
|
|
103
|
-
gzLimit: number | null;
|
|
104
|
-
status: BudgetStatus;
|
|
105
|
-
rawStatus: BudgetStatus;
|
|
106
|
-
gzStatus: BudgetStatus;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
export interface BudgetReport {
|
|
110
|
-
/** Resolved mode (`'warning'` when the user omitted the field). */
|
|
111
|
-
mode: "error" | "warning";
|
|
112
|
-
/** One entry per island in {@link AnalyzeReport.islands}, input order preserved. */
|
|
113
|
-
islands: BudgetIslandCheck[];
|
|
114
|
-
/** Project-wide totals (only populated when a `maxTotal*` limit exists). */
|
|
115
|
-
total: BudgetTotalCheck | null;
|
|
116
|
-
/** True when at least one island or the total exceeded its limit. */
|
|
117
|
-
hasExceeded: boolean;
|
|
118
|
-
/** Convenience: total islands counted. */
|
|
119
|
-
islandCount: number;
|
|
120
|
-
/** Convenience: islands strictly `within` limits. */
|
|
121
|
-
withinCount: number;
|
|
122
|
-
/** Convenience: islands flagged `within10`. */
|
|
123
|
-
approachingCount: number;
|
|
124
|
-
/** Convenience: islands flagged `exceeded`. */
|
|
125
|
-
exceededCount: number;
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
// ============================================================================
|
|
129
|
-
// Defaults
|
|
130
|
-
// ============================================================================
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* The "nothing set" default. Applied when the user passes `build.budget`
|
|
134
|
-
* whose every ceiling field is `undefined` EXCEPT they also left
|
|
135
|
-
* `perIsland` / `maxTotal*` off — effectively a literal `{}` or a
|
|
136
|
-
* `{ mode: 'warning' }` with no thresholds. Chosen to roughly match the
|
|
137
|
-
* Next.js `largePageDataBytes` soft-warning threshold (128 KB gz) paired
|
|
138
|
-
* with Astro's "ship under 200 KB of JS" rule of thumb — 250 KB gives
|
|
139
|
-
* app-shell + React-runtime + a handful of libraries breathing room
|
|
140
|
-
* before the warning fires.
|
|
141
|
-
*
|
|
142
|
-
* Setting any explicit field (even `maxRawBytes: 99999999`) disables the
|
|
143
|
-
* auto-default. This lets `build.budget: {}` be an explicit opt-out.
|
|
144
|
-
*
|
|
145
|
-
* Exported so docs generators, tests, and tooling can surface the exact
|
|
146
|
-
* number without hard-coding.
|
|
147
|
-
*/
|
|
148
|
-
export const DEFAULT_BUDGET_MAX_GZ_BYTES = 250_000;
|
|
149
|
-
|
|
150
|
-
/**
|
|
151
|
-
* Return `true` when every ceiling-bearing field is missing. We then
|
|
152
|
-
* inject the {@link DEFAULT_BUDGET_MAX_GZ_BYTES} default. An empty object
|
|
153
|
-
* (`{}`) counts as "all fields missing" — the caller passed a budget
|
|
154
|
-
* block on purpose but left everything unset. We still apply the default
|
|
155
|
-
* to honour the documented behaviour: "declaring a budget block (even
|
|
156
|
-
* empty) turns on the default 250 KB gzip cap". Users opt out of the
|
|
157
|
-
* default entirely by omitting the `build.budget` field.
|
|
158
|
-
*/
|
|
159
|
-
function hasNoCeilings(b: BundleBudget): boolean {
|
|
160
|
-
return (
|
|
161
|
-
b.maxRawBytes === undefined &&
|
|
162
|
-
b.maxGzBytes === undefined &&
|
|
163
|
-
b.maxTotalRawBytes === undefined &&
|
|
164
|
-
b.maxTotalGzBytes === undefined &&
|
|
165
|
-
(b.perIsland === undefined || Object.keys(b.perIsland).length === 0)
|
|
166
|
-
);
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* Produce the effective budget the evaluator uses after applying
|
|
171
|
-
* defaults. Exported for tests and docs so the "what will actually be
|
|
172
|
-
* enforced" answer is one call away.
|
|
173
|
-
*/
|
|
174
|
-
export function resolveBudget(input: BundleBudget | undefined): BundleBudget | null {
|
|
175
|
-
if (!input) return null;
|
|
176
|
-
const base: BundleBudget = { ...input };
|
|
177
|
-
base.mode = input.mode ?? "warning";
|
|
178
|
-
if (hasNoCeilings(base)) {
|
|
179
|
-
base.maxGzBytes = DEFAULT_BUDGET_MAX_GZ_BYTES;
|
|
180
|
-
}
|
|
181
|
-
return base;
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
// ============================================================================
|
|
185
|
-
// Evaluation
|
|
186
|
-
// ============================================================================
|
|
187
|
-
|
|
188
|
-
/**
|
|
189
|
-
* 10% of the limit is the yellow band. Pulled out so tests and the HTML
|
|
190
|
-
* report can reference the same constant.
|
|
191
|
-
*/
|
|
192
|
-
export const APPROACHING_THRESHOLD_RATIO = 0.9;
|
|
193
|
-
|
|
194
|
-
function classify(size: number, limit: number | null): BudgetStatus {
|
|
195
|
-
if (limit === null) return "within";
|
|
196
|
-
if (size > limit) return "exceeded";
|
|
197
|
-
if (size >= limit * APPROACHING_THRESHOLD_RATIO) return "within10";
|
|
198
|
-
return "within";
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
/**
|
|
202
|
-
* The "worst" status across two axes. `exceeded` wins over `within10`
|
|
203
|
-
* wins over `within`. Used to derive an island's composite status from
|
|
204
|
-
* its per-axis (raw, gz) results.
|
|
205
|
-
*/
|
|
206
|
-
function worstStatus(a: BudgetStatus, b: BudgetStatus): BudgetStatus {
|
|
207
|
-
if (a === "exceeded" || b === "exceeded") return "exceeded";
|
|
208
|
-
if (a === "within10" || b === "within10") return "within10";
|
|
209
|
-
return "within";
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
/**
|
|
213
|
-
* Compare `report` against `budget` and produce the decision record.
|
|
214
|
-
*
|
|
215
|
-
* `budget === undefined` → the caller opted out entirely; we return
|
|
216
|
-
* `null` so the CLI can skip printing the budget section.
|
|
217
|
-
*/
|
|
218
|
-
export function evaluateBudget(
|
|
219
|
-
report: AnalyzeReport,
|
|
220
|
-
budget: BundleBudget | undefined
|
|
221
|
-
): BudgetReport | null {
|
|
222
|
-
const resolved = resolveBudget(budget);
|
|
223
|
-
if (resolved === null) return null;
|
|
224
|
-
|
|
225
|
-
const perIsland = resolved.perIsland ?? {};
|
|
226
|
-
const islands: BudgetIslandCheck[] = report.islands.map((is) => {
|
|
227
|
-
const override = perIsland[is.name];
|
|
228
|
-
const hasOverride = override !== undefined;
|
|
229
|
-
// Per-island override replaces the global cap on the axis it sets.
|
|
230
|
-
// When a user writes `perIsland: { home: { raw: 50_000 } }` we still
|
|
231
|
-
// apply the global `maxGzBytes` to `home`'s gzip size — the override
|
|
232
|
-
// is additive per-axis, not a full replacement. This matches user
|
|
233
|
-
// intent: "tighten this one axis, leave the others under the global".
|
|
234
|
-
const rawLimit =
|
|
235
|
-
override?.raw !== undefined
|
|
236
|
-
? override.raw
|
|
237
|
-
: resolved.maxRawBytes !== undefined
|
|
238
|
-
? resolved.maxRawBytes
|
|
239
|
-
: null;
|
|
240
|
-
const gzLimit =
|
|
241
|
-
override?.gz !== undefined
|
|
242
|
-
? override.gz
|
|
243
|
-
: resolved.maxGzBytes !== undefined
|
|
244
|
-
? resolved.maxGzBytes
|
|
245
|
-
: null;
|
|
246
|
-
const rawStatus = classify(is.totalRaw, rawLimit);
|
|
247
|
-
const gzStatus = classify(is.totalGz, gzLimit);
|
|
248
|
-
return {
|
|
249
|
-
name: is.name,
|
|
250
|
-
raw: is.totalRaw,
|
|
251
|
-
gz: is.totalGz,
|
|
252
|
-
rawLimit,
|
|
253
|
-
gzLimit,
|
|
254
|
-
status: worstStatus(rawStatus, gzStatus),
|
|
255
|
-
rawStatus,
|
|
256
|
-
gzStatus,
|
|
257
|
-
overridden: hasOverride,
|
|
258
|
-
};
|
|
259
|
-
});
|
|
260
|
-
|
|
261
|
-
// Total check — ONLY populated when at least one total ceiling exists.
|
|
262
|
-
// We intentionally do not fall back on per-island aggregates; if the
|
|
263
|
-
// user wants "every island < 200 KB AND the whole project < 2 MB",
|
|
264
|
-
// they must say so explicitly.
|
|
265
|
-
let total: BudgetTotalCheck | null = null;
|
|
266
|
-
if (
|
|
267
|
-
resolved.maxTotalRawBytes !== undefined ||
|
|
268
|
-
resolved.maxTotalGzBytes !== undefined
|
|
269
|
-
) {
|
|
270
|
-
const rawLimit = resolved.maxTotalRawBytes ?? null;
|
|
271
|
-
const gzLimit = resolved.maxTotalGzBytes ?? null;
|
|
272
|
-
const rawStatus = classify(report.summary.totalRaw, rawLimit);
|
|
273
|
-
const gzStatus = classify(report.summary.totalGz, gzLimit);
|
|
274
|
-
total = {
|
|
275
|
-
raw: report.summary.totalRaw,
|
|
276
|
-
gz: report.summary.totalGz,
|
|
277
|
-
rawLimit,
|
|
278
|
-
gzLimit,
|
|
279
|
-
status: worstStatus(rawStatus, gzStatus),
|
|
280
|
-
rawStatus,
|
|
281
|
-
gzStatus,
|
|
282
|
-
};
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
let withinCount = 0;
|
|
286
|
-
let approachingCount = 0;
|
|
287
|
-
let exceededCount = 0;
|
|
288
|
-
for (const i of islands) {
|
|
289
|
-
if (i.status === "exceeded") exceededCount++;
|
|
290
|
-
else if (i.status === "within10") approachingCount++;
|
|
291
|
-
else withinCount++;
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
const hasExceeded =
|
|
295
|
-
exceededCount > 0 || (total !== null && total.status === "exceeded");
|
|
296
|
-
|
|
297
|
-
return {
|
|
298
|
-
mode: resolved.mode ?? "warning",
|
|
299
|
-
islands,
|
|
300
|
-
total,
|
|
301
|
-
hasExceeded,
|
|
302
|
-
islandCount: islands.length,
|
|
303
|
-
withinCount,
|
|
304
|
-
approachingCount,
|
|
305
|
-
exceededCount,
|
|
306
|
-
};
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
// ============================================================================
|
|
310
|
-
// Formatting helpers (CLI + HTML report consumers)
|
|
311
|
-
// ============================================================================
|
|
312
|
-
|
|
313
|
-
/**
|
|
314
|
-
* Human-readable byte formatter. Kept local (tiny, no import cycle) so
|
|
315
|
-
* this module stays self-contained. Mirrors `analyzer.fmtBytes` output
|
|
316
|
-
* format for consistency in build logs.
|
|
317
|
-
*/
|
|
318
|
-
export function formatBudgetBytes(n: number): string {
|
|
319
|
-
if (!Number.isFinite(n) || n <= 0) return "0 B";
|
|
320
|
-
if (n < 1024) return `${n} B`;
|
|
321
|
-
if (n < 1024 * 1024) return `${(n / 1024).toFixed(1)} KB`;
|
|
322
|
-
return `${(n / (1024 * 1024)).toFixed(2)} MB`;
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
/**
|
|
326
|
-
* ASCII breakdown table. Used by the CLI when `--no-budget` is NOT set
|
|
327
|
-
* and at least one check is warning/exceeded. Pure — returns the
|
|
328
|
-
* already-formatted multi-line string so tests can snapshot it.
|
|
329
|
-
*
|
|
330
|
-
* Example:
|
|
331
|
-
*
|
|
332
|
-
* ┌─────────────┬──────────┬──────────┬─────────┬─────────┐
|
|
333
|
-
* │ island │ raw │ gz │ raw lim │ gz lim │
|
|
334
|
-
* ├─────────────┼──────────┼──────────┼─────────┼─────────┤
|
|
335
|
-
* │ home EXC │ 512.0 KB │ 180.0 KB │ — │ 50.0 KB │
|
|
336
|
-
* │ dashboard │ 12.3 KB │ 4.1 KB │ — │ 50.0 KB │
|
|
337
|
-
* └─────────────┴──────────┴──────────┴─────────┴─────────┘
|
|
338
|
-
*/
|
|
339
|
-
export function formatBudgetTable(report: BudgetReport): string {
|
|
340
|
-
const rows: string[][] = [["island", "raw", "gz", "raw lim", "gz lim", "status"]];
|
|
341
|
-
for (const i of report.islands) {
|
|
342
|
-
rows.push([
|
|
343
|
-
i.name + (i.overridden ? "*" : ""),
|
|
344
|
-
formatBudgetBytes(i.raw),
|
|
345
|
-
formatBudgetBytes(i.gz),
|
|
346
|
-
i.rawLimit === null ? "—" : formatBudgetBytes(i.rawLimit),
|
|
347
|
-
i.gzLimit === null ? "—" : formatBudgetBytes(i.gzLimit),
|
|
348
|
-
statusLabel(i.status),
|
|
349
|
-
]);
|
|
350
|
-
}
|
|
351
|
-
if (report.total) {
|
|
352
|
-
rows.push([
|
|
353
|
-
"<total>",
|
|
354
|
-
formatBudgetBytes(report.total.raw),
|
|
355
|
-
formatBudgetBytes(report.total.gz),
|
|
356
|
-
report.total.rawLimit === null ? "—" : formatBudgetBytes(report.total.rawLimit),
|
|
357
|
-
report.total.gzLimit === null ? "—" : formatBudgetBytes(report.total.gzLimit),
|
|
358
|
-
statusLabel(report.total.status),
|
|
359
|
-
]);
|
|
360
|
-
}
|
|
361
|
-
// Compute column widths.
|
|
362
|
-
const widths = rows[0].map((_, c) =>
|
|
363
|
-
Math.max(...rows.map((r) => r[c].length))
|
|
364
|
-
);
|
|
365
|
-
const line = (ch = " ") =>
|
|
366
|
-
"│" + widths.map((w) => " " + ch.repeat(w) + " ").join("│") + "│";
|
|
367
|
-
const divider = (left: string, mid: string, right: string, fill = "─") =>
|
|
368
|
-
left + widths.map((w) => fill.repeat(w + 2)).join(mid) + right;
|
|
369
|
-
|
|
370
|
-
const out: string[] = [];
|
|
371
|
-
out.push(divider("┌", "┬", "┐"));
|
|
372
|
-
out.push(
|
|
373
|
-
"│" +
|
|
374
|
-
rows[0]
|
|
375
|
-
.map((cell, c) => " " + cell.padEnd(widths[c]) + " ")
|
|
376
|
-
.join("│") +
|
|
377
|
-
"│"
|
|
378
|
-
);
|
|
379
|
-
out.push(divider("├", "┼", "┤"));
|
|
380
|
-
for (let r = 1; r < rows.length; r++) {
|
|
381
|
-
out.push(
|
|
382
|
-
"│" +
|
|
383
|
-
rows[r]
|
|
384
|
-
.map((cell, c) => " " + cell.padEnd(widths[c]) + " ")
|
|
385
|
-
.join("│") +
|
|
386
|
-
"│"
|
|
387
|
-
);
|
|
388
|
-
}
|
|
389
|
-
out.push(divider("└", "┴", "┘"));
|
|
390
|
-
// Suppress unused `line` var — kept for future ruled rows.
|
|
391
|
-
void line;
|
|
392
|
-
return out.join("\n");
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
function statusLabel(s: BudgetStatus): string {
|
|
396
|
-
switch (s) {
|
|
397
|
-
case "exceeded":
|
|
398
|
-
return "EXCEEDED";
|
|
399
|
-
case "within10":
|
|
400
|
-
return "APPROACHING";
|
|
401
|
-
case "within":
|
|
402
|
-
return "OK";
|
|
403
|
-
}
|
|
404
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Phase 18.φ — Bundle size budget.
|
|
3
|
+
*
|
|
4
|
+
* `ManduConfig.build.budget` declares bundle-size ceilings. The CLI
|
|
5
|
+
* (`mandu build`) evaluates every post-bundled island + total against the
|
|
6
|
+
* budget and either fails (`mode: 'error'`) or warns (`mode: 'warning'`,
|
|
7
|
+
* default) when a limit is exceeded.
|
|
8
|
+
*
|
|
9
|
+
* ── Design ─────────────────────────────────────────────────────────────────
|
|
10
|
+
*
|
|
11
|
+
* - Pure function. `evaluateBudget(report, budget)` is side-effect free:
|
|
12
|
+
* it consumes the analyzer {@link AnalyzeReport} (already has raw / gz
|
|
13
|
+
* bytes measured by Phase 18.η) and produces a {@link BudgetReport}.
|
|
14
|
+
* Serialization / exit-code selection is the CLI's job.
|
|
15
|
+
* - Zero runtime deps. The analyzer already uses `zlib` for real gzip
|
|
16
|
+
* sizing — we consume its output rather than recompressing.
|
|
17
|
+
* - Semi-reasonable default. When a user declares `build.budget: {}`
|
|
18
|
+
* (empty) they opt out of the default 250 KB gzip ceiling. When the
|
|
19
|
+
* whole field is omitted (the common case today) the CLI passes
|
|
20
|
+
* `undefined` and this module is never called — zero overhead.
|
|
21
|
+
* - Strict schema. See `config/validate.ts` → `BuildBudgetConfigSchema`.
|
|
22
|
+
*
|
|
23
|
+
* ── What this module deliberately does NOT do ──────────────────────────────
|
|
24
|
+
*
|
|
25
|
+
* - No tree-shaking suggestions. (see analyzer.ts design doc.)
|
|
26
|
+
* - No historical delta. `mandu build --analyze` already emits
|
|
27
|
+
* `.mandu/analyze/report.json` which a separate job can diff.
|
|
28
|
+
* - No I/O. Everything is in-memory so tests don't need tmpdirs.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
import type { AnalyzeReport } from "./analyzer";
|
|
32
|
+
|
|
33
|
+
// ============================================================================
|
|
34
|
+
// Types
|
|
35
|
+
// ============================================================================
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* User-declared budget (from `ManduConfig.build.budget`). Every field is
|
|
39
|
+
* optional; omitting `mode` defaults to `'warning'` so a first-time user
|
|
40
|
+
* isn't surprised by a failing build. An entirely empty object (`{}`) is
|
|
41
|
+
* a valid opt-out signal — "I know about budgets, please don't apply the
|
|
42
|
+
* default ceiling".
|
|
43
|
+
*/
|
|
44
|
+
export interface BundleBudget {
|
|
45
|
+
/** Per-island raw-byte ceiling. */
|
|
46
|
+
maxRawBytes?: number;
|
|
47
|
+
/** Per-island gzip-byte ceiling. */
|
|
48
|
+
maxGzBytes?: number;
|
|
49
|
+
/** Project-wide raw-byte ceiling (sum of islands + shared). */
|
|
50
|
+
maxTotalRawBytes?: number;
|
|
51
|
+
/** Project-wide gzip-byte ceiling. */
|
|
52
|
+
maxTotalGzBytes?: number;
|
|
53
|
+
/**
|
|
54
|
+
* Per-island override. Keys are route/island ids as they appear in
|
|
55
|
+
* {@link AnalyzeReport.islands[].name}. A value of `{ raw: 0 }` /
|
|
56
|
+
* `{ gz: 0 }` is valid — it pins the island to 0 bytes, useful for
|
|
57
|
+
* "this island should never be generated" assertions.
|
|
58
|
+
*/
|
|
59
|
+
perIsland?: Record<string, { raw?: number; gz?: number }>;
|
|
60
|
+
/**
|
|
61
|
+
* Enforcement mode.
|
|
62
|
+
* - `'warning'` (default): print issues, continue build.
|
|
63
|
+
* - `'error'`: print issues, exit non-zero.
|
|
64
|
+
*
|
|
65
|
+
* The CLI owns the exit-code decision; this module only surfaces
|
|
66
|
+
* `mode` so reporters can colour-code output consistently.
|
|
67
|
+
*/
|
|
68
|
+
mode?: "error" | "warning";
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Severity of a single budget comparison outcome. `within10` is the yellow
|
|
73
|
+
* "approaching" band (≥90% of the limit) the HTML report uses to colour
|
|
74
|
+
* bars amber. The CLI treats `within10` as a non-failing warning even
|
|
75
|
+
* under `mode: 'error'` — the build only fails on `exceeded`.
|
|
76
|
+
*/
|
|
77
|
+
export type BudgetStatus = "within" | "within10" | "exceeded";
|
|
78
|
+
|
|
79
|
+
export interface BudgetIslandCheck {
|
|
80
|
+
/** Island / route id. */
|
|
81
|
+
name: string;
|
|
82
|
+
/** Raw bytes measured by the analyzer. */
|
|
83
|
+
raw: number;
|
|
84
|
+
/** Gzip bytes measured by the analyzer. */
|
|
85
|
+
gz: number;
|
|
86
|
+
/** Active raw ceiling for this island (per-island override or global). `null` when no raw ceiling applies. */
|
|
87
|
+
rawLimit: number | null;
|
|
88
|
+
/** Active gzip ceiling. `null` when no gzip ceiling applies. */
|
|
89
|
+
gzLimit: number | null;
|
|
90
|
+
/** Status derived from the stricter of `rawStatus` / `gzStatus`. */
|
|
91
|
+
status: BudgetStatus;
|
|
92
|
+
/** Per-axis status. */
|
|
93
|
+
rawStatus: BudgetStatus;
|
|
94
|
+
gzStatus: BudgetStatus;
|
|
95
|
+
/** True when a `perIsland[name]` entry overrode a global limit. */
|
|
96
|
+
overridden: boolean;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export interface BudgetTotalCheck {
|
|
100
|
+
raw: number;
|
|
101
|
+
gz: number;
|
|
102
|
+
rawLimit: number | null;
|
|
103
|
+
gzLimit: number | null;
|
|
104
|
+
status: BudgetStatus;
|
|
105
|
+
rawStatus: BudgetStatus;
|
|
106
|
+
gzStatus: BudgetStatus;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export interface BudgetReport {
|
|
110
|
+
/** Resolved mode (`'warning'` when the user omitted the field). */
|
|
111
|
+
mode: "error" | "warning";
|
|
112
|
+
/** One entry per island in {@link AnalyzeReport.islands}, input order preserved. */
|
|
113
|
+
islands: BudgetIslandCheck[];
|
|
114
|
+
/** Project-wide totals (only populated when a `maxTotal*` limit exists). */
|
|
115
|
+
total: BudgetTotalCheck | null;
|
|
116
|
+
/** True when at least one island or the total exceeded its limit. */
|
|
117
|
+
hasExceeded: boolean;
|
|
118
|
+
/** Convenience: total islands counted. */
|
|
119
|
+
islandCount: number;
|
|
120
|
+
/** Convenience: islands strictly `within` limits. */
|
|
121
|
+
withinCount: number;
|
|
122
|
+
/** Convenience: islands flagged `within10`. */
|
|
123
|
+
approachingCount: number;
|
|
124
|
+
/** Convenience: islands flagged `exceeded`. */
|
|
125
|
+
exceededCount: number;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// ============================================================================
|
|
129
|
+
// Defaults
|
|
130
|
+
// ============================================================================
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* The "nothing set" default. Applied when the user passes `build.budget`
|
|
134
|
+
* whose every ceiling field is `undefined` EXCEPT they also left
|
|
135
|
+
* `perIsland` / `maxTotal*` off — effectively a literal `{}` or a
|
|
136
|
+
* `{ mode: 'warning' }` with no thresholds. Chosen to roughly match the
|
|
137
|
+
* Next.js `largePageDataBytes` soft-warning threshold (128 KB gz) paired
|
|
138
|
+
* with Astro's "ship under 200 KB of JS" rule of thumb — 250 KB gives
|
|
139
|
+
* app-shell + React-runtime + a handful of libraries breathing room
|
|
140
|
+
* before the warning fires.
|
|
141
|
+
*
|
|
142
|
+
* Setting any explicit field (even `maxRawBytes: 99999999`) disables the
|
|
143
|
+
* auto-default. This lets `build.budget: {}` be an explicit opt-out.
|
|
144
|
+
*
|
|
145
|
+
* Exported so docs generators, tests, and tooling can surface the exact
|
|
146
|
+
* number without hard-coding.
|
|
147
|
+
*/
|
|
148
|
+
export const DEFAULT_BUDGET_MAX_GZ_BYTES = 250_000;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Return `true` when every ceiling-bearing field is missing. We then
|
|
152
|
+
* inject the {@link DEFAULT_BUDGET_MAX_GZ_BYTES} default. An empty object
|
|
153
|
+
* (`{}`) counts as "all fields missing" — the caller passed a budget
|
|
154
|
+
* block on purpose but left everything unset. We still apply the default
|
|
155
|
+
* to honour the documented behaviour: "declaring a budget block (even
|
|
156
|
+
* empty) turns on the default 250 KB gzip cap". Users opt out of the
|
|
157
|
+
* default entirely by omitting the `build.budget` field.
|
|
158
|
+
*/
|
|
159
|
+
function hasNoCeilings(b: BundleBudget): boolean {
|
|
160
|
+
return (
|
|
161
|
+
b.maxRawBytes === undefined &&
|
|
162
|
+
b.maxGzBytes === undefined &&
|
|
163
|
+
b.maxTotalRawBytes === undefined &&
|
|
164
|
+
b.maxTotalGzBytes === undefined &&
|
|
165
|
+
(b.perIsland === undefined || Object.keys(b.perIsland).length === 0)
|
|
166
|
+
);
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Produce the effective budget the evaluator uses after applying
|
|
171
|
+
* defaults. Exported for tests and docs so the "what will actually be
|
|
172
|
+
* enforced" answer is one call away.
|
|
173
|
+
*/
|
|
174
|
+
export function resolveBudget(input: BundleBudget | undefined): BundleBudget | null {
|
|
175
|
+
if (!input) return null;
|
|
176
|
+
const base: BundleBudget = { ...input };
|
|
177
|
+
base.mode = input.mode ?? "warning";
|
|
178
|
+
if (hasNoCeilings(base)) {
|
|
179
|
+
base.maxGzBytes = DEFAULT_BUDGET_MAX_GZ_BYTES;
|
|
180
|
+
}
|
|
181
|
+
return base;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
// ============================================================================
|
|
185
|
+
// Evaluation
|
|
186
|
+
// ============================================================================
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* 10% of the limit is the yellow band. Pulled out so tests and the HTML
|
|
190
|
+
* report can reference the same constant.
|
|
191
|
+
*/
|
|
192
|
+
export const APPROACHING_THRESHOLD_RATIO = 0.9;
|
|
193
|
+
|
|
194
|
+
function classify(size: number, limit: number | null): BudgetStatus {
|
|
195
|
+
if (limit === null) return "within";
|
|
196
|
+
if (size > limit) return "exceeded";
|
|
197
|
+
if (size >= limit * APPROACHING_THRESHOLD_RATIO) return "within10";
|
|
198
|
+
return "within";
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* The "worst" status across two axes. `exceeded` wins over `within10`
|
|
203
|
+
* wins over `within`. Used to derive an island's composite status from
|
|
204
|
+
* its per-axis (raw, gz) results.
|
|
205
|
+
*/
|
|
206
|
+
function worstStatus(a: BudgetStatus, b: BudgetStatus): BudgetStatus {
|
|
207
|
+
if (a === "exceeded" || b === "exceeded") return "exceeded";
|
|
208
|
+
if (a === "within10" || b === "within10") return "within10";
|
|
209
|
+
return "within";
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Compare `report` against `budget` and produce the decision record.
|
|
214
|
+
*
|
|
215
|
+
* `budget === undefined` → the caller opted out entirely; we return
|
|
216
|
+
* `null` so the CLI can skip printing the budget section.
|
|
217
|
+
*/
|
|
218
|
+
export function evaluateBudget(
|
|
219
|
+
report: AnalyzeReport,
|
|
220
|
+
budget: BundleBudget | undefined
|
|
221
|
+
): BudgetReport | null {
|
|
222
|
+
const resolved = resolveBudget(budget);
|
|
223
|
+
if (resolved === null) return null;
|
|
224
|
+
|
|
225
|
+
const perIsland = resolved.perIsland ?? {};
|
|
226
|
+
const islands: BudgetIslandCheck[] = report.islands.map((is) => {
|
|
227
|
+
const override = perIsland[is.name];
|
|
228
|
+
const hasOverride = override !== undefined;
|
|
229
|
+
// Per-island override replaces the global cap on the axis it sets.
|
|
230
|
+
// When a user writes `perIsland: { home: { raw: 50_000 } }` we still
|
|
231
|
+
// apply the global `maxGzBytes` to `home`'s gzip size — the override
|
|
232
|
+
// is additive per-axis, not a full replacement. This matches user
|
|
233
|
+
// intent: "tighten this one axis, leave the others under the global".
|
|
234
|
+
const rawLimit =
|
|
235
|
+
override?.raw !== undefined
|
|
236
|
+
? override.raw
|
|
237
|
+
: resolved.maxRawBytes !== undefined
|
|
238
|
+
? resolved.maxRawBytes
|
|
239
|
+
: null;
|
|
240
|
+
const gzLimit =
|
|
241
|
+
override?.gz !== undefined
|
|
242
|
+
? override.gz
|
|
243
|
+
: resolved.maxGzBytes !== undefined
|
|
244
|
+
? resolved.maxGzBytes
|
|
245
|
+
: null;
|
|
246
|
+
const rawStatus = classify(is.totalRaw, rawLimit);
|
|
247
|
+
const gzStatus = classify(is.totalGz, gzLimit);
|
|
248
|
+
return {
|
|
249
|
+
name: is.name,
|
|
250
|
+
raw: is.totalRaw,
|
|
251
|
+
gz: is.totalGz,
|
|
252
|
+
rawLimit,
|
|
253
|
+
gzLimit,
|
|
254
|
+
status: worstStatus(rawStatus, gzStatus),
|
|
255
|
+
rawStatus,
|
|
256
|
+
gzStatus,
|
|
257
|
+
overridden: hasOverride,
|
|
258
|
+
};
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
// Total check — ONLY populated when at least one total ceiling exists.
|
|
262
|
+
// We intentionally do not fall back on per-island aggregates; if the
|
|
263
|
+
// user wants "every island < 200 KB AND the whole project < 2 MB",
|
|
264
|
+
// they must say so explicitly.
|
|
265
|
+
let total: BudgetTotalCheck | null = null;
|
|
266
|
+
if (
|
|
267
|
+
resolved.maxTotalRawBytes !== undefined ||
|
|
268
|
+
resolved.maxTotalGzBytes !== undefined
|
|
269
|
+
) {
|
|
270
|
+
const rawLimit = resolved.maxTotalRawBytes ?? null;
|
|
271
|
+
const gzLimit = resolved.maxTotalGzBytes ?? null;
|
|
272
|
+
const rawStatus = classify(report.summary.totalRaw, rawLimit);
|
|
273
|
+
const gzStatus = classify(report.summary.totalGz, gzLimit);
|
|
274
|
+
total = {
|
|
275
|
+
raw: report.summary.totalRaw,
|
|
276
|
+
gz: report.summary.totalGz,
|
|
277
|
+
rawLimit,
|
|
278
|
+
gzLimit,
|
|
279
|
+
status: worstStatus(rawStatus, gzStatus),
|
|
280
|
+
rawStatus,
|
|
281
|
+
gzStatus,
|
|
282
|
+
};
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
let withinCount = 0;
|
|
286
|
+
let approachingCount = 0;
|
|
287
|
+
let exceededCount = 0;
|
|
288
|
+
for (const i of islands) {
|
|
289
|
+
if (i.status === "exceeded") exceededCount++;
|
|
290
|
+
else if (i.status === "within10") approachingCount++;
|
|
291
|
+
else withinCount++;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
const hasExceeded =
|
|
295
|
+
exceededCount > 0 || (total !== null && total.status === "exceeded");
|
|
296
|
+
|
|
297
|
+
return {
|
|
298
|
+
mode: resolved.mode ?? "warning",
|
|
299
|
+
islands,
|
|
300
|
+
total,
|
|
301
|
+
hasExceeded,
|
|
302
|
+
islandCount: islands.length,
|
|
303
|
+
withinCount,
|
|
304
|
+
approachingCount,
|
|
305
|
+
exceededCount,
|
|
306
|
+
};
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
// ============================================================================
|
|
310
|
+
// Formatting helpers (CLI + HTML report consumers)
|
|
311
|
+
// ============================================================================
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Human-readable byte formatter. Kept local (tiny, no import cycle) so
|
|
315
|
+
* this module stays self-contained. Mirrors `analyzer.fmtBytes` output
|
|
316
|
+
* format for consistency in build logs.
|
|
317
|
+
*/
|
|
318
|
+
export function formatBudgetBytes(n: number): string {
|
|
319
|
+
if (!Number.isFinite(n) || n <= 0) return "0 B";
|
|
320
|
+
if (n < 1024) return `${n} B`;
|
|
321
|
+
if (n < 1024 * 1024) return `${(n / 1024).toFixed(1)} KB`;
|
|
322
|
+
return `${(n / (1024 * 1024)).toFixed(2)} MB`;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* ASCII breakdown table. Used by the CLI when `--no-budget` is NOT set
|
|
327
|
+
* and at least one check is warning/exceeded. Pure — returns the
|
|
328
|
+
* already-formatted multi-line string so tests can snapshot it.
|
|
329
|
+
*
|
|
330
|
+
* Example:
|
|
331
|
+
*
|
|
332
|
+
* ┌─────────────┬──────────┬──────────┬─────────┬─────────┐
|
|
333
|
+
* │ island │ raw │ gz │ raw lim │ gz lim │
|
|
334
|
+
* ├─────────────┼──────────┼──────────┼─────────┼─────────┤
|
|
335
|
+
* │ home EXC │ 512.0 KB │ 180.0 KB │ — │ 50.0 KB │
|
|
336
|
+
* │ dashboard │ 12.3 KB │ 4.1 KB │ — │ 50.0 KB │
|
|
337
|
+
* └─────────────┴──────────┴──────────┴─────────┴─────────┘
|
|
338
|
+
*/
|
|
339
|
+
export function formatBudgetTable(report: BudgetReport): string {
|
|
340
|
+
const rows: string[][] = [["island", "raw", "gz", "raw lim", "gz lim", "status"]];
|
|
341
|
+
for (const i of report.islands) {
|
|
342
|
+
rows.push([
|
|
343
|
+
i.name + (i.overridden ? "*" : ""),
|
|
344
|
+
formatBudgetBytes(i.raw),
|
|
345
|
+
formatBudgetBytes(i.gz),
|
|
346
|
+
i.rawLimit === null ? "—" : formatBudgetBytes(i.rawLimit),
|
|
347
|
+
i.gzLimit === null ? "—" : formatBudgetBytes(i.gzLimit),
|
|
348
|
+
statusLabel(i.status),
|
|
349
|
+
]);
|
|
350
|
+
}
|
|
351
|
+
if (report.total) {
|
|
352
|
+
rows.push([
|
|
353
|
+
"<total>",
|
|
354
|
+
formatBudgetBytes(report.total.raw),
|
|
355
|
+
formatBudgetBytes(report.total.gz),
|
|
356
|
+
report.total.rawLimit === null ? "—" : formatBudgetBytes(report.total.rawLimit),
|
|
357
|
+
report.total.gzLimit === null ? "—" : formatBudgetBytes(report.total.gzLimit),
|
|
358
|
+
statusLabel(report.total.status),
|
|
359
|
+
]);
|
|
360
|
+
}
|
|
361
|
+
// Compute column widths.
|
|
362
|
+
const widths = rows[0].map((_, c) =>
|
|
363
|
+
Math.max(...rows.map((r) => r[c].length))
|
|
364
|
+
);
|
|
365
|
+
const line = (ch = " ") =>
|
|
366
|
+
"│" + widths.map((w) => " " + ch.repeat(w) + " ").join("│") + "│";
|
|
367
|
+
const divider = (left: string, mid: string, right: string, fill = "─") =>
|
|
368
|
+
left + widths.map((w) => fill.repeat(w + 2)).join(mid) + right;
|
|
369
|
+
|
|
370
|
+
const out: string[] = [];
|
|
371
|
+
out.push(divider("┌", "┬", "┐"));
|
|
372
|
+
out.push(
|
|
373
|
+
"│" +
|
|
374
|
+
rows[0]
|
|
375
|
+
.map((cell, c) => " " + cell.padEnd(widths[c]) + " ")
|
|
376
|
+
.join("│") +
|
|
377
|
+
"│"
|
|
378
|
+
);
|
|
379
|
+
out.push(divider("├", "┼", "┤"));
|
|
380
|
+
for (let r = 1; r < rows.length; r++) {
|
|
381
|
+
out.push(
|
|
382
|
+
"│" +
|
|
383
|
+
rows[r]
|
|
384
|
+
.map((cell, c) => " " + cell.padEnd(widths[c]) + " ")
|
|
385
|
+
.join("│") +
|
|
386
|
+
"│"
|
|
387
|
+
);
|
|
388
|
+
}
|
|
389
|
+
out.push(divider("└", "┴", "┘"));
|
|
390
|
+
// Suppress unused `line` var — kept for future ruled rows.
|
|
391
|
+
void line;
|
|
392
|
+
return out.join("\n");
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
function statusLabel(s: BudgetStatus): string {
|
|
396
|
+
switch (s) {
|
|
397
|
+
case "exceeded":
|
|
398
|
+
return "EXCEEDED";
|
|
399
|
+
case "within10":
|
|
400
|
+
return "APPROACHING";
|
|
401
|
+
case "within":
|
|
402
|
+
return "OK";
|
|
403
|
+
}
|
|
404
|
+
}
|