-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add warnings if multiple JSX renderers are used #12887
base: main
Are you sure you want to change the base?
Changes from 5 commits
9bc07bd
90631a3
17bf9bf
8dc2140
4952d07
245a050
c468cd9
acd750c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
'@astrojs/preact': patch | ||
'@astrojs/react': patch | ||
'@astrojs/solid-js': patch | ||
--- | ||
|
||
Added a warning message when multiple UI frameworks are being used without either the `include` or `exclude` property being set on the integration. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -71,6 +71,14 @@ export default function ({ include, exclude, compat, devtools }: Options = {}): | |
injectScript('page', 'import "preact/debug";'); | ||
} | ||
}, | ||
'astro:config:done': ({ logger, config }) => { | ||
const knownJsxRenderers = ['@astrojs/react', '@astrojs/preact', '@astrojs/solid-js']; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Vue can also be used in jsx files if configured this way There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wasn't sure at first, should I add Vue to that list then? I figured it might cause wrong errors since Vue can also be used without JSX and could be used just fine alongside React There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right. I think I would only show it from inside the vue integration if it has jsx enabled There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added the warning to Vue in the most recent commit, but the Vue docs don't have a section for using multiple JSX renderers at the moment. I linked to the solid docs for now but we should look into adding that section the the Vue integration's docs as well There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you don't mind, can you create an issue on the docs repo about it? |
||
const enabledKnownJsxRenderers = config.integrations.filter((renderer) => knownJsxRenderers.includes(renderer.name)); | ||
|
||
if (enabledKnownJsxRenderers.length > 1 && !include && !exclude) { | ||
logger.warn('More than one JSX renderer is enabled. This will lead to unexpected behavior unless you set the `include` or `exclude` option. See https://docs.astro.build/en/guides/integrations-guide/preact/#combining-multiple-jsx-frameworks for more information.'); | ||
} | ||
} | ||
}, | ||
}; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.