Uh oh!
There was an error while loading. Please reload this page.
fix(docs): declare Nitro auto-import globals for code samples - #2290
Merged
Conversation
The nitro-native-build changelog sample calls useStorage() (a Nitro server-side auto-import) from a step, which the docs type-checker couldn't resolve and failed with TS2552. Add liberal global declarations for useStorage/useDatabase/useRuntimeConfig so Nitro auto-imports type-check in docs samples.
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Contributor
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
workflow with 1 step💻 Local Development
▲ Production (Vercel)
workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
workflow with 10 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 25 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 50 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 10 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 25 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 50 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
stream pipeline with 5 transform steps (1MB)💻 Local Development
▲ Production (Vercel)
10 parallel streams (1MB each)💻 Local Development
▲ Production (Vercel)
fan-out fan-in 10 streams (1MB each)💻 Local Development
▲ Production (Vercel)
SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
❌ Some benchmark jobs failed:
Check the workflow run for details. |
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests▲ Vercel Production (4 failed)example (1 failed):
sveltekit (1 failed):
vite (2 failed):
📋 Other (1 failed)e2e-local-prod-nest-stable (1 failed):
Details by Category❌ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 📋 Other
❌ Some E2E test jobs failed:
Check the workflow run for details. |
karthikscale3
approved these changes
Jun 8, 2026
Uh oh!
There was an error while loading. Please reload this page.
github-actionsBot
added a commit
that referenced
this pull request
Jun 8, 2026
The nitro-native-build changelog sample calls useStorage() (a Nitro server-side auto-import) from a step, which the docs type-checker couldn't resolve and failed with TS2552. Add liberal global declarations for useStorage/useDatabase/useRuntimeConfig so Nitro auto-imports type-check in docs samples. Signed-off-by: Nathan Rajlich <n@n8.io>
Contributor
Backport PR opened against |
pranaygp pushed a commit
that referenced
this pull request
Jun 8, 2026
…#2291) The nitro-native-build changelog sample calls useStorage() (a Nitro server-side auto-import) from a step, which the docs type-checker couldn't resolve and failed with TS2552. Add liberal global declarations for useStorage/useDatabase/useRuntimeConfig so Nitro auto-imports type-check in docs samples. Signed-off-by: Nathan Rajlich <n@n8.io> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
pranaygp added a commit
that referenced
this pull request
Jun 8, 2026
pranaygp added a commit
that referenced
this pull request
Jun 11, 2026
…-attributes-client * origin/main: (32 commits) feat(core): add optional namespace for queue topic prefix (#2305) [web-shared] Show precise durations in the new trace viewer (#2335) Validate unique workflow step IDs at build time (#2018) Move run attributes into their own detail card (#2327) [core] Forward-port stream reconnect to getReadable level (#2318) [docs] Add "Step executed multiple times" error page (#2310) Fix flickering on the detail panel when navigating the trace viewer (#2325) Version Packages (beta) (#2254) Patch vulnerable package dependencies (#2301) Deprecate DurableAgent and update it with WorkflowAgent in v5 docs (#2285) [codex] Fix partial world-local exclusive writes (#2296) [world-vercel] Validate ref resolve responses before use (#2035) fix: bump devalue to 5.8.1 (#2292) Handle lazy stream key request failures (#2257) fix(docs): declare Nitro auto-import globals for code samples (#2290) [core] Preserve event-log order in hook-vs-sleep replay races (#2171) (#2185) docs: add nitro changelog (#2232) fix(next): always apply turbopack content condition regardless of builder mode (#2253) Update @vercel/queue from 0.2.1 to 0.3.0 (#2255) [nest] Use AST-based CommonJS import rewriting (#2080) ... # Conflicts: # packages/world-local/src/storage/events-storage.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the failing Docs Code Samples check on
main. The native Nitro v3 bundling changelog (added in #2232) includes a code sample that callsuseStorage("cache")— a Nitro server-side auto-import — from a"use step"function. The docs type-checker has no knowledge of Nitro's auto-imports, so it failed with:This was failing on
main, independent of any feature PR.Changes
packages/docs-typecheck/src/docs-globals.d.ts: Declare liberal global types for the Nitro server-side auto-imports referenced in docs samples (useStorage,useDatabase,useRuntimeConfig). These are globally available inside a Nitro runtime (and thus inside steps under native Nitro v3 bundling), so they legitimately appear unimported in samples.Validation
pnpm test:docs— all docs samples pass (918 passed, 0 failed; previously 1 failed)pnpm biome check packages/docs-typecheck/src/docs-globals.d.ts— clean@workflow/docs-typecheckis private tooling)