aboutsummaryrefslogtreecommitdiff
path: root/packages/integrations/react/src/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/integrations/react/src/index.ts')
-rw-r--r--packages/integrations/react/src/index.ts153
1 files changed, 153 insertions, 0 deletions
diff --git a/packages/integrations/react/src/index.ts b/packages/integrations/react/src/index.ts
new file mode 100644
index 000000000..9e781d203
--- /dev/null
+++ b/packages/integrations/react/src/index.ts
@@ -0,0 +1,153 @@
+import react, { type Options as ViteReactPluginOptions } from '@vitejs/plugin-react';
+import type { AstroIntegration, ContainerRenderer } from 'astro';
+import type * as vite from 'vite';
+import {
+ type ReactVersionConfig,
+ type SupportedReactVersion,
+ getReactMajorVersion,
+ isUnsupportedVersion,
+ versionsConfig,
+} from './version.js';
+
+export type ReactIntegrationOptions = Pick<
+ ViteReactPluginOptions,
+ 'include' | 'exclude' | 'babel'
+> & {
+ experimentalReactChildren?: boolean;
+ /**
+ * Disable streaming in React components
+ */
+ experimentalDisableStreaming?: boolean;
+};
+
+const FAST_REFRESH_PREAMBLE = react.preambleCode;
+
+function getRenderer(reactConfig: ReactVersionConfig) {
+ return {
+ name: '@astrojs/react',
+ clientEntrypoint: reactConfig.client,
+ serverEntrypoint: reactConfig.server,
+ };
+}
+
+function optionsPlugin({
+ experimentalReactChildren = false,
+ experimentalDisableStreaming = false,
+}: {
+ experimentalReactChildren: boolean;
+ experimentalDisableStreaming: boolean;
+}): vite.Plugin {
+ const virtualModule = 'astro:react:opts';
+ const virtualModuleId = '\0' + virtualModule;
+ return {
+ name: '@astrojs/react:opts',
+ resolveId(id) {
+ if (id === virtualModule) {
+ return virtualModuleId;
+ }
+ },
+ load(id) {
+ if (id === virtualModuleId) {
+ return {
+ code: `export default {
+ experimentalReactChildren: ${JSON.stringify(experimentalReactChildren)},
+ experimentalDisableStreaming: ${JSON.stringify(experimentalDisableStreaming)}
+ }`,
+ };
+ }
+ },
+ };
+}
+
+function getViteConfiguration(
+ {
+ include,
+ exclude,
+ babel,
+ experimentalReactChildren,
+ experimentalDisableStreaming,
+ }: ReactIntegrationOptions = {},
+ reactConfig: ReactVersionConfig,
+) {
+ return {
+ optimizeDeps: {
+ include: [reactConfig.client],
+ exclude: [reactConfig.server],
+ },
+ plugins: [
+ react({ include, exclude, babel }),
+ optionsPlugin({
+ experimentalReactChildren: !!experimentalReactChildren,
+ experimentalDisableStreaming: !!experimentalDisableStreaming,
+ }),
+ ],
+ ssr: {
+ noExternal: [
+ // These are all needed to get mui to work.
+ '@mui/material',
+ '@mui/base',
+ '@babel/runtime',
+ 'use-immer',
+ '@material-tailwind/react',
+ ],
+ },
+ };
+}
+
+export default function ({
+ include,
+ exclude,
+ babel,
+ experimentalReactChildren,
+ experimentalDisableStreaming,
+}: ReactIntegrationOptions = {}): AstroIntegration {
+ const majorVersion = getReactMajorVersion();
+ if (isUnsupportedVersion(majorVersion)) {
+ throw new Error(`Unsupported React version: ${majorVersion}.`);
+ }
+ const versionConfig = versionsConfig[majorVersion as SupportedReactVersion];
+
+ return {
+ name: '@astrojs/react',
+ hooks: {
+ 'astro:config:setup': ({ command, addRenderer, updateConfig, injectScript }) => {
+ addRenderer(getRenderer(versionConfig));
+ updateConfig({
+ vite: getViteConfiguration(
+ { include, exclude, babel, experimentalReactChildren, experimentalDisableStreaming },
+ versionConfig,
+ ),
+ });
+ if (command === 'dev') {
+ const preamble = FAST_REFRESH_PREAMBLE.replace(`__BASE__`, '/');
+ injectScript('before-hydration', preamble);
+ }
+ },
+ 'astro:config:done': ({ logger, config }) => {
+ const knownJsxRenderers = ['@astrojs/react', '@astrojs/preact', '@astrojs/solid-js'];
+ 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/react/#combining-multiple-jsx-frameworks for more information.',
+ );
+ }
+ },
+ },
+ };
+}
+
+export function getContainerRenderer(): ContainerRenderer {
+ const majorVersion = getReactMajorVersion();
+ if (isUnsupportedVersion(majorVersion)) {
+ throw new Error(`Unsupported React version: ${majorVersion}.`);
+ }
+ const versionConfig = versionsConfig[majorVersion as SupportedReactVersion];
+
+ return {
+ name: '@astrojs/react',
+ serverEntrypoint: versionConfig.server,
+ };
+}