fix: Strips jsxFactory from tsconfig if --importSource is set
#988
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
🦋 Changeset detectedLatest commit: e4d8db3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rschristian
changed the title
--importSource is set
|
Size Change: 0 B Total Size: 63.4 kB ℹ️ View Unchanged
|
rschristian
force-pushed
the
fix/jsx-import-source-tsconfig
branch
from
2f6f13f
to
74de373
Compare
rschristian
force-pushed
the
fix/jsx-import-source-tsconfig
branch
from
74de373
to
e4d8db3
Compare
rschristian
commented
Aug 10, 2022
Comment on lines
+553
to
+562
| ...(options.jsxImportSource | ||
| ? { | ||
| jsx: 'react-jsx', | ||
| jsxImportSource: options.jsxImportSource, | ||
| } | ||
| : { | ||
| jsx: 'preserve', | ||
| jsxFactory: options.jsx, | ||
| jsxFragmentFactory: options.jsxFragment, | ||
| }), |
There was a problem hiding this comment.
Theoretically we would be fine to leave jsx untouched & remove that first piece of the ternary, however, that relies on the assumption that the user does have a tsconfig.json and that it's correctly set.
Conditionally adding jsxFactory (and jsxFragmentFactory) is enough to quell the errors we were getting in the linked issue, but when using --jsxImportSource with TS, the tsconfig.json will need to have different values. While users in all likelihood will have a tsconfig.json that's correctly configured in that case, if they do not, their typings will contain any where JSX references should be.
Setting these configurations ourselves, at least as defaults, allows us to make fewer assumptions about users' configs that are external to Microbundle (and hopefully will raise fewer issues).
developit
reviewed
Aug 11, 2022
| jsxImportSource: options.jsxImportSource, | ||
| } | ||
| : { | ||
| jsx: 'preserve', |
There was a problem hiding this comment.
should this be preserve, or react?
There was a problem hiding this comment.
preserve should be correct, though from my quick tests I don't think it makes a difference either way.
preserve is to be used when having another tool transpile JSX (e.g., babel), which is what we do. react on the other hand has TSC transpile it itself. TS Docs
I think, at best, react would do nothing, and at worst, it'd slow down type generation due to trying to handle JSX which we don't need. No one's raised any issues regarding preserve so I'd assume it's fine.
Edit: Depends on what we want, I suppose. I'd prefer to have TS handle as little as possible and preserve is already the default behavior. I didn't originally realize we did have TS handle JSX.
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.
Closes #857
If a user supplies
--jsxImportSourcewe should removejsxFactoryandjsxFragmentFactoryfrom the defaulttsconfigas they're mutually exclusive withjsx: 'react-jsx'.