@mandujs/core 0.54.31 → 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 +39 -20
- 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
|
@@ -1,379 +1,379 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Phase 18.ν — Convenience presets for consumer-defined Guard rules.
|
|
3
|
-
*
|
|
4
|
-
* Wraps {@link defineGuardRule} with the three most common project-local
|
|
5
|
-
* patterns observed in Mandu consumer projects:
|
|
6
|
-
*
|
|
7
|
-
* 1. `forbidImport()` — reject imports whose specifier matches a regex
|
|
8
|
-
* (or equals a literal string). Replaces the 90% case of
|
|
9
|
-
* `eslint-plugin-local` rules.
|
|
10
|
-
* 2. `requireNamedExport()` — require specific named exports in files
|
|
11
|
-
* whose paths match a glob/regex. Useful for enforcing file-based
|
|
12
|
-
* routing conventions (`route.ts` must export a `handler`, etc.).
|
|
13
|
-
* 3. `requirePrefixForExports()` — require exported functions to start
|
|
14
|
-
* with a given prefix (e.g. HTTP verb names for API route files).
|
|
15
|
-
*
|
|
16
|
-
* All helpers return a {@link GuardRule} so they can be pushed directly
|
|
17
|
-
* into `mandu.config.ts` `guard.rules: [...]`.
|
|
18
|
-
*
|
|
19
|
-
* @module guard/rule-presets
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```ts
|
|
23
|
-
* // mandu.config.ts
|
|
24
|
-
* import {
|
|
25
|
-
* forbidImport,
|
|
26
|
-
* requireNamedExport,
|
|
27
|
-
* requirePrefixForExports,
|
|
28
|
-
* } from "@mandujs/core/guard/define-rule";
|
|
29
|
-
*
|
|
30
|
-
* export default {
|
|
31
|
-
* guard: {
|
|
32
|
-
* rules: [
|
|
33
|
-
* forbidImport({ from: "axios", matches: /./ }),
|
|
34
|
-
* requireNamedExport({
|
|
35
|
-
* patterns: [/app\/api\/.*\/route\.ts$/],
|
|
36
|
-
* names: ["GET", "POST"],
|
|
37
|
-
* requireAny: true,
|
|
38
|
-
* }),
|
|
39
|
-
* requirePrefixForExports({
|
|
40
|
-
* patterns: [/app\/api\/.*\/route\.ts$/],
|
|
41
|
-
* prefix: /^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS)$/,
|
|
42
|
-
* }),
|
|
43
|
-
* ],
|
|
44
|
-
* },
|
|
45
|
-
* };
|
|
46
|
-
* ```
|
|
47
|
-
*/
|
|
48
|
-
|
|
49
|
-
import {
|
|
50
|
-
defineGuardRule,
|
|
51
|
-
type GuardRule,
|
|
52
|
-
type GuardRuleContext,
|
|
53
|
-
type GuardRuleSeverity,
|
|
54
|
-
type GuardViolation,
|
|
55
|
-
} from "./define-rule";
|
|
56
|
-
|
|
57
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
58
|
-
// Shared helpers
|
|
59
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
60
|
-
|
|
61
|
-
/** Normalize a string | RegExp matcher into a `.test(value)`-capable object. */
|
|
62
|
-
function toRegex(matcher: string | RegExp): RegExp {
|
|
63
|
-
if (matcher instanceof RegExp) return matcher;
|
|
64
|
-
// Escape regex metacharacters for literal-string matches.
|
|
65
|
-
const escaped = matcher.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
66
|
-
return new RegExp(escaped);
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* Returns true when `filePath` matches at least one of the supplied
|
|
71
|
-
* patterns. Strings are treated as literal substrings; RegExps use
|
|
72
|
-
* `.test()`. Forward slashes are used throughout (the Guard runner
|
|
73
|
-
* already normalizes Windows backslashes upstream).
|
|
74
|
-
*/
|
|
75
|
-
function matchesAny(filePath: string, patterns: ReadonlyArray<string | RegExp>): boolean {
|
|
76
|
-
for (const pattern of patterns) {
|
|
77
|
-
if (typeof pattern === "string") {
|
|
78
|
-
if (filePath.includes(pattern)) return true;
|
|
79
|
-
} else if (pattern.test(filePath)) {
|
|
80
|
-
return true;
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
return false;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
87
|
-
// forbidImport
|
|
88
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Options for {@link forbidImport}.
|
|
92
|
-
*/
|
|
93
|
-
export interface ForbidImportOptions {
|
|
94
|
-
/**
|
|
95
|
-
* Package name / path that triggers the rule. Matched against
|
|
96
|
-
* {@link ImportInfo.path} via `===` (literal) or `.test()` (regex).
|
|
97
|
-
* Pass a regex like `/^(node:fs|fs|fs\/promises)$/` for a set match.
|
|
98
|
-
*/
|
|
99
|
-
from: string | RegExp;
|
|
100
|
-
/**
|
|
101
|
-
* Only the imports whose import path also matches this regex are
|
|
102
|
-
* flagged. Defaults to `/./` (all imports). Useful for cases where
|
|
103
|
-
* you want to forbid a package except when imported for types only.
|
|
104
|
-
*/
|
|
105
|
-
matches?: RegExp;
|
|
106
|
-
/** Rule severity. Defaults to `"error"`. */
|
|
107
|
-
severity?: GuardRuleSeverity;
|
|
108
|
-
/** Override rule `id`. Defaults to `forbid-import:<normalized-from>`. */
|
|
109
|
-
id?: string;
|
|
110
|
-
/**
|
|
111
|
-
* Override rule `description`. Defaults to a human-friendly sentence
|
|
112
|
-
* describing the forbidden source.
|
|
113
|
-
*/
|
|
114
|
-
description?: string;
|
|
115
|
-
/**
|
|
116
|
-
* Remediation hint surfaced alongside each violation. Defaults to a
|
|
117
|
-
* generic "Use a project-approved alternative" string.
|
|
118
|
-
*/
|
|
119
|
-
hint?: string;
|
|
120
|
-
/** Optional docs URL surfaced with each violation. */
|
|
121
|
-
docsUrl?: string;
|
|
122
|
-
/**
|
|
123
|
-
* Restrict the rule to files whose path matches one of these
|
|
124
|
-
* patterns. When omitted, every scanned file is considered.
|
|
125
|
-
*/
|
|
126
|
-
includePaths?: ReadonlyArray<string | RegExp>;
|
|
127
|
-
/**
|
|
128
|
-
* Exclude files whose path matches one of these patterns. Applied
|
|
129
|
-
* after `includePaths`.
|
|
130
|
-
*/
|
|
131
|
-
excludePaths?: ReadonlyArray<string | RegExp>;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
function normalizeIdFragment(value: string | RegExp): string {
|
|
135
|
-
const raw = value instanceof RegExp ? value.source : value;
|
|
136
|
-
return raw.replace(/[^a-zA-Z0-9]+/g, "-").replace(/^-+|-+$/g, "") || "import";
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
* Create a rule that rejects every `import ... from "<from>"` whose
|
|
141
|
-
* specifier matches `matches` (default: all). Works for static,
|
|
142
|
-
* dynamic, and CommonJS `require()` imports.
|
|
143
|
-
*/
|
|
144
|
-
export function forbidImport(options: ForbidImportOptions): GuardRule {
|
|
145
|
-
const fromMatcher = toRegex(options.from);
|
|
146
|
-
const extraMatcher = options.matches ?? /./;
|
|
147
|
-
const id = options.id ?? `forbid-import:${normalizeIdFragment(options.from)}`;
|
|
148
|
-
const description =
|
|
149
|
-
options.description ??
|
|
150
|
-
`Imports from \`${options.from instanceof RegExp ? options.from.source : options.from}\` are forbidden.`;
|
|
151
|
-
const hint = options.hint ?? "Use a project-approved alternative.";
|
|
152
|
-
const severity = options.severity ?? "error";
|
|
153
|
-
|
|
154
|
-
return defineGuardRule({
|
|
155
|
-
id,
|
|
156
|
-
severity,
|
|
157
|
-
description,
|
|
158
|
-
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
159
|
-
if (options.includePaths && !matchesAny(ctx.sourceFile, options.includePaths)) {
|
|
160
|
-
return [];
|
|
161
|
-
}
|
|
162
|
-
if (options.excludePaths && matchesAny(ctx.sourceFile, options.excludePaths)) {
|
|
163
|
-
return [];
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
const violations: GuardViolation[] = [];
|
|
167
|
-
for (const imp of ctx.imports) {
|
|
168
|
-
if (!fromMatcher.test(imp.path)) continue;
|
|
169
|
-
if (!extraMatcher.test(imp.path)) continue;
|
|
170
|
-
|
|
171
|
-
violations.push({
|
|
172
|
-
file: ctx.sourceFile,
|
|
173
|
-
line: imp.line,
|
|
174
|
-
column: imp.column,
|
|
175
|
-
message: `Forbidden import: \`${imp.path}\` (${description})`,
|
|
176
|
-
hint,
|
|
177
|
-
docsUrl: options.docsUrl,
|
|
178
|
-
});
|
|
179
|
-
}
|
|
180
|
-
return violations;
|
|
181
|
-
},
|
|
182
|
-
});
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
186
|
-
// requireNamedExport
|
|
187
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Options for {@link requireNamedExport}.
|
|
191
|
-
*/
|
|
192
|
-
export interface RequireNamedExportOptions {
|
|
193
|
-
/**
|
|
194
|
-
* Only files whose path matches one of these patterns are checked.
|
|
195
|
-
* Strings are substring matches; regexes use `.test()`.
|
|
196
|
-
*/
|
|
197
|
-
patterns: ReadonlyArray<string | RegExp>;
|
|
198
|
-
/**
|
|
199
|
-
* Export names that must be present. By default (`requireAny === false`)
|
|
200
|
-
* *all* names in this array must be exported; pass `requireAny: true`
|
|
201
|
-
* to require at least one.
|
|
202
|
-
*/
|
|
203
|
-
names: readonly string[];
|
|
204
|
-
/**
|
|
205
|
-
* If `true`, a file passes when at least one of `names` is exported.
|
|
206
|
-
* Defaults to `false` (all names required).
|
|
207
|
-
*/
|
|
208
|
-
requireAny?: boolean;
|
|
209
|
-
/** Rule severity. Defaults to `"error"`. */
|
|
210
|
-
severity?: GuardRuleSeverity;
|
|
211
|
-
/** Override rule `id`. Defaults to `require-named-export:<names.join("|")>`. */
|
|
212
|
-
id?: string;
|
|
213
|
-
/** Override rule `description`. */
|
|
214
|
-
description?: string;
|
|
215
|
-
/** Remediation hint. */
|
|
216
|
-
hint?: string;
|
|
217
|
-
/** Optional docs URL. */
|
|
218
|
-
docsUrl?: string;
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* Create a rule that requires specific named exports to exist in
|
|
223
|
-
* matching files. Useful for enforcing file-based routing conventions
|
|
224
|
-
* (e.g. `app/api/**\/route.ts` must export a `GET` or `POST` handler).
|
|
225
|
-
*/
|
|
226
|
-
export function requireNamedExport(options: RequireNamedExportOptions): GuardRule {
|
|
227
|
-
if (!Array.isArray(options.names) || options.names.length === 0) {
|
|
228
|
-
throw new TypeError("requireNamedExport: `names` must be a non-empty array of strings.");
|
|
229
|
-
}
|
|
230
|
-
if (!Array.isArray(options.patterns) || options.patterns.length === 0) {
|
|
231
|
-
throw new TypeError("requireNamedExport: `patterns` must be a non-empty array.");
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
const id = options.id ?? `require-named-export:${options.names.join("|")}`;
|
|
235
|
-
const description =
|
|
236
|
-
options.description ??
|
|
237
|
-
(options.requireAny
|
|
238
|
-
? `Files matching the pattern must export at least one of: ${options.names.join(", ")}.`
|
|
239
|
-
: `Files matching the pattern must export all of: ${options.names.join(", ")}.`);
|
|
240
|
-
const hint = options.hint ?? `Add the missing \`export\` declarations.`;
|
|
241
|
-
const severity = options.severity ?? "error";
|
|
242
|
-
|
|
243
|
-
return defineGuardRule({
|
|
244
|
-
id,
|
|
245
|
-
severity,
|
|
246
|
-
description,
|
|
247
|
-
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
248
|
-
if (!matchesAny(ctx.sourceFile, options.patterns)) return [];
|
|
249
|
-
|
|
250
|
-
const exportedNames = new Set<string>();
|
|
251
|
-
for (const exp of ctx.exports) {
|
|
252
|
-
if (exp.type === "named" || exp.type === "default") {
|
|
253
|
-
if (exp.name) exportedNames.add(exp.name);
|
|
254
|
-
}
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
const missing = options.names.filter((n) => !exportedNames.has(n));
|
|
258
|
-
|
|
259
|
-
if (options.requireAny) {
|
|
260
|
-
if (missing.length === options.names.length) {
|
|
261
|
-
return [
|
|
262
|
-
{
|
|
263
|
-
file: ctx.sourceFile,
|
|
264
|
-
message: `Missing required export: expected at least one of [${options.names.join(", ")}], found none.`,
|
|
265
|
-
hint,
|
|
266
|
-
docsUrl: options.docsUrl,
|
|
267
|
-
},
|
|
268
|
-
];
|
|
269
|
-
}
|
|
270
|
-
return [];
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
if (missing.length === 0) return [];
|
|
274
|
-
return [
|
|
275
|
-
{
|
|
276
|
-
file: ctx.sourceFile,
|
|
277
|
-
message: `Missing required exports: ${missing.join(", ")}.`,
|
|
278
|
-
hint,
|
|
279
|
-
docsUrl: options.docsUrl,
|
|
280
|
-
},
|
|
281
|
-
];
|
|
282
|
-
},
|
|
283
|
-
});
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
287
|
-
// requirePrefixForExports
|
|
288
|
-
// ═══════════════════════════════════════════════════════════════════════════
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* Options for {@link requirePrefixForExports}.
|
|
292
|
-
*/
|
|
293
|
-
export interface RequirePrefixForExportsOptions {
|
|
294
|
-
/**
|
|
295
|
-
* Only files whose path matches one of these patterns are checked.
|
|
296
|
-
*/
|
|
297
|
-
patterns: ReadonlyArray<string | RegExp>;
|
|
298
|
-
/**
|
|
299
|
-
* Prefix that every named export must match. String is treated as a
|
|
300
|
-
* literal prefix (`startsWith`); RegExp is `.test()`-ed against the
|
|
301
|
-
* full export name.
|
|
302
|
-
*/
|
|
303
|
-
prefix: string | RegExp;
|
|
304
|
-
/**
|
|
305
|
-
* Export names to exempt from the check (e.g. `"default"`, helper
|
|
306
|
-
* types). Literal strings only — kept simple because this is the
|
|
307
|
-
* common case.
|
|
308
|
-
*/
|
|
309
|
-
allowList?: readonly string[];
|
|
310
|
-
/**
|
|
311
|
-
* When `true`, only check exports whose `type` is `"named"` (skip
|
|
312
|
-
* `default`, `all`, and `type` re-exports). Defaults to `true`.
|
|
313
|
-
*/
|
|
314
|
-
onlyNamed?: boolean;
|
|
315
|
-
/** Rule severity. Defaults to `"error"`. */
|
|
316
|
-
severity?: GuardRuleSeverity;
|
|
317
|
-
/** Override rule `id`. Defaults to `require-prefix:<normalized-prefix>`. */
|
|
318
|
-
id?: string;
|
|
319
|
-
/** Override rule `description`. */
|
|
320
|
-
description?: string;
|
|
321
|
-
/** Remediation hint. */
|
|
322
|
-
hint?: string;
|
|
323
|
-
/** Optional docs URL. */
|
|
324
|
-
docsUrl?: string;
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
/**
|
|
328
|
-
* Create a rule that requires every named export in matching files to
|
|
329
|
-
* match `prefix`. Classic use case: enforce that `app/api/**\/route.ts`
|
|
330
|
-
* files only export HTTP verb names (`GET`, `POST`, ...).
|
|
331
|
-
*/
|
|
332
|
-
export function requirePrefixForExports(options: RequirePrefixForExportsOptions): GuardRule {
|
|
333
|
-
if (!Array.isArray(options.patterns) || options.patterns.length === 0) {
|
|
334
|
-
throw new TypeError("requirePrefixForExports: `patterns` must be a non-empty array.");
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
const prefixRegex =
|
|
338
|
-
options.prefix instanceof RegExp
|
|
339
|
-
? options.prefix
|
|
340
|
-
: new RegExp(`^${options.prefix.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}`);
|
|
341
|
-
const id = options.id ?? `require-prefix:${normalizeIdFragment(options.prefix)}`;
|
|
342
|
-
const description =
|
|
343
|
-
options.description ??
|
|
344
|
-
`Named exports in matching files must start with \`${options.prefix instanceof RegExp ? options.prefix.source : options.prefix}\`.`;
|
|
345
|
-
const hint =
|
|
346
|
-
options.hint ??
|
|
347
|
-
`Rename the export to match the required prefix, or move the helper to a different module.`;
|
|
348
|
-
const severity = options.severity ?? "error";
|
|
349
|
-
const allowSet = new Set(options.allowList ?? []);
|
|
350
|
-
const onlyNamed = options.onlyNamed ?? true;
|
|
351
|
-
|
|
352
|
-
return defineGuardRule({
|
|
353
|
-
id,
|
|
354
|
-
severity,
|
|
355
|
-
description,
|
|
356
|
-
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
357
|
-
if (!matchesAny(ctx.sourceFile, options.patterns)) return [];
|
|
358
|
-
|
|
359
|
-
const violations: GuardViolation[] = [];
|
|
360
|
-
for (const exp of ctx.exports) {
|
|
361
|
-
if (onlyNamed && exp.type !== "named") continue;
|
|
362
|
-
if (!exp.name) continue;
|
|
363
|
-
if (allowSet.has(exp.name)) continue;
|
|
364
|
-
if (prefixRegex.test(exp.name)) continue;
|
|
365
|
-
|
|
366
|
-
violations.push({
|
|
367
|
-
file: ctx.sourceFile,
|
|
368
|
-
line: exp.line,
|
|
369
|
-
message: `Export \`${exp.name}\` does not match the required prefix ${
|
|
370
|
-
options.prefix instanceof RegExp ? options.prefix.source : `"${options.prefix}"`
|
|
371
|
-
}.`,
|
|
372
|
-
hint,
|
|
373
|
-
docsUrl: options.docsUrl,
|
|
374
|
-
});
|
|
375
|
-
}
|
|
376
|
-
return violations;
|
|
377
|
-
},
|
|
378
|
-
});
|
|
379
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Phase 18.ν — Convenience presets for consumer-defined Guard rules.
|
|
3
|
+
*
|
|
4
|
+
* Wraps {@link defineGuardRule} with the three most common project-local
|
|
5
|
+
* patterns observed in Mandu consumer projects:
|
|
6
|
+
*
|
|
7
|
+
* 1. `forbidImport()` — reject imports whose specifier matches a regex
|
|
8
|
+
* (or equals a literal string). Replaces the 90% case of
|
|
9
|
+
* `eslint-plugin-local` rules.
|
|
10
|
+
* 2. `requireNamedExport()` — require specific named exports in files
|
|
11
|
+
* whose paths match a glob/regex. Useful for enforcing file-based
|
|
12
|
+
* routing conventions (`route.ts` must export a `handler`, etc.).
|
|
13
|
+
* 3. `requirePrefixForExports()` — require exported functions to start
|
|
14
|
+
* with a given prefix (e.g. HTTP verb names for API route files).
|
|
15
|
+
*
|
|
16
|
+
* All helpers return a {@link GuardRule} so they can be pushed directly
|
|
17
|
+
* into `mandu.config.ts` `guard.rules: [...]`.
|
|
18
|
+
*
|
|
19
|
+
* @module guard/rule-presets
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* // mandu.config.ts
|
|
24
|
+
* import {
|
|
25
|
+
* forbidImport,
|
|
26
|
+
* requireNamedExport,
|
|
27
|
+
* requirePrefixForExports,
|
|
28
|
+
* } from "@mandujs/core/compat/guard/define-rule";
|
|
29
|
+
*
|
|
30
|
+
* export default {
|
|
31
|
+
* guard: {
|
|
32
|
+
* rules: [
|
|
33
|
+
* forbidImport({ from: "axios", matches: /./ }),
|
|
34
|
+
* requireNamedExport({
|
|
35
|
+
* patterns: [/app\/api\/.*\/route\.ts$/],
|
|
36
|
+
* names: ["GET", "POST"],
|
|
37
|
+
* requireAny: true,
|
|
38
|
+
* }),
|
|
39
|
+
* requirePrefixForExports({
|
|
40
|
+
* patterns: [/app\/api\/.*\/route\.ts$/],
|
|
41
|
+
* prefix: /^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS)$/,
|
|
42
|
+
* }),
|
|
43
|
+
* ],
|
|
44
|
+
* },
|
|
45
|
+
* };
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
|
|
49
|
+
import {
|
|
50
|
+
defineGuardRule,
|
|
51
|
+
type GuardRule,
|
|
52
|
+
type GuardRuleContext,
|
|
53
|
+
type GuardRuleSeverity,
|
|
54
|
+
type GuardViolation,
|
|
55
|
+
} from "./define-rule";
|
|
56
|
+
|
|
57
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
58
|
+
// Shared helpers
|
|
59
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
60
|
+
|
|
61
|
+
/** Normalize a string | RegExp matcher into a `.test(value)`-capable object. */
|
|
62
|
+
function toRegex(matcher: string | RegExp): RegExp {
|
|
63
|
+
if (matcher instanceof RegExp) return matcher;
|
|
64
|
+
// Escape regex metacharacters for literal-string matches.
|
|
65
|
+
const escaped = matcher.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
66
|
+
return new RegExp(escaped);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Returns true when `filePath` matches at least one of the supplied
|
|
71
|
+
* patterns. Strings are treated as literal substrings; RegExps use
|
|
72
|
+
* `.test()`. Forward slashes are used throughout (the Guard runner
|
|
73
|
+
* already normalizes Windows backslashes upstream).
|
|
74
|
+
*/
|
|
75
|
+
function matchesAny(filePath: string, patterns: ReadonlyArray<string | RegExp>): boolean {
|
|
76
|
+
for (const pattern of patterns) {
|
|
77
|
+
if (typeof pattern === "string") {
|
|
78
|
+
if (filePath.includes(pattern)) return true;
|
|
79
|
+
} else if (pattern.test(filePath)) {
|
|
80
|
+
return true;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
return false;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
87
|
+
// forbidImport
|
|
88
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Options for {@link forbidImport}.
|
|
92
|
+
*/
|
|
93
|
+
export interface ForbidImportOptions {
|
|
94
|
+
/**
|
|
95
|
+
* Package name / path that triggers the rule. Matched against
|
|
96
|
+
* {@link ImportInfo.path} via `===` (literal) or `.test()` (regex).
|
|
97
|
+
* Pass a regex like `/^(node:fs|fs|fs\/promises)$/` for a set match.
|
|
98
|
+
*/
|
|
99
|
+
from: string | RegExp;
|
|
100
|
+
/**
|
|
101
|
+
* Only the imports whose import path also matches this regex are
|
|
102
|
+
* flagged. Defaults to `/./` (all imports). Useful for cases where
|
|
103
|
+
* you want to forbid a package except when imported for types only.
|
|
104
|
+
*/
|
|
105
|
+
matches?: RegExp;
|
|
106
|
+
/** Rule severity. Defaults to `"error"`. */
|
|
107
|
+
severity?: GuardRuleSeverity;
|
|
108
|
+
/** Override rule `id`. Defaults to `forbid-import:<normalized-from>`. */
|
|
109
|
+
id?: string;
|
|
110
|
+
/**
|
|
111
|
+
* Override rule `description`. Defaults to a human-friendly sentence
|
|
112
|
+
* describing the forbidden source.
|
|
113
|
+
*/
|
|
114
|
+
description?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Remediation hint surfaced alongside each violation. Defaults to a
|
|
117
|
+
* generic "Use a project-approved alternative" string.
|
|
118
|
+
*/
|
|
119
|
+
hint?: string;
|
|
120
|
+
/** Optional docs URL surfaced with each violation. */
|
|
121
|
+
docsUrl?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Restrict the rule to files whose path matches one of these
|
|
124
|
+
* patterns. When omitted, every scanned file is considered.
|
|
125
|
+
*/
|
|
126
|
+
includePaths?: ReadonlyArray<string | RegExp>;
|
|
127
|
+
/**
|
|
128
|
+
* Exclude files whose path matches one of these patterns. Applied
|
|
129
|
+
* after `includePaths`.
|
|
130
|
+
*/
|
|
131
|
+
excludePaths?: ReadonlyArray<string | RegExp>;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
function normalizeIdFragment(value: string | RegExp): string {
|
|
135
|
+
const raw = value instanceof RegExp ? value.source : value;
|
|
136
|
+
return raw.replace(/[^a-zA-Z0-9]+/g, "-").replace(/^-+|-+$/g, "") || "import";
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Create a rule that rejects every `import ... from "<from>"` whose
|
|
141
|
+
* specifier matches `matches` (default: all). Works for static,
|
|
142
|
+
* dynamic, and CommonJS `require()` imports.
|
|
143
|
+
*/
|
|
144
|
+
export function forbidImport(options: ForbidImportOptions): GuardRule {
|
|
145
|
+
const fromMatcher = toRegex(options.from);
|
|
146
|
+
const extraMatcher = options.matches ?? /./;
|
|
147
|
+
const id = options.id ?? `forbid-import:${normalizeIdFragment(options.from)}`;
|
|
148
|
+
const description =
|
|
149
|
+
options.description ??
|
|
150
|
+
`Imports from \`${options.from instanceof RegExp ? options.from.source : options.from}\` are forbidden.`;
|
|
151
|
+
const hint = options.hint ?? "Use a project-approved alternative.";
|
|
152
|
+
const severity = options.severity ?? "error";
|
|
153
|
+
|
|
154
|
+
return defineGuardRule({
|
|
155
|
+
id,
|
|
156
|
+
severity,
|
|
157
|
+
description,
|
|
158
|
+
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
159
|
+
if (options.includePaths && !matchesAny(ctx.sourceFile, options.includePaths)) {
|
|
160
|
+
return [];
|
|
161
|
+
}
|
|
162
|
+
if (options.excludePaths && matchesAny(ctx.sourceFile, options.excludePaths)) {
|
|
163
|
+
return [];
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
const violations: GuardViolation[] = [];
|
|
167
|
+
for (const imp of ctx.imports) {
|
|
168
|
+
if (!fromMatcher.test(imp.path)) continue;
|
|
169
|
+
if (!extraMatcher.test(imp.path)) continue;
|
|
170
|
+
|
|
171
|
+
violations.push({
|
|
172
|
+
file: ctx.sourceFile,
|
|
173
|
+
line: imp.line,
|
|
174
|
+
column: imp.column,
|
|
175
|
+
message: `Forbidden import: \`${imp.path}\` (${description})`,
|
|
176
|
+
hint,
|
|
177
|
+
docsUrl: options.docsUrl,
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
return violations;
|
|
181
|
+
},
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
186
|
+
// requireNamedExport
|
|
187
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* Options for {@link requireNamedExport}.
|
|
191
|
+
*/
|
|
192
|
+
export interface RequireNamedExportOptions {
|
|
193
|
+
/**
|
|
194
|
+
* Only files whose path matches one of these patterns are checked.
|
|
195
|
+
* Strings are substring matches; regexes use `.test()`.
|
|
196
|
+
*/
|
|
197
|
+
patterns: ReadonlyArray<string | RegExp>;
|
|
198
|
+
/**
|
|
199
|
+
* Export names that must be present. By default (`requireAny === false`)
|
|
200
|
+
* *all* names in this array must be exported; pass `requireAny: true`
|
|
201
|
+
* to require at least one.
|
|
202
|
+
*/
|
|
203
|
+
names: readonly string[];
|
|
204
|
+
/**
|
|
205
|
+
* If `true`, a file passes when at least one of `names` is exported.
|
|
206
|
+
* Defaults to `false` (all names required).
|
|
207
|
+
*/
|
|
208
|
+
requireAny?: boolean;
|
|
209
|
+
/** Rule severity. Defaults to `"error"`. */
|
|
210
|
+
severity?: GuardRuleSeverity;
|
|
211
|
+
/** Override rule `id`. Defaults to `require-named-export:<names.join("|")>`. */
|
|
212
|
+
id?: string;
|
|
213
|
+
/** Override rule `description`. */
|
|
214
|
+
description?: string;
|
|
215
|
+
/** Remediation hint. */
|
|
216
|
+
hint?: string;
|
|
217
|
+
/** Optional docs URL. */
|
|
218
|
+
docsUrl?: string;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Create a rule that requires specific named exports to exist in
|
|
223
|
+
* matching files. Useful for enforcing file-based routing conventions
|
|
224
|
+
* (e.g. `app/api/**\/route.ts` must export a `GET` or `POST` handler).
|
|
225
|
+
*/
|
|
226
|
+
export function requireNamedExport(options: RequireNamedExportOptions): GuardRule {
|
|
227
|
+
if (!Array.isArray(options.names) || options.names.length === 0) {
|
|
228
|
+
throw new TypeError("requireNamedExport: `names` must be a non-empty array of strings.");
|
|
229
|
+
}
|
|
230
|
+
if (!Array.isArray(options.patterns) || options.patterns.length === 0) {
|
|
231
|
+
throw new TypeError("requireNamedExport: `patterns` must be a non-empty array.");
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
const id = options.id ?? `require-named-export:${options.names.join("|")}`;
|
|
235
|
+
const description =
|
|
236
|
+
options.description ??
|
|
237
|
+
(options.requireAny
|
|
238
|
+
? `Files matching the pattern must export at least one of: ${options.names.join(", ")}.`
|
|
239
|
+
: `Files matching the pattern must export all of: ${options.names.join(", ")}.`);
|
|
240
|
+
const hint = options.hint ?? `Add the missing \`export\` declarations.`;
|
|
241
|
+
const severity = options.severity ?? "error";
|
|
242
|
+
|
|
243
|
+
return defineGuardRule({
|
|
244
|
+
id,
|
|
245
|
+
severity,
|
|
246
|
+
description,
|
|
247
|
+
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
248
|
+
if (!matchesAny(ctx.sourceFile, options.patterns)) return [];
|
|
249
|
+
|
|
250
|
+
const exportedNames = new Set<string>();
|
|
251
|
+
for (const exp of ctx.exports) {
|
|
252
|
+
if (exp.type === "named" || exp.type === "default") {
|
|
253
|
+
if (exp.name) exportedNames.add(exp.name);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
const missing = options.names.filter((n) => !exportedNames.has(n));
|
|
258
|
+
|
|
259
|
+
if (options.requireAny) {
|
|
260
|
+
if (missing.length === options.names.length) {
|
|
261
|
+
return [
|
|
262
|
+
{
|
|
263
|
+
file: ctx.sourceFile,
|
|
264
|
+
message: `Missing required export: expected at least one of [${options.names.join(", ")}], found none.`,
|
|
265
|
+
hint,
|
|
266
|
+
docsUrl: options.docsUrl,
|
|
267
|
+
},
|
|
268
|
+
];
|
|
269
|
+
}
|
|
270
|
+
return [];
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
if (missing.length === 0) return [];
|
|
274
|
+
return [
|
|
275
|
+
{
|
|
276
|
+
file: ctx.sourceFile,
|
|
277
|
+
message: `Missing required exports: ${missing.join(", ")}.`,
|
|
278
|
+
hint,
|
|
279
|
+
docsUrl: options.docsUrl,
|
|
280
|
+
},
|
|
281
|
+
];
|
|
282
|
+
},
|
|
283
|
+
});
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
287
|
+
// requirePrefixForExports
|
|
288
|
+
// ═══════════════════════════════════════════════════════════════════════════
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Options for {@link requirePrefixForExports}.
|
|
292
|
+
*/
|
|
293
|
+
export interface RequirePrefixForExportsOptions {
|
|
294
|
+
/**
|
|
295
|
+
* Only files whose path matches one of these patterns are checked.
|
|
296
|
+
*/
|
|
297
|
+
patterns: ReadonlyArray<string | RegExp>;
|
|
298
|
+
/**
|
|
299
|
+
* Prefix that every named export must match. String is treated as a
|
|
300
|
+
* literal prefix (`startsWith`); RegExp is `.test()`-ed against the
|
|
301
|
+
* full export name.
|
|
302
|
+
*/
|
|
303
|
+
prefix: string | RegExp;
|
|
304
|
+
/**
|
|
305
|
+
* Export names to exempt from the check (e.g. `"default"`, helper
|
|
306
|
+
* types). Literal strings only — kept simple because this is the
|
|
307
|
+
* common case.
|
|
308
|
+
*/
|
|
309
|
+
allowList?: readonly string[];
|
|
310
|
+
/**
|
|
311
|
+
* When `true`, only check exports whose `type` is `"named"` (skip
|
|
312
|
+
* `default`, `all`, and `type` re-exports). Defaults to `true`.
|
|
313
|
+
*/
|
|
314
|
+
onlyNamed?: boolean;
|
|
315
|
+
/** Rule severity. Defaults to `"error"`. */
|
|
316
|
+
severity?: GuardRuleSeverity;
|
|
317
|
+
/** Override rule `id`. Defaults to `require-prefix:<normalized-prefix>`. */
|
|
318
|
+
id?: string;
|
|
319
|
+
/** Override rule `description`. */
|
|
320
|
+
description?: string;
|
|
321
|
+
/** Remediation hint. */
|
|
322
|
+
hint?: string;
|
|
323
|
+
/** Optional docs URL. */
|
|
324
|
+
docsUrl?: string;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* Create a rule that requires every named export in matching files to
|
|
329
|
+
* match `prefix`. Classic use case: enforce that `app/api/**\/route.ts`
|
|
330
|
+
* files only export HTTP verb names (`GET`, `POST`, ...).
|
|
331
|
+
*/
|
|
332
|
+
export function requirePrefixForExports(options: RequirePrefixForExportsOptions): GuardRule {
|
|
333
|
+
if (!Array.isArray(options.patterns) || options.patterns.length === 0) {
|
|
334
|
+
throw new TypeError("requirePrefixForExports: `patterns` must be a non-empty array.");
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
const prefixRegex =
|
|
338
|
+
options.prefix instanceof RegExp
|
|
339
|
+
? options.prefix
|
|
340
|
+
: new RegExp(`^${options.prefix.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}`);
|
|
341
|
+
const id = options.id ?? `require-prefix:${normalizeIdFragment(options.prefix)}`;
|
|
342
|
+
const description =
|
|
343
|
+
options.description ??
|
|
344
|
+
`Named exports in matching files must start with \`${options.prefix instanceof RegExp ? options.prefix.source : options.prefix}\`.`;
|
|
345
|
+
const hint =
|
|
346
|
+
options.hint ??
|
|
347
|
+
`Rename the export to match the required prefix, or move the helper to a different module.`;
|
|
348
|
+
const severity = options.severity ?? "error";
|
|
349
|
+
const allowSet = new Set(options.allowList ?? []);
|
|
350
|
+
const onlyNamed = options.onlyNamed ?? true;
|
|
351
|
+
|
|
352
|
+
return defineGuardRule({
|
|
353
|
+
id,
|
|
354
|
+
severity,
|
|
355
|
+
description,
|
|
356
|
+
check(ctx: GuardRuleContext): GuardViolation[] {
|
|
357
|
+
if (!matchesAny(ctx.sourceFile, options.patterns)) return [];
|
|
358
|
+
|
|
359
|
+
const violations: GuardViolation[] = [];
|
|
360
|
+
for (const exp of ctx.exports) {
|
|
361
|
+
if (onlyNamed && exp.type !== "named") continue;
|
|
362
|
+
if (!exp.name) continue;
|
|
363
|
+
if (allowSet.has(exp.name)) continue;
|
|
364
|
+
if (prefixRegex.test(exp.name)) continue;
|
|
365
|
+
|
|
366
|
+
violations.push({
|
|
367
|
+
file: ctx.sourceFile,
|
|
368
|
+
line: exp.line,
|
|
369
|
+
message: `Export \`${exp.name}\` does not match the required prefix ${
|
|
370
|
+
options.prefix instanceof RegExp ? options.prefix.source : `"${options.prefix}"`
|
|
371
|
+
}.`,
|
|
372
|
+
hint,
|
|
373
|
+
docsUrl: options.docsUrl,
|
|
374
|
+
});
|
|
375
|
+
}
|
|
376
|
+
return violations;
|
|
377
|
+
},
|
|
378
|
+
});
|
|
379
|
+
}
|