Extract out test environment global types #494
Merged
Conversation
This file contains 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
Miniflare's Jest and Vitest environments define a few global helper functions. Previously, the global type augmentations for these functions were included with the implementations. Unfortunately, API extractor (the tool we use to bundle `*.d.ts` files), doesn't support bundling global augmentations (microsoft/rushstack#1176). This change extracts those augmentations into separate `globals.d.ts` files. This means users will be able to add `jest-environment-miniflare/globals` or `vitest-environment-miniflare/globals` to their `types` configuration and get these types in their environment. Ref #348
|
penalosa
approved these changes
Feb 13, 2023
Sign up for free
to 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.
Miniflare's Jest and Vitest environments define a few global helper functions. Previously, the global type augmentations for these functions were included with the implementations. Unfortunately, API extractor (the tool we use to bundle
*.d.tsfiles), doesn't support bundling global augmentations (microsoft/rushstack#1176).This change extracts those augmentations into separate
globals.d.tsfiles. This means users will be able to addjest-environment-miniflare/globalsorvitest-environment-miniflare/globalsto theirtypesconfiguration and get these types in their environment, e.g.{ "compilerOptions": { "target": "esnext", "lib": ["esnext"], "module": "esnext", "moduleResolution": "node", "types": [ "@cloudflare/workers-types", "vitest-environment-miniflare/globals" ] } }Closes #94
Ref #348