Conversation
This reverts commit cde8591.
…nstallation notes
…rounds mdxlint aggressively escapes bracket syntax like [step] to \[step]. The fix.js post-processing step already handled [! markers — this extends it to also unescape [step] markers, eliminating the need for <!-- prettier-ignore --> comments in every MDX file.
Replace @ts-expect-error (which suppresses errors) with @errors: 2339 (which renders the red squiggly underline in the Twoslash output). This visually demonstrates that accessing DATABASE_URL on the client env object is a compile-time TypeScript error.
Twoslash's virtual file system can't resolve path aliases like ~~/env/client and @/env/client, producing error 2307 alongside the intended 2339. Both must be declared in // @errors.
Instead of listing 2307 in @errors (which renders the module-not-found error visually), add declare module declarations for ~~/env/client and @/env/client in the hidden setup section. This satisfies Twoslash's virtual FS so only the intended 2339 error renders on DATABASE_URL.
The re-export pattern (export { env } from './env/client') inside
declare module caused a V8 crash in Twoslash's eval context.
Replaced with inline type declarations that give Twoslash a simple
type to validate against without cross-file resolution.
declare module triggers V8 segfaults in Twoslash's sandboxed compiler. Revert to the stable approach: @Noerrors suppresses the unresolvable path alias error, and @ts-expect-error annotates the intentional type error with a descriptive comment.
|
github-actions
Bot
added
docs
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR is automatically maintained by the Sync PR workflow.
It tracks all commits on
devthat have not yet been merged intomain, keeping the two branches in sync after every push todev.🌍 Preview the latest dev documentation: https://arkenv-dev.vercel.app
Note
This PR is opened and managed by arkenv-bot. It is skipped by Pullfrog and other bot-aware workflows.