Fix vscode not resolving test types #5294
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
With some recent changes to our jest types, vscode no longer resolved `describe`, `expect`, etc. I believe the issue is that vscode's typescript extension relies on `tsconfig.json`, without giving users the ability to change that. Our default tsconfig.json excluded our test files, which is what was causing the issue. I do not know why this wasn't an issue when we used `@types/jest`, but there seems to be a lot of special-casing around `@types`, so maybe it was a defualt tsconfig option somewhere that I wasn't able to figure out. In the mean time, if we flip our usage of tsconfig - make tsconfig.json the one that includes all tests files, and tsconfig.build.json the one we use for building the actual deliverable code, we allow vscode to do what it wants to do, while hopefully still only building the files we want
NullSoldier
approved these changes
Oct 1, 2024
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.
Summary
With some recent changes to our jest types, vscode no longer resolved
describe,expect, etc.I believe the issue is that vscode's typescript extension relies on
tsconfig.json, without giving users the ability to change that. Our default tsconfig.json excluded our test files, which is what was causing the issue. I do not know why this wasn't an issue when we used@types/jest, but there seems to be a lot of special-casing around@types, so maybe it was a defualt tsconfig option somewhere that I wasn't able to figure out.In the mean time, if we flip our usage of tsconfig - make tsconfig.json the one that includes all tests files, and tsconfig.build.json the one we use for building the actual deliverable code, we allow vscode to do what it wants to do, while hopefully still only building the files we want
Testing Plan
Documentation
Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference)? If yes, link a
related documentation pull request for the website.
Breaking Change
Is this a breaking change? If yes, add notes below on why this is breaking and label it with
breaking-change-rpcorbreaking-change-sdk.