@mandujs/core 0.54.32 → 0.55.0-beta.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 +106 -210
- package/scripts/postinstall-lock.ts +153 -153
- 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 +15 -15
- package/src/a11y/types.ts +125 -125
- package/src/agent/__tests__/apply.test.ts +224 -0
- package/src/agent/__tests__/context.test.ts +97 -98
- package/src/agent/apply.ts +1031 -0
- package/src/agent/context.ts +552 -552
- package/src/agent/index.ts +4 -3
- package/src/agent/plan.ts +161 -243
- package/src/agent/repair.ts +239 -162
- package/src/agent/sync.ts +197 -198
- package/src/agent/types.ts +242 -94
- package/src/agent/verify.ts +55 -55
- package/src/auth/__tests__/login.test.ts +1 -1
- package/src/auth/__tests__/password.test.ts +15 -5
- package/src/auth/__tests__/reset.test.ts +2 -2
- 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 +14 -2
- 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/brain/doctor/analyzer.ts +7 -7
- package/src/bundler/__snapshots__/build.test.ts.snap +5 -5
- package/src/bundler/__tests__/build-runner.ts +166 -166
- package/src/bundler/__tests__/client-boundary-transform.test.ts +524 -524
- package/src/bundler/__tests__/cold-start.test.ts +60 -60
- package/src/bundler/__tests__/css.test.ts +49 -20
- 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 +24 -24
- package/src/bundler/__tests__/generation.test.ts +447 -0
- package/src/bundler/__tests__/hdr.test.ts +24 -18
- package/src/bundler/__tests__/hmr-client.test.ts +62 -24
- package/src/bundler/__tests__/jsx-runtime-shim.test.ts +179 -140
- package/src/bundler/__tests__/manifest-schema.test.ts +305 -266
- package/src/bundler/__tests__/prod-smoke.test.ts +138 -138
- package/src/bundler/__tests__/reverse-import-graph.test.ts +42 -42
- 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/analyzer.ts +15 -15
- package/src/bundler/budget.ts +404 -404
- package/src/bundler/build.test.ts +898 -915
- package/src/bundler/build.ts +113 -24
- package/src/bundler/client-boundary-transform.ts +977 -977
- package/src/bundler/css.ts +65 -44
- package/src/bundler/dev.ts +105 -73
- package/src/bundler/fast-refresh-preamble.ts +47 -47
- package/src/bundler/generation.ts +602 -0
- package/src/bundler/index.ts +3 -3
- package/src/bundler/manifest-schema.ts +55 -40
- package/src/bundler/plugins/__tests__/block-generated-imports.test.ts +13 -13
- 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 +16 -15
- 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/prerender.ts +29 -9
- package/src/bundler/reverse-import-graph.ts +339 -339
- package/src/bundler/safe-build.test.ts +1 -1
- package/src/bundler/safe-build.ts +103 -103
- package/src/bundler/scenario-matrix.ts +229 -229
- package/src/bundler/types.ts +58 -56
- 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__/props-serialization.test.ts +37 -37
- 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 +2 -2
- package/src/client/index.ts +1 -1
- package/src/client/island.ts +79 -79
- package/src/client/prefetch-helper.ts +55 -55
- package/src/client/props-serialization.ts +233 -233
- package/src/client/runtime-entry.ts +598 -598
- package/src/client/runtime.ts +1 -1
- package/src/client/serialize.ts +50 -50
- 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-compat.ts +3 -0
- package/src/components/Image.tsx +162 -162
- package/src/config/validate.ts +1 -1
- package/src/config/watcher.ts +311 -311
- package/src/constants.ts +40 -40
- package/src/content/collection.ts +9 -9
- 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/generate-types.ts +1 -1
- package/src/content/index.ts +2 -2
- 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/types.ts +58 -58
- package/src/db/__tests__/db.test.ts +9 -9
- package/src/db/index.ts +2 -2
- 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 +82 -82
- 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__/smoke.test.ts +2 -2
- package/src/desktop/__tests__/webview-fallback.test.ts +12 -32
- package/src/desktop/__tests__/window.test.ts +20 -99
- 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/webview-fallback.ts +17 -4
- package/src/desktop/window.ts +17 -8
- 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/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 +16 -16
- package/src/devtools/client/components/panel/network-panel.tsx +291 -291
- package/src/devtools/client/components/panel/panel-container.tsx +1 -1
- 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/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/types.ts +35 -35
- package/src/devtools/worker/index.ts +25 -25
- package/src/devtools/worker/redaction-worker.ts +233 -233
- package/src/diagnose/__tests__/checks.test.ts +136 -136
- package/src/diagnose/checks.ts +185 -185
- package/src/diagnose/index.ts +17 -17
- package/src/diagnose/run.ts +10 -10
- 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/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 +5 -1
- package/src/filling/auth.ts +308 -308
- package/src/filling/body-parse.test.ts +60 -60
- package/src/filling/cookie-codec.ts +5 -3
- package/src/filling/deps.ts +265 -265
- package/src/filling/head-method.test.ts +154 -154
- 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/generate.ts +30 -30
- package/src/generator/index.ts +3 -3
- package/src/generator/templates.test.ts +48 -48
- package/src/generator/templates.ts +219 -219
- 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/check.ts +39 -24
- package/src/guard/config-guard.ts +13 -13
- 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/fs-routes-policy.ts +51 -51
- package/src/guard/graph.ts +1 -1
- package/src/guard/healing.ts +36 -36
- package/src/guard/index.ts +11 -11
- 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/__tests__/id.test.ts +3 -3
- package/src/id/index.ts +105 -105
- package/src/index.ts +9 -48
- package/src/internal/client-boundary.ts +266 -266
- package/src/internal/index.ts +2 -2
- package/src/kitchen/api/agent-devtools-api.ts +779 -779
- package/src/kitchen/api/bundle-inspector.ts +179 -0
- package/src/kitchen/api/errors-grouping.ts +126 -126
- package/src/kitchen/api/file-api.ts +11 -11
- package/src/kitchen/kitchen-handler.ts +36 -0
- package/src/kitchen/kitchen-ui.ts +456 -0
- 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/perf/user-marks.ts +1 -1
- 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 +7 -7
- package/src/resource/__tests__/schema.test.ts +14 -14
- package/src/resource/ddl/__tests__/diff.test.ts +639 -639
- package/src/resource/ddl/__tests__/emit.test.ts +165 -165
- package/src/resource/ddl/__tests__/snapshot.test.ts +499 -499
- package/src/resource/ddl/emit.ts +146 -146
- 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/generator-schema.ts +11 -11
- package/src/resource/generators/slot.ts +72 -72
- package/src/resource/schema.ts +21 -21
- package/src/router/client-entry.test.ts +227 -227
- package/src/router/client-entry.ts +218 -218
- package/src/router/fs-patterns.test.ts +96 -96
- package/src/router/fs-routes.test.ts +532 -532
- package/src/router/fs-routes.ts +53 -53
- package/src/router/fs-scanner.ts +216 -216
- package/src/router/fs-types.ts +19 -19
- package/src/router/route-source-analyzer.ts +521 -521
- 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__/devtools-adapter.test.ts +68 -68
- 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__/inline-client-hydration.test.ts +237 -237
- package/src/runtime/__tests__/not-found.test.ts +152 -152
- package/src/runtime/__tests__/observability-lifecycle.test.ts +103 -103
- package/src/runtime/__tests__/page-render-response.test.ts +517 -517
- package/src/runtime/__tests__/request-middleware.test.ts +70 -70
- package/src/runtime/__tests__/searchparams-page-props.test.ts +81 -81
- 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/devtools-adapter.ts +68 -68
- package/src/runtime/escape.ts +34 -34
- package/src/runtime/fast-refresh-runtime.ts +322 -322
- package/src/runtime/fast-refresh-types.ts +1 -1
- package/src/runtime/handler.ts +65 -65
- package/src/runtime/handlers.ts +30 -11
- 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/observability-lifecycle.ts +290 -290
- package/src/runtime/openapi-endpoint.ts +236 -236
- package/src/runtime/page-render-response.ts +287 -274
- package/src/runtime/ppr.ts +74 -74
- package/src/runtime/rate-limit.ts +1 -1
- package/src/runtime/redirect.ts +1 -1
- package/src/runtime/registry.ts +171 -171
- package/src/runtime/request-middleware.ts +31 -31
- package/src/runtime/router.test.ts +4 -4
- package/src/runtime/router.ts +10 -10
- package/src/runtime/server.ts +127 -211
- package/src/runtime/shims.ts +48 -48
- package/src/runtime/ssr.ts +43 -17
- package/src/runtime/static-files.ts +369 -289
- package/src/runtime/streaming-ssr.ts +219 -180
- package/src/runtime/trace.ts +144 -144
- package/src/scheduler/__tests__/scheduler.test.ts +12 -11
- package/src/scheduler/index.ts +11 -5
- 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/spec/schema.ts +35 -35
- 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/index.ts +9 -3
- package/src/testing/lcov.ts +192 -0
- 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/__tests__/watcher.test.ts +59 -59
- package/src/watcher/watcher.ts +61 -61
|
@@ -4,7 +4,7 @@ import { GUARD_RULES } from "./rules";
|
|
|
4
4
|
import { runGuardCheck } from "./check";
|
|
5
5
|
import { generateRoutes } from "../generator/generate";
|
|
6
6
|
import { beginChange, commitChange, rollbackChange } from "../change";
|
|
7
|
-
|
|
7
|
+
|
|
8
8
|
|
|
9
9
|
export interface AutoCorrectStep {
|
|
10
10
|
ruleId: string;
|
package/src/guard/check.ts
CHANGED
|
@@ -26,25 +26,37 @@ export interface GuardCheckResult {
|
|
|
26
26
|
* plugin `block-generated-imports` so both paths surface the same
|
|
27
27
|
* remediation target.
|
|
28
28
|
*/
|
|
29
|
-
export const GENERATED_IMPORT_DOCS_URL =
|
|
30
|
-
"https://mandujs.com/docs/architect/generated-access";
|
|
29
|
+
export const GENERATED_IMPORT_DOCS_URL =
|
|
30
|
+
"https://mandujs.com/docs/architect/generated-access";
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Only Mandu application artifacts are registry-owned. Package-local build
|
|
34
|
+
* outputs such as `generated/cli-ux-manifest.js` are regular bundled modules
|
|
35
|
+
* and must not be mistaken for `.mandu/generated` or `__generated__` data.
|
|
36
|
+
*/
|
|
37
|
+
export const FORBIDDEN_GENERATED_IMPORT_PATTERN =
|
|
38
|
+
/__generated__|(?:^|[\/\\])\.mandu[\/\\]generated(?:[\/\\]|$)/;
|
|
39
|
+
|
|
40
|
+
export function isForbiddenGeneratedImport(specifier: string): boolean {
|
|
41
|
+
return FORBIDDEN_GENERATED_IMPORT_PATTERN.test(specifier);
|
|
42
|
+
}
|
|
31
43
|
|
|
32
44
|
/**
|
|
33
|
-
* Build the user-facing message for a detected direct generated-artifact
|
|
34
|
-
* import. `specifier` is the literal import string that tripped the guard
|
|
35
|
-
* (not the resolved path).
|
|
45
|
+
* Build the user-facing message for a detected direct generated-artifact
|
|
46
|
+
* import. `specifier` is the literal import string that tripped the guard
|
|
47
|
+
* (not the resolved path).
|
|
36
48
|
*
|
|
37
49
|
* This helper is the single source of truth for the message text — both
|
|
38
50
|
* the static Guard pass (`checkInvalidGeneratedImport`) and the bundler
|
|
39
51
|
* plugin (`blockGeneratedImports`) call through it so the two paths
|
|
40
52
|
* cannot drift.
|
|
41
53
|
*/
|
|
42
|
-
export function buildForbiddenGeneratedImportMessage(specifier: string): string {
|
|
43
|
-
return (
|
|
44
|
-
`Direct generated artifact imports are forbidden: ${specifier}. ` +
|
|
45
|
-
`Use the runtime registry: see ${GENERATED_IMPORT_DOCS_URL}`
|
|
46
|
-
);
|
|
47
|
-
}
|
|
54
|
+
export function buildForbiddenGeneratedImportMessage(specifier: string): string {
|
|
55
|
+
return (
|
|
56
|
+
`Direct generated artifact imports are forbidden: ${specifier}. ` +
|
|
57
|
+
`Use the runtime registry: see ${GENERATED_IMPORT_DOCS_URL}`
|
|
58
|
+
);
|
|
59
|
+
}
|
|
48
60
|
|
|
49
61
|
/**
|
|
50
62
|
* Shared remediation hint. Points at `getGenerated()` from
|
|
@@ -152,19 +164,22 @@ export async function checkInvalidGeneratedImport(
|
|
|
152
164
|
const content = await readFileContent(file);
|
|
153
165
|
if (!content) continue;
|
|
154
166
|
|
|
155
|
-
//
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
167
|
+
// Parse actual module edges so comments, fixture strings, and template
|
|
168
|
+
// literals cannot become false positives. Package-local `generated/`
|
|
169
|
+
// folders are not owned by the application registry.
|
|
170
|
+
const imports = extractImportsAST(content);
|
|
171
|
+
for (const imported of imports) {
|
|
172
|
+
if (imported.statement.trimStart().startsWith("import type")) continue;
|
|
173
|
+
if (!isForbiddenGeneratedImport(imported.path)) continue;
|
|
174
|
+
const relativePath = path.relative(rootDir, file);
|
|
175
|
+
violations.push({
|
|
176
|
+
ruleId: GUARD_RULES.INVALID_GENERATED_IMPORT.id,
|
|
177
|
+
file: relativePath,
|
|
178
|
+
message: buildForbiddenGeneratedImportMessage(imported.path),
|
|
179
|
+
suggestion: FORBIDDEN_GENERATED_IMPORT_SUGGESTION,
|
|
180
|
+
line: imported.line,
|
|
181
|
+
});
|
|
182
|
+
}
|
|
168
183
|
}
|
|
169
184
|
}
|
|
170
185
|
|
|
@@ -187,19 +187,19 @@ export function formatConfigGuardResult(result: ConfigGuardResult): string {
|
|
|
187
187
|
} else if (!result.lockfileExists) {
|
|
188
188
|
lines.push("💡 Lockfile 없음");
|
|
189
189
|
lines.push(" 'mandu lock'으로 생성 권장");
|
|
190
|
-
} else {
|
|
191
|
-
lines.push("❌ 설정 무결성 검증 실패");
|
|
192
|
-
|
|
193
|
-
for (const error of result.errors) {
|
|
194
|
-
lines.push(` 🔴 ${error.message}`);
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
lines.push("");
|
|
198
|
-
lines.push(" 다음 단계:");
|
|
199
|
-
lines.push(" ↳ 변경 확인: mandu lock --diff");
|
|
200
|
-
lines.push(" ↳ 의도한 변경이면: mandu lock");
|
|
201
|
-
lines.push(" ↳ 패키지 업데이트 직후라면 새 Mandu 기본값으로 lockfile을 갱신하세요.");
|
|
202
|
-
}
|
|
190
|
+
} else {
|
|
191
|
+
lines.push("❌ 설정 무결성 검증 실패");
|
|
192
|
+
|
|
193
|
+
for (const error of result.errors) {
|
|
194
|
+
lines.push(` 🔴 ${error.message}`);
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
lines.push("");
|
|
198
|
+
lines.push(" 다음 단계:");
|
|
199
|
+
lines.push(" ↳ 변경 확인: mandu lock --diff");
|
|
200
|
+
lines.push(" ↳ 의도한 변경이면: mandu lock");
|
|
201
|
+
lines.push(" ↳ 패키지 업데이트 직후라면 새 Mandu 기본값으로 lockfile을 갱신하세요.");
|
|
202
|
+
}
|
|
203
203
|
|
|
204
204
|
if (result.warnings.length > 0 && result.lockfileExists) {
|
|
205
205
|
lines.push("");
|
|
@@ -199,15 +199,15 @@ export async function checkContractSlotConsistency(
|
|
|
199
199
|
/**
|
|
200
200
|
* Run all contract-related guard checks
|
|
201
201
|
*/
|
|
202
|
-
export async function runContractGuardCheck(
|
|
203
|
-
manifest: RoutesManifest,
|
|
204
|
-
rootDir: string
|
|
205
|
-
): Promise<ContractViolation[]> {
|
|
206
|
-
const violations: ContractViolation[] = [];
|
|
207
|
-
|
|
208
|
-
// Check missing contracts (warning level)
|
|
209
|
-
const missingContracts = await checkMissingContract(manifest, rootDir);
|
|
210
|
-
violations.push(...missingContracts);
|
|
202
|
+
export async function runContractGuardCheck(
|
|
203
|
+
manifest: RoutesManifest,
|
|
204
|
+
rootDir: string
|
|
205
|
+
): Promise<ContractViolation[]> {
|
|
206
|
+
const violations: ContractViolation[] = [];
|
|
207
|
+
|
|
208
|
+
// Check missing contracts (warning level)
|
|
209
|
+
const missingContracts = await checkMissingContract(manifest, rootDir);
|
|
210
|
+
violations.push(...missingContracts);
|
|
211
211
|
|
|
212
212
|
// Check contract file exists
|
|
213
213
|
const notFoundContracts = await checkContractFileExists(manifest, rootDir);
|
package/src/guard/define-rule.ts
CHANGED
|
@@ -1,243 +1,243 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Phase 18.ν — Consumer-defined Guard rules.
|
|
3
|
-
*
|
|
4
|
-
* Ships `defineGuardRule()` + `GuardRule` / `GuardRuleContext` /
|
|
5
|
-
* `GuardViolation` types so consumers can extend Mandu's architecture
|
|
6
|
-
* guard without forking the framework. Rules declared via
|
|
7
|
-
* `mandu.config.ts` `guard.rules` are merged into the standard Guard
|
|
8
|
-
* report alongside Mandu's built-in presets (fsd/clean/hexagonal/atomic/
|
|
9
|
-
* cqrs/mandu).
|
|
10
|
-
*
|
|
11
|
-
* @module guard/define-rule
|
|
12
|
-
*
|
|
13
|
-
* @example Project-local "no axios" rule.
|
|
14
|
-
* ```ts
|
|
15
|
-
* // mandu.config.ts
|
|
16
|
-
* import { defineGuardRule } from "@mandujs/core/guard/define-rule";
|
|
17
|
-
*
|
|
18
|
-
* export default {
|
|
19
|
-
* guard: {
|
|
20
|
-
* rules: [
|
|
21
|
-
* defineGuardRule({
|
|
22
|
-
* id: "forbid-axios",
|
|
23
|
-
* severity: "error",
|
|
24
|
-
* description: "Use native fetch() instead of axios.",
|
|
25
|
-
* check: (ctx) => ctx.imports
|
|
26
|
-
* .filter((imp) => imp.path === "axios" || imp.path.startsWith("axios/"))
|
|
27
|
-
* .map((imp) => ({
|
|
28
|
-
* file: ctx.sourceFile,
|
|
29
|
-
* line: imp.line,
|
|
30
|
-
* message: `axios import at line ${imp.line} — use fetch().`,
|
|
31
|
-
* hint: "Replace with globalThis.fetch() or a thin wrapper.",
|
|
32
|
-
* })),
|
|
33
|
-
* }),
|
|
34
|
-
* ],
|
|
35
|
-
* },
|
|
36
|
-
* };
|
|
37
|
-
* ```
|
|
38
|
-
*/
|
|
39
|
-
|
|
40
|
-
import type { ExportInfo as AstExportInfo } from "./ast-analyzer";
|
|
41
|
-
import type { ImportInfo as AstImportInfo } from "./types";
|
|
42
|
-
import type { ManduConfig } from "../config/mandu";
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Severity emitted by a consumer-defined rule when it flags a file.
|
|
46
|
-
*
|
|
47
|
-
* - `"error"` — fails `mandu guard check` (non-zero exit code).
|
|
48
|
-
* - `"warning"` — surfaces in the report but keeps the exit code clean.
|
|
49
|
-
* - `"info"` — purely informational; useful for migration-phase
|
|
50
|
-
* rules that should not gate CI yet.
|
|
51
|
-
*
|
|
52
|
-
* The built-in `applyRuleSeverity()` downgrades `"info"` → `"warning"`
|
|
53
|
-
* when emitted through the unified report so the rest of the pipeline
|
|
54
|
-
* (reporter, CI formatter) does not have to special-case a third level.
|
|
55
|
-
*/
|
|
56
|
-
export type GuardRuleSeverity = "error" | "warning" | "info";
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* Information about a single import statement in the file being
|
|
60
|
-
* checked. Shape matches {@link AstImportInfo} from the Guard AST
|
|
61
|
-
* analyzer so rules can consume the two interchangeably.
|
|
62
|
-
*/
|
|
63
|
-
export type ImportInfo = AstImportInfo;
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* Information about a single export declaration in the file being
|
|
67
|
-
* checked. Shape matches {@link AstExportInfo}.
|
|
68
|
-
*/
|
|
69
|
-
export type ExportInfo = AstExportInfo;
|
|
70
|
-
|
|
71
|
-
/**
|
|
72
|
-
* Violation record emitted by a consumer-defined rule. The Guard
|
|
73
|
-
* runner prefixes `ruleId` with `custom:<rule.id>` when merging into
|
|
74
|
-
* the standard report, so the originating rule is always traceable in
|
|
75
|
-
* CI output.
|
|
76
|
-
*/
|
|
77
|
-
export interface GuardViolation {
|
|
78
|
-
/** Relative (preferred) or absolute file path where the violation occurs. */
|
|
79
|
-
file: string;
|
|
80
|
-
/** 1-indexed line number, if known. */
|
|
81
|
-
line?: number;
|
|
82
|
-
/** 1-indexed column number, if known. */
|
|
83
|
-
column?: number;
|
|
84
|
-
/** Human-readable message surfaced in the reporter. */
|
|
85
|
-
message: string;
|
|
86
|
-
/** Optional remediation hint. Shown alongside `message` in the CLI report. */
|
|
87
|
-
hint?: string;
|
|
88
|
-
/** Optional docs URL (rendered as a clickable link in supported terminals). */
|
|
89
|
-
docsUrl?: string;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
/**
|
|
93
|
-
* Per-file execution context handed to a rule's `check()` function.
|
|
94
|
-
* The runner parses imports/exports up front with the Guard AST
|
|
95
|
-
* analyzer so every rule gets a pre-tokenized view without paying the
|
|
96
|
-
* parse cost N times.
|
|
97
|
-
*/
|
|
98
|
-
export interface GuardRuleContext {
|
|
99
|
-
/** Absolute path of the file being checked. */
|
|
100
|
-
sourceFile: string;
|
|
101
|
-
/** Raw file content (UTF-8). */
|
|
102
|
-
content: string;
|
|
103
|
-
/** Parsed import statements (AST-level, comments/strings stripped). */
|
|
104
|
-
imports: ImportInfo[];
|
|
105
|
-
/** Parsed export declarations (AST-level). */
|
|
106
|
-
exports: ExportInfo[];
|
|
107
|
-
/** Resolved Mandu config — useful for rules that branch on project settings. */
|
|
108
|
-
config: ManduConfig;
|
|
109
|
-
/** Project root (absolute). Useful for computing relative paths for `file`. */
|
|
110
|
-
projectRoot: string;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* A consumer-defined Guard rule. Register an array of these under
|
|
115
|
-
* `mandu.config.ts` `guard.rules`.
|
|
116
|
-
*
|
|
117
|
-
* Rules are executed once per source file scanned by
|
|
118
|
-
* `checkInvalidGeneratedImport()`'s source-dir walker (packages/, src/,
|
|
119
|
-
* app/). Each rule's `check()` may be synchronous or asynchronous —
|
|
120
|
-
* the runner awaits both uniformly.
|
|
121
|
-
*
|
|
122
|
-
* @see {@link defineGuardRule}
|
|
123
|
-
*/
|
|
124
|
-
export interface GuardRule {
|
|
125
|
-
/**
|
|
126
|
-
* Stable rule identifier, e.g. `"company-no-axios"`. The runner
|
|
127
|
-
* prefixes this with `custom:` when emitting violations, so the final
|
|
128
|
-
* `ruleId` in the report is `custom:company-no-axios`.
|
|
129
|
-
*
|
|
130
|
-
* Must be unique within a config; duplicate ids trigger a
|
|
131
|
-
* config-load-time warning via `validateCustomRules()`.
|
|
132
|
-
*/
|
|
133
|
-
id: string;
|
|
134
|
-
/** Default severity for violations emitted by this rule. */
|
|
135
|
-
severity: GuardRuleSeverity;
|
|
136
|
-
/** One-line description surfaced in the reporter and in `mandu guard explain`. */
|
|
137
|
-
description: string;
|
|
138
|
-
/**
|
|
139
|
-
* Predicate that returns zero or more violations for the given file.
|
|
140
|
-
* May be sync or async; the runner awaits uniformly with a
|
|
141
|
-
* concurrency-limited `Promise.all`.
|
|
142
|
-
*
|
|
143
|
-
* Throwing inside `check()` is non-fatal — the runner catches the
|
|
144
|
-
* error, emits a `custom:<id>` violation with the thrown message,
|
|
145
|
-
* and continues scanning the rest of the files. This keeps one
|
|
146
|
-
* malformed rule from tearing down the whole report.
|
|
147
|
-
*/
|
|
148
|
-
check: (ctx: GuardRuleContext) => GuardViolation[] | Promise<GuardViolation[]>;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* Identity helper that returns the rule it was given. The only
|
|
153
|
-
* behavior-bearing piece is the type guard — `defineGuardRule()`
|
|
154
|
-
* validates the minimum shape (`id`, `severity`, `check`) at runtime
|
|
155
|
-
* so typos in a plain-JS `mandu.config.js` surface immediately instead
|
|
156
|
-
* of hiding inside the Guard runner.
|
|
157
|
-
*
|
|
158
|
-
* @throws `TypeError` when `rule` is missing a required field, or
|
|
159
|
-
* when `severity` is not one of `"error" | "warning" | "info"`.
|
|
160
|
-
*/
|
|
161
|
-
export function defineGuardRule(rule: GuardRule): GuardRule {
|
|
162
|
-
if (!rule || typeof rule !== "object") {
|
|
163
|
-
throw new TypeError("defineGuardRule: argument must be an object.");
|
|
164
|
-
}
|
|
165
|
-
if (typeof rule.id !== "string" || rule.id.length === 0) {
|
|
166
|
-
throw new TypeError("defineGuardRule: `id` must be a non-empty string.");
|
|
167
|
-
}
|
|
168
|
-
if (rule.severity !== "error" && rule.severity !== "warning" && rule.severity !== "info") {
|
|
169
|
-
throw new TypeError(
|
|
170
|
-
`defineGuardRule: \`severity\` must be one of "error" | "warning" | "info" (got ${JSON.stringify(rule.severity)}).`
|
|
171
|
-
);
|
|
172
|
-
}
|
|
173
|
-
if (typeof rule.check !== "function") {
|
|
174
|
-
throw new TypeError("defineGuardRule: `check` must be a function (sync or async).");
|
|
175
|
-
}
|
|
176
|
-
if (typeof rule.description !== "string") {
|
|
177
|
-
throw new TypeError("defineGuardRule: `description` must be a string.");
|
|
178
|
-
}
|
|
179
|
-
return rule;
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
/**
|
|
183
|
-
* Structural check used by the Zod `z.custom<GuardRule>()` guard in
|
|
184
|
-
* `config/validate.ts` and by `validateCustomRules()` at load time.
|
|
185
|
-
* Kept deliberately loose — we only reject values that are obviously
|
|
186
|
-
* not `GuardRule` objects; deeper validation (severity enum,
|
|
187
|
-
* description type) happens in `defineGuardRule()` for the clearest
|
|
188
|
-
* DX error, or in the runner (`check` throws) where the violation is
|
|
189
|
-
* reported in-band.
|
|
190
|
-
*/
|
|
191
|
-
export function isGuardRuleLike(value: unknown): value is GuardRule {
|
|
192
|
-
if (typeof value !== "object" || value === null) return false;
|
|
193
|
-
const obj = value as Record<string, unknown>;
|
|
194
|
-
if (typeof obj.id !== "string" || obj.id.length === 0) return false;
|
|
195
|
-
if (typeof obj.check !== "function") return false;
|
|
196
|
-
return true;
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
* Duplicate-id result returned by {@link validateCustomRules}.
|
|
201
|
-
*/
|
|
202
|
-
export interface DuplicateRuleId {
|
|
203
|
-
id: string;
|
|
204
|
-
/** Zero-indexed positions in the original array where the id appears. */
|
|
205
|
-
indices: number[];
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
/**
|
|
209
|
-
* Structural validation executed at config-load. Returns the list of
|
|
210
|
-
* duplicate ids plus a list of entries that failed {@link isGuardRuleLike}.
|
|
211
|
-
* The CLI prints a warning per duplicate; malformed rules are surfaced
|
|
212
|
-
* via Zod's standard error path.
|
|
213
|
-
*/
|
|
214
|
-
export function validateCustomRules(rules: readonly unknown[]): {
|
|
215
|
-
duplicates: DuplicateRuleId[];
|
|
216
|
-
malformed: number[];
|
|
217
|
-
} {
|
|
218
|
-
const duplicates: DuplicateRuleId[] = [];
|
|
219
|
-
const malformed: number[] = [];
|
|
220
|
-
const seen = new Map<string, number[]>();
|
|
221
|
-
|
|
222
|
-
for (let i = 0; i < rules.length; i++) {
|
|
223
|
-
const rule = rules[i];
|
|
224
|
-
if (!isGuardRuleLike(rule)) {
|
|
225
|
-
malformed.push(i);
|
|
226
|
-
continue;
|
|
227
|
-
}
|
|
228
|
-
const existing = seen.get(rule.id);
|
|
229
|
-
if (existing) {
|
|
230
|
-
existing.push(i);
|
|
231
|
-
} else {
|
|
232
|
-
seen.set(rule.id, [i]);
|
|
233
|
-
}
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
for (const [id, indices] of seen) {
|
|
237
|
-
if (indices.length > 1) {
|
|
238
|
-
duplicates.push({ id, indices });
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
return { duplicates, malformed };
|
|
243
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Phase 18.ν — Consumer-defined Guard rules.
|
|
3
|
+
*
|
|
4
|
+
* Ships `defineGuardRule()` + `GuardRule` / `GuardRuleContext` /
|
|
5
|
+
* `GuardViolation` types so consumers can extend Mandu's architecture
|
|
6
|
+
* guard without forking the framework. Rules declared via
|
|
7
|
+
* `mandu.config.ts` `guard.rules` are merged into the standard Guard
|
|
8
|
+
* report alongside Mandu's built-in presets (fsd/clean/hexagonal/atomic/
|
|
9
|
+
* cqrs/mandu).
|
|
10
|
+
*
|
|
11
|
+
* @module guard/define-rule
|
|
12
|
+
*
|
|
13
|
+
* @example Project-local "no axios" rule.
|
|
14
|
+
* ```ts
|
|
15
|
+
* // mandu.config.ts
|
|
16
|
+
* import { defineGuardRule } from "@mandujs/core/compat/guard/define-rule";
|
|
17
|
+
*
|
|
18
|
+
* export default {
|
|
19
|
+
* guard: {
|
|
20
|
+
* rules: [
|
|
21
|
+
* defineGuardRule({
|
|
22
|
+
* id: "forbid-axios",
|
|
23
|
+
* severity: "error",
|
|
24
|
+
* description: "Use native fetch() instead of axios.",
|
|
25
|
+
* check: (ctx) => ctx.imports
|
|
26
|
+
* .filter((imp) => imp.path === "axios" || imp.path.startsWith("axios/"))
|
|
27
|
+
* .map((imp) => ({
|
|
28
|
+
* file: ctx.sourceFile,
|
|
29
|
+
* line: imp.line,
|
|
30
|
+
* message: `axios import at line ${imp.line} — use fetch().`,
|
|
31
|
+
* hint: "Replace with globalThis.fetch() or a thin wrapper.",
|
|
32
|
+
* })),
|
|
33
|
+
* }),
|
|
34
|
+
* ],
|
|
35
|
+
* },
|
|
36
|
+
* };
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
import type { ExportInfo as AstExportInfo } from "./ast-analyzer";
|
|
41
|
+
import type { ImportInfo as AstImportInfo } from "./types";
|
|
42
|
+
import type { ManduConfig } from "../config/mandu";
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Severity emitted by a consumer-defined rule when it flags a file.
|
|
46
|
+
*
|
|
47
|
+
* - `"error"` — fails `mandu guard check` (non-zero exit code).
|
|
48
|
+
* - `"warning"` — surfaces in the report but keeps the exit code clean.
|
|
49
|
+
* - `"info"` — purely informational; useful for migration-phase
|
|
50
|
+
* rules that should not gate CI yet.
|
|
51
|
+
*
|
|
52
|
+
* The built-in `applyRuleSeverity()` downgrades `"info"` → `"warning"`
|
|
53
|
+
* when emitted through the unified report so the rest of the pipeline
|
|
54
|
+
* (reporter, CI formatter) does not have to special-case a third level.
|
|
55
|
+
*/
|
|
56
|
+
export type GuardRuleSeverity = "error" | "warning" | "info";
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Information about a single import statement in the file being
|
|
60
|
+
* checked. Shape matches {@link AstImportInfo} from the Guard AST
|
|
61
|
+
* analyzer so rules can consume the two interchangeably.
|
|
62
|
+
*/
|
|
63
|
+
export type ImportInfo = AstImportInfo;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Information about a single export declaration in the file being
|
|
67
|
+
* checked. Shape matches {@link AstExportInfo}.
|
|
68
|
+
*/
|
|
69
|
+
export type ExportInfo = AstExportInfo;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Violation record emitted by a consumer-defined rule. The Guard
|
|
73
|
+
* runner prefixes `ruleId` with `custom:<rule.id>` when merging into
|
|
74
|
+
* the standard report, so the originating rule is always traceable in
|
|
75
|
+
* CI output.
|
|
76
|
+
*/
|
|
77
|
+
export interface GuardViolation {
|
|
78
|
+
/** Relative (preferred) or absolute file path where the violation occurs. */
|
|
79
|
+
file: string;
|
|
80
|
+
/** 1-indexed line number, if known. */
|
|
81
|
+
line?: number;
|
|
82
|
+
/** 1-indexed column number, if known. */
|
|
83
|
+
column?: number;
|
|
84
|
+
/** Human-readable message surfaced in the reporter. */
|
|
85
|
+
message: string;
|
|
86
|
+
/** Optional remediation hint. Shown alongside `message` in the CLI report. */
|
|
87
|
+
hint?: string;
|
|
88
|
+
/** Optional docs URL (rendered as a clickable link in supported terminals). */
|
|
89
|
+
docsUrl?: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Per-file execution context handed to a rule's `check()` function.
|
|
94
|
+
* The runner parses imports/exports up front with the Guard AST
|
|
95
|
+
* analyzer so every rule gets a pre-tokenized view without paying the
|
|
96
|
+
* parse cost N times.
|
|
97
|
+
*/
|
|
98
|
+
export interface GuardRuleContext {
|
|
99
|
+
/** Absolute path of the file being checked. */
|
|
100
|
+
sourceFile: string;
|
|
101
|
+
/** Raw file content (UTF-8). */
|
|
102
|
+
content: string;
|
|
103
|
+
/** Parsed import statements (AST-level, comments/strings stripped). */
|
|
104
|
+
imports: ImportInfo[];
|
|
105
|
+
/** Parsed export declarations (AST-level). */
|
|
106
|
+
exports: ExportInfo[];
|
|
107
|
+
/** Resolved Mandu config — useful for rules that branch on project settings. */
|
|
108
|
+
config: ManduConfig;
|
|
109
|
+
/** Project root (absolute). Useful for computing relative paths for `file`. */
|
|
110
|
+
projectRoot: string;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* A consumer-defined Guard rule. Register an array of these under
|
|
115
|
+
* `mandu.config.ts` `guard.rules`.
|
|
116
|
+
*
|
|
117
|
+
* Rules are executed once per source file scanned by
|
|
118
|
+
* `checkInvalidGeneratedImport()`'s source-dir walker (packages/, src/,
|
|
119
|
+
* app/). Each rule's `check()` may be synchronous or asynchronous —
|
|
120
|
+
* the runner awaits both uniformly.
|
|
121
|
+
*
|
|
122
|
+
* @see {@link defineGuardRule}
|
|
123
|
+
*/
|
|
124
|
+
export interface GuardRule {
|
|
125
|
+
/**
|
|
126
|
+
* Stable rule identifier, e.g. `"company-no-axios"`. The runner
|
|
127
|
+
* prefixes this with `custom:` when emitting violations, so the final
|
|
128
|
+
* `ruleId` in the report is `custom:company-no-axios`.
|
|
129
|
+
*
|
|
130
|
+
* Must be unique within a config; duplicate ids trigger a
|
|
131
|
+
* config-load-time warning via `validateCustomRules()`.
|
|
132
|
+
*/
|
|
133
|
+
id: string;
|
|
134
|
+
/** Default severity for violations emitted by this rule. */
|
|
135
|
+
severity: GuardRuleSeverity;
|
|
136
|
+
/** One-line description surfaced in the reporter and in `mandu guard explain`. */
|
|
137
|
+
description: string;
|
|
138
|
+
/**
|
|
139
|
+
* Predicate that returns zero or more violations for the given file.
|
|
140
|
+
* May be sync or async; the runner awaits uniformly with a
|
|
141
|
+
* concurrency-limited `Promise.all`.
|
|
142
|
+
*
|
|
143
|
+
* Throwing inside `check()` is non-fatal — the runner catches the
|
|
144
|
+
* error, emits a `custom:<id>` violation with the thrown message,
|
|
145
|
+
* and continues scanning the rest of the files. This keeps one
|
|
146
|
+
* malformed rule from tearing down the whole report.
|
|
147
|
+
*/
|
|
148
|
+
check: (ctx: GuardRuleContext) => GuardViolation[] | Promise<GuardViolation[]>;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Identity helper that returns the rule it was given. The only
|
|
153
|
+
* behavior-bearing piece is the type guard — `defineGuardRule()`
|
|
154
|
+
* validates the minimum shape (`id`, `severity`, `check`) at runtime
|
|
155
|
+
* so typos in a plain-JS `mandu.config.js` surface immediately instead
|
|
156
|
+
* of hiding inside the Guard runner.
|
|
157
|
+
*
|
|
158
|
+
* @throws `TypeError` when `rule` is missing a required field, or
|
|
159
|
+
* when `severity` is not one of `"error" | "warning" | "info"`.
|
|
160
|
+
*/
|
|
161
|
+
export function defineGuardRule(rule: GuardRule): GuardRule {
|
|
162
|
+
if (!rule || typeof rule !== "object") {
|
|
163
|
+
throw new TypeError("defineGuardRule: argument must be an object.");
|
|
164
|
+
}
|
|
165
|
+
if (typeof rule.id !== "string" || rule.id.length === 0) {
|
|
166
|
+
throw new TypeError("defineGuardRule: `id` must be a non-empty string.");
|
|
167
|
+
}
|
|
168
|
+
if (rule.severity !== "error" && rule.severity !== "warning" && rule.severity !== "info") {
|
|
169
|
+
throw new TypeError(
|
|
170
|
+
`defineGuardRule: \`severity\` must be one of "error" | "warning" | "info" (got ${JSON.stringify(rule.severity)}).`
|
|
171
|
+
);
|
|
172
|
+
}
|
|
173
|
+
if (typeof rule.check !== "function") {
|
|
174
|
+
throw new TypeError("defineGuardRule: `check` must be a function (sync or async).");
|
|
175
|
+
}
|
|
176
|
+
if (typeof rule.description !== "string") {
|
|
177
|
+
throw new TypeError("defineGuardRule: `description` must be a string.");
|
|
178
|
+
}
|
|
179
|
+
return rule;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Structural check used by the Zod `z.custom<GuardRule>()` guard in
|
|
184
|
+
* `config/validate.ts` and by `validateCustomRules()` at load time.
|
|
185
|
+
* Kept deliberately loose — we only reject values that are obviously
|
|
186
|
+
* not `GuardRule` objects; deeper validation (severity enum,
|
|
187
|
+
* description type) happens in `defineGuardRule()` for the clearest
|
|
188
|
+
* DX error, or in the runner (`check` throws) where the violation is
|
|
189
|
+
* reported in-band.
|
|
190
|
+
*/
|
|
191
|
+
export function isGuardRuleLike(value: unknown): value is GuardRule {
|
|
192
|
+
if (typeof value !== "object" || value === null) return false;
|
|
193
|
+
const obj = value as Record<string, unknown>;
|
|
194
|
+
if (typeof obj.id !== "string" || obj.id.length === 0) return false;
|
|
195
|
+
if (typeof obj.check !== "function") return false;
|
|
196
|
+
return true;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Duplicate-id result returned by {@link validateCustomRules}.
|
|
201
|
+
*/
|
|
202
|
+
export interface DuplicateRuleId {
|
|
203
|
+
id: string;
|
|
204
|
+
/** Zero-indexed positions in the original array where the id appears. */
|
|
205
|
+
indices: number[];
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Structural validation executed at config-load. Returns the list of
|
|
210
|
+
* duplicate ids plus a list of entries that failed {@link isGuardRuleLike}.
|
|
211
|
+
* The CLI prints a warning per duplicate; malformed rules are surfaced
|
|
212
|
+
* via Zod's standard error path.
|
|
213
|
+
*/
|
|
214
|
+
export function validateCustomRules(rules: readonly unknown[]): {
|
|
215
|
+
duplicates: DuplicateRuleId[];
|
|
216
|
+
malformed: number[];
|
|
217
|
+
} {
|
|
218
|
+
const duplicates: DuplicateRuleId[] = [];
|
|
219
|
+
const malformed: number[] = [];
|
|
220
|
+
const seen = new Map<string, number[]>();
|
|
221
|
+
|
|
222
|
+
for (let i = 0; i < rules.length; i++) {
|
|
223
|
+
const rule = rules[i];
|
|
224
|
+
if (!isGuardRuleLike(rule)) {
|
|
225
|
+
malformed.push(i);
|
|
226
|
+
continue;
|
|
227
|
+
}
|
|
228
|
+
const existing = seen.get(rule.id);
|
|
229
|
+
if (existing) {
|
|
230
|
+
existing.push(i);
|
|
231
|
+
} else {
|
|
232
|
+
seen.set(rule.id, [i]);
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
for (const [id, indices] of seen) {
|
|
237
|
+
if (indices.length > 1) {
|
|
238
|
+
duplicates.push({ id, indices });
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
return { duplicates, malformed };
|
|
243
|
+
}
|