From 6919aac04f1e4a6b8b7aea976f9afb4e958b9fa5 Mon Sep 17 00:00:00 2001 From: aymericzip Date: Tue, 17 Nov 2026 15:52:11 -0600 Subject: [PATCH 1/3] feat(create): add Intlayer i18n add-on for React and Solid with localized routes --- .changeset/intlayer-addon.md | 6 + .../react/add-ons/intlayer/README.md | 9 ++ .../intlayer/assets/_dot_gitignore.append | 3 + .../intlayer/assets/intlayer.config.ts | 138 ++++++++++++++++++ .../src/components/IntlayerLocaleSwitcher.tsx | 66 +++++++++ .../src/components/demo-intlayer.content.ts | 29 ++++ .../assets/src/components/localized-link.tsx | 52 +++++++ .../assets/src/hooks/useLocalizedNavigate.ts | 46 ++++++ .../src/routes/{-$locale}/demo.intlayer.tsx | 33 +++++ .../assets/src/routes/{-$locale}/route.tsx | 22 +++ .../react/add-ons/intlayer/info.json | 28 ++++ .../react/add-ons/intlayer/package.json | 9 ++ .../solid/add-ons/intlayer/README.md | 9 ++ .../intlayer/assets/_dot_gitignore.append | 3 + .../intlayer/assets/intlayer.config.ts | 138 ++++++++++++++++++ .../src/components/IntlayerLocaleSwitcher.tsx | 68 +++++++++ .../assets/src/components/LocalizedLink.tsx | 62 ++++++++ .../src/components/demo-intlayer.content.ts | 29 ++++ .../assets/src/hooks/useLocalizedNavigate.ts | 46 ++++++ .../src/routes/{-$locale}/demo.intlayer.tsx | 33 +++++ .../assets/src/routes/{-$locale}/route.tsx | 22 +++ .../solid/add-ons/intlayer/info.json | 28 ++++ .../solid/add-ons/intlayer/package.json | 10 ++ packages/create/tests/intlayer-addon.test.ts | 102 +++++++++++++ 24 files changed, 991 insertions(+) create mode 100644 .changeset/intlayer-addon.md create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/README.md create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/_dot_gitignore.append create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/intlayer.config.ts create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/localized-link.tsx create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/info.json create mode 100644 packages/create/src/frameworks/react/add-ons/intlayer/package.json create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/README.md create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/_dot_gitignore.append create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/intlayer.config.ts create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/LocalizedLink.tsx create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/info.json create mode 100644 packages/create/src/frameworks/solid/add-ons/intlayer/package.json create mode 100644 packages/create/tests/intlayer-addon.test.ts diff --git a/.changeset/intlayer-addon.md b/.changeset/intlayer-addon.md new file mode 100644 index 000000000..a83597209 --- /dev/null +++ b/.changeset/intlayer-addon.md @@ -0,0 +1,6 @@ +--- +'@tanstack/create': minor +'@tanstack/cli': minor +--- + +Add an Intlayer i18n add-on for React and Solid. diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/README.md b/packages/create/src/frameworks/react/add-ons/intlayer/README.md new file mode 100644 index 000000000..5f452a4dd --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/README.md @@ -0,0 +1,9 @@ +# Intlayer i18n + +This add-on sets up [Intlayer](https://intlayer.org/doc/environment/tanstack-start) with localized routes. + +- Locales and routing are configured in `intlayer.config.ts` (`prefix-no-default`: `/demo/intlayer`, `/fr/demo/intlayer`). +- Routes under `src/routes/{-$locale}/` are localized. Its `route.tsx` validates the locale prefix and provides `IntlayerProvider`. +- Use `LocalizedLink` and `useLocalizedNavigate` to keep the current locale when navigating. +- Content is declared in `*.content.ts` files, outside `src/routes`. The `vite-intlayer` plugin builds them into `.intlayer`. +- To localize the whole app, move your routes under `src/routes/{-$locale}/`, or run `npx intlayer init`. diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/_dot_gitignore.append b/packages/create/src/frameworks/react/add-ons/intlayer/assets/_dot_gitignore.append new file mode 100644 index 000000000..1a2a41cf8 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/_dot_gitignore.append @@ -0,0 +1,3 @@ + +# Intlayer +.intlayer diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/intlayer.config.ts b/packages/create/src/frameworks/react/add-ons/intlayer/assets/intlayer.config.ts new file mode 100644 index 000000000..cf2cb3ea6 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/intlayer.config.ts @@ -0,0 +1,138 @@ +import { type IntlayerConfig, Locales } from 'intlayer' + +/** + * Intlayer configuration file documentation + * @see https://intlayer.org/doc/concept/configuration + */ + +const config: IntlayerConfig = { + internationalization: { + locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH], + /** + * Default locale used as a fallback if the requested locale is not found. + */ + defaultLocale: Locales.ENGLISH, + }, + routing: { + /** + * Locale routing strategy. + * - "prefix-no-default": Prefix all except the default locale (e.g., /dashboard, /fr/dashboard). + * - "prefix-all": Prefix all locales (e.g., /en/dashboard, /fr/dashboard). + * - "no-prefix": No locale in the URL. + * - "search-params": Use search params to define the locale (e.g., /dashboard/?locale=en, /dashboard/?locale=fr) + * Default: "prefix-no-default" + */ + mode: 'prefix-no-default', + + /** + * Enables the Intlayer locale-routing proxy (middleware). + * Handles locale detection, redirects and rewrites in dev, preview and SSR. + * Leave unset for auto mode: dev and preview servers keep locale routing + * URL-driven by ignoring the stored locale. `true` forces the full + * behaviour everywhere, `false` disables the proxy. + * Default: undefined (auto) + */ + enableProxy: false, + }, + editor: { + /** + * Whether the visual editor is enabled. + */ + enabled: false, + + /** + * URL of your application for origin validation. + */ + applicationURL: 'http://localhost:3000', + }, + ai: { + /** + * AI provider to use. + * Options: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio', 'moonshotai' + */ + provider: 'openai', + model: 'gpt-5.6-terra', + apiKey: process.env.OPENAI_API_KEY, + /** + * Additional context for the translations + * + * Can be use in addition of the dictionary `description` field + */ + applicationContext: [''].join('\n'), + }, + compiler: { + enabled: false, + + /** + * Defines the output files path for autogenerated content (compiler / autofill / extract) + * + * - `./` paths are resolved relative to the component directory. + * - `/` paths are resolved relative to the project root (`baseDir`). + * + * - Including the `{{locale}}` variable in the path will trigger the generation of separate dictionaries per locale. + * + * Example: + * ```ts + * { + * // Create Multilingual .content.ts files close to the component + * output: ({ fileName, extension }) => `./${fileName}${extension}`, + * } + * ``` + * + * ```ts + * { + * // Create centralize per-locale JSON at the root of the project + * output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`, + * } + * ``` + * + * Variable list: + * - `fileName`: The name of the file. + * - `key`: The key of the content. + * - `locale`: The locale of the content. + * - `extension`: The extension of the file. + * - `componentFileName`: The name of the component file. + * - `componentExtension`: The extension of the component file. + * - `format`: The format of the dictionary. + * - `componentFormat`: The format of the component dictionary. + * - `componentDirPath`: The directory path of the component. + */ + output: ({ fileName }) => `./${fileName}.content.ts`, + + /** + * Indicates if the components should be saved after being transformed. + * + * - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed. + * + * - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory. + */ + saveComponents: false, + }, + dictionary: { + /** + * Controls how dictionaries are imported. + * - "static": Statically imported at build time. + * - "dynamic": Dynamically imported using Suspense. + * - "fetch": Fetched dynamically via the live sync API. + */ + importMode: 'static', + }, + build: { + /** + * Minify the dictionaries to reduce the bundle size. + */ + minify: true, + + /** + * Purge the unused keys in a dictionaries + */ + purge: true, + + /** + * Indicates if the build should check TypeScript types + */ + checkTypes: false, + }, +} + +export default config diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx new file mode 100644 index 000000000..95f29101d --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx @@ -0,0 +1,66 @@ +import { useLocation } from '@tanstack/react-router' +import { + getHTMLTextDir, + getLocaleName, + getPathWithoutLocale, + getPrefix, + Locales, +} from 'intlayer' +import { useLocale } from 'react-intlayer' + +import { LocalizedLink, type To } from './localized-link' + +export default function IntlayerLocaleSwitcher() { + const { pathname } = useLocation() + + const { availableLocales, locale, setLocale } = useLocale() + + const pathWithoutLocale = getPathWithoutLocale(pathname) + + return ( +
+ +
+ {availableLocales.map((localeItem) => ( + { + // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale + if ( + event.metaKey || + event.ctrlKey || + event.shiftKey || + event.altKey + ) + return + setLocale(localeItem) + }} + params={{ locale: getPrefix(localeItem).localePrefix }} + to={pathWithoutLocale as To} + replace // Will ensure that the "go back" browser button will redirect to the previous page + > + + {/* Locale - e.g. FR */} + {localeItem} + + + {/* Language in its own Locale - e.g. Français */} + {getLocaleName(localeItem, locale)} + + + {/* Language in current Locale - e.g. Francés with current locale set to Locales.SPANISH */} + {getLocaleName(localeItem)} + + + {/* Language in English - e.g. French */} + {getLocaleName(localeItem, Locales.ENGLISH)} + + + ))} +
+
+ ) +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts new file mode 100644 index 000000000..eb7b2b422 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts @@ -0,0 +1,29 @@ +import { type Dictionary, t } from 'intlayer' + +const intlayerDemoContent = { + key: 'intlayer-demo', + content: { + title: t({ + en: 'Hello from Intlayer', + fr: 'Bonjour depuis Intlayer', + es: 'Hola desde Intlayer', + }), + description: t({ + en: 'Localized routes live under src/routes/{-$locale}: /demo/intlayer, /fr/demo/intlayer…', + fr: 'Les routes localisées sont dans src/routes/{-$locale} : /demo/intlayer, /fr/demo/intlayer…', + es: 'Las rutas localizadas están en src/routes/{-$locale}: /demo/intlayer, /fr/demo/intlayer…', + }), + currentLocale: t({ + en: 'Current locale:', + fr: 'Langue actuelle :', + es: 'Idioma actual:', + }), + learnMore: t({ + en: 'Learn how Intlayer works with TanStack Start', + fr: 'Découvrir Intlayer avec TanStack Start', + es: 'Descubre Intlayer con TanStack Start', + }), + }, +} satisfies Dictionary + +export default intlayerDemoContent diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/localized-link.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/localized-link.tsx new file mode 100644 index 000000000..00a6a20c2 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/localized-link.tsx @@ -0,0 +1,52 @@ +import type { FC } from 'react' + +import { Link, type LinkComponentProps } from '@tanstack/react-router' +import { useLocale } from 'react-intlayer' +import { getPrefix } from 'intlayer' + +export const LOCALE_ROUTE = '{-$locale}' as const + +/** + * Adds the locale segment to absolute paths. An omitted `to` goes to the locale + * root, and relative paths ('.', '..') are kept as is. + */ +export const localizeTo = (to?: string) => + to === undefined || to.startsWith('/') ? `/${LOCALE_ROUTE}${to ?? ''}` : to + +/** Adds the locale param, keeping the function form of `params`. */ +export const localizeParams = (locale: string | undefined, params?: unknown) => + typeof params === 'function' + ? (prev: Record) => ({ locale, ...params(prev) }) + : { locale, ...(typeof params === 'object' ? params : {}) } + +export type To = StripLocalePrefix + +export type StripLocalePrefix = T extends + | `/${typeof LOCALE_ROUTE}/` + | `/${typeof LOCALE_ROUTE}` + ? '/' + : T extends `/${typeof LOCALE_ROUTE}/${infer Rest}` + ? `/${Rest}` + : T + +type LocalizedLinkProps = { + to?: To +} & Omit + +export const LocalizedLink: FC = (props) => { + const { locale } = useLocale() + const { localePrefix } = getPrefix(locale) + + return ( + + ) +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts new file mode 100644 index 000000000..ca4566325 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts @@ -0,0 +1,46 @@ +import { useNavigate } from '@tanstack/react-router' +import { getPrefix } from 'intlayer' +import { useLocale } from 'react-intlayer' +import { + localizeParams, + localizeTo, + type StripLocalePrefix, +} from '@/components/localized-link' +import type { FileRouteTypes } from '@/routeTree.gen' + +type NavigateFn = ReturnType +type BaseNavigateOptions = Parameters[0] + +type LocalizedTo = StripLocalePrefix + +export type LocalizedNavigateOptions = Omit< + BaseNavigateOptions, + 'to' | 'params' +> & { + to: LocalizedTo + params?: Omit, 'locale'> +} + +type LocalizedNavigate = ( + options: LocalizedNavigateOptions, +) => ReturnType + +export const useLocalizedNavigate = () => { + const navigate = useNavigate() + + const { locale } = useLocale() + + const localizedNavigate: LocalizedNavigate = (args: any) => { + const { localePrefix } = getPrefix(locale) + const { to, params, ...rest } = + typeof args === 'string' ? { to: args } : args + + return navigate({ + ...rest, + to: localizeTo(to), + params: localizeParams(localePrefix, params), + } as any) + } + + return localizedNavigate +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx new file mode 100644 index 000000000..1e6060971 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx @@ -0,0 +1,33 @@ +import { createFileRoute } from '@tanstack/react-router' +import { useIntlayer, useLocale } from 'react-intlayer' + +import IntlayerLocaleSwitcher from '@/components/IntlayerLocaleSwitcher' + +export const Route = createFileRoute('/{-$locale}/demo/intlayer')({ + component: IntlayerDemo, +}) + +function IntlayerDemo() { + const content = useIntlayer('intlayer-demo') + const { locale } = useLocale() + + return ( +
+
+

{content.title}

+

{content.description}

+

+ {content.currentLocale} {locale} +

+ + + {content.learnMore} + +
+
+ ) +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx new file mode 100644 index 000000000..f3fd2e22c --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx @@ -0,0 +1,22 @@ +import { createFileRoute, notFound, Outlet } from '@tanstack/react-router' +import { defaultLocale, validatePrefix } from 'intlayer' +import { IntlayerProvider } from 'react-intlayer' + +// Routes nested under {-$locale} are localized: /demo/intlayer, /fr/demo/intlayer… +export const Route = createFileRoute('/{-$locale}')({ + beforeLoad: ({ params }) => { + // Unknown locale prefixes (e.g. /xx/demo/intlayer) are not found + if (!validatePrefix(params.locale).isValid) throw notFound() + }, + component: LocaleLayout, +}) + +function LocaleLayout() { + const { locale = defaultLocale } = Route.useParams() + + return ( + + + + ) +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/info.json b/packages/create/src/frameworks/react/add-ons/intlayer/info.json new file mode 100644 index 000000000..0b53def6b --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/info.json @@ -0,0 +1,28 @@ +{ + "name": "Intlayer (i18n)", + "description": "Type-safe i18n with localized routes and content declared next to your components.", + "phase": "add-on", + "modes": ["file-router"], + "type": "add-on", + "category": "i18n", + "color": "#6366F1", + "priority": 31, + "link": "https://intlayer.org/doc/environment/tanstack-start", + "routes": [ + { + "icon": "Languages", + "url": "/demo/intlayer", + "name": "Intlayer i18n", + "path": "src/routes/{-$locale}/demo.intlayer.tsx", + "jsName": "IntlayerDemo" + } + ], + "integrations": [ + { + "type": "vite-plugin", + "jsName": "intlayer", + "import": "import { intlayer } from 'vite-intlayer'", + "code": "intlayer()" + } + ] +} diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/package.json b/packages/create/src/frameworks/react/add-ons/intlayer/package.json new file mode 100644 index 000000000..d9d8b0fb1 --- /dev/null +++ b/packages/create/src/frameworks/react/add-ons/intlayer/package.json @@ -0,0 +1,9 @@ +{ + "dependencies": { + "intlayer": "^9.8.0", + "react-intlayer": "^9.8.0" + }, + "devDependencies": { + "vite-intlayer": "^9.8.0" + } +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/README.md b/packages/create/src/frameworks/solid/add-ons/intlayer/README.md new file mode 100644 index 000000000..5f452a4dd --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/README.md @@ -0,0 +1,9 @@ +# Intlayer i18n + +This add-on sets up [Intlayer](https://intlayer.org/doc/environment/tanstack-start) with localized routes. + +- Locales and routing are configured in `intlayer.config.ts` (`prefix-no-default`: `/demo/intlayer`, `/fr/demo/intlayer`). +- Routes under `src/routes/{-$locale}/` are localized. Its `route.tsx` validates the locale prefix and provides `IntlayerProvider`. +- Use `LocalizedLink` and `useLocalizedNavigate` to keep the current locale when navigating. +- Content is declared in `*.content.ts` files, outside `src/routes`. The `vite-intlayer` plugin builds them into `.intlayer`. +- To localize the whole app, move your routes under `src/routes/{-$locale}/`, or run `npx intlayer init`. diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/_dot_gitignore.append b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/_dot_gitignore.append new file mode 100644 index 000000000..1a2a41cf8 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/_dot_gitignore.append @@ -0,0 +1,3 @@ + +# Intlayer +.intlayer diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/intlayer.config.ts b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/intlayer.config.ts new file mode 100644 index 000000000..cf2cb3ea6 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/intlayer.config.ts @@ -0,0 +1,138 @@ +import { type IntlayerConfig, Locales } from 'intlayer' + +/** + * Intlayer configuration file documentation + * @see https://intlayer.org/doc/concept/configuration + */ + +const config: IntlayerConfig = { + internationalization: { + locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH], + /** + * Default locale used as a fallback if the requested locale is not found. + */ + defaultLocale: Locales.ENGLISH, + }, + routing: { + /** + * Locale routing strategy. + * - "prefix-no-default": Prefix all except the default locale (e.g., /dashboard, /fr/dashboard). + * - "prefix-all": Prefix all locales (e.g., /en/dashboard, /fr/dashboard). + * - "no-prefix": No locale in the URL. + * - "search-params": Use search params to define the locale (e.g., /dashboard/?locale=en, /dashboard/?locale=fr) + * Default: "prefix-no-default" + */ + mode: 'prefix-no-default', + + /** + * Enables the Intlayer locale-routing proxy (middleware). + * Handles locale detection, redirects and rewrites in dev, preview and SSR. + * Leave unset for auto mode: dev and preview servers keep locale routing + * URL-driven by ignoring the stored locale. `true` forces the full + * behaviour everywhere, `false` disables the proxy. + * Default: undefined (auto) + */ + enableProxy: false, + }, + editor: { + /** + * Whether the visual editor is enabled. + */ + enabled: false, + + /** + * URL of your application for origin validation. + */ + applicationURL: 'http://localhost:3000', + }, + ai: { + /** + * AI provider to use. + * Options: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio', 'moonshotai' + */ + provider: 'openai', + model: 'gpt-5.6-terra', + apiKey: process.env.OPENAI_API_KEY, + /** + * Additional context for the translations + * + * Can be use in addition of the dictionary `description` field + */ + applicationContext: [''].join('\n'), + }, + compiler: { + enabled: false, + + /** + * Defines the output files path for autogenerated content (compiler / autofill / extract) + * + * - `./` paths are resolved relative to the component directory. + * - `/` paths are resolved relative to the project root (`baseDir`). + * + * - Including the `{{locale}}` variable in the path will trigger the generation of separate dictionaries per locale. + * + * Example: + * ```ts + * { + * // Create Multilingual .content.ts files close to the component + * output: ({ fileName, extension }) => `./${fileName}${extension}`, + * } + * ``` + * + * ```ts + * { + * // Create centralize per-locale JSON at the root of the project + * output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`, + * } + * ``` + * + * Variable list: + * - `fileName`: The name of the file. + * - `key`: The key of the content. + * - `locale`: The locale of the content. + * - `extension`: The extension of the file. + * - `componentFileName`: The name of the component file. + * - `componentExtension`: The extension of the component file. + * - `format`: The format of the dictionary. + * - `componentFormat`: The format of the component dictionary. + * - `componentDirPath`: The directory path of the component. + */ + output: ({ fileName }) => `./${fileName}.content.ts`, + + /** + * Indicates if the components should be saved after being transformed. + * + * - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed. + * + * - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory. + */ + saveComponents: false, + }, + dictionary: { + /** + * Controls how dictionaries are imported. + * - "static": Statically imported at build time. + * - "dynamic": Dynamically imported using Suspense. + * - "fetch": Fetched dynamically via the live sync API. + */ + importMode: 'static', + }, + build: { + /** + * Minify the dictionaries to reduce the bundle size. + */ + minify: true, + + /** + * Purge the unused keys in a dictionaries + */ + purge: true, + + /** + * Indicates if the build should check TypeScript types + */ + checkTypes: false, + }, +} + +export default config diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx new file mode 100644 index 000000000..2d30c61e8 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx @@ -0,0 +1,68 @@ +import { useLocation } from '@tanstack/solid-router' +import { + getHTMLTextDir, + getLocaleName, + getPathWithoutLocale, + getPrefix, + Locales, +} from 'intlayer' +import { For } from 'solid-js' +import { useLocale } from 'solid-intlayer' + +import { LocalizedLink, type To } from './LocalizedLink' + +export default function IntlayerLocaleSwitcher() { + const location = useLocation() + + const { availableLocales, locale, setLocale } = useLocale() + + const pathWithoutLocale = () => getPathWithoutLocale(location().pathname) + + return ( +
+ +
+ + {(localeItem) => ( + { + // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale + if ( + event.metaKey || + event.ctrlKey || + event.shiftKey || + event.altKey + ) + return + setLocale(localeItem) + }} + params={{ locale: getPrefix(localeItem).localePrefix }} + to={pathWithoutLocale() as To} + replace // Will ensure that the "go back" browser button will redirect to the previous page + > + + {/* Locale - e.g. FR */} + {localeItem} + + + {/* Language in its own Locale - e.g. Français */} + {getLocaleName(localeItem, locale())} + + + {/* Language in current Locale - e.g. Francés with current locale set to Locales.SPANISH */} + {getLocaleName(localeItem)} + + + {/* Language in English - e.g. French */} + {getLocaleName(localeItem, Locales.ENGLISH)} + + + )} + +
+
+ ) +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/LocalizedLink.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/LocalizedLink.tsx new file mode 100644 index 000000000..1565db755 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/LocalizedLink.tsx @@ -0,0 +1,62 @@ +import { Link, type LinkProps } from '@tanstack/solid-router' +import { getPrefix } from 'intlayer' +import { useLocale } from 'solid-intlayer' +import type { JSX } from 'solid-js' + +export const LOCALE_ROUTE = '{-$locale}' as const + +/** + * Adds the locale segment to absolute paths. An omitted `to` goes to the locale + * root, and relative paths ('.', '..') are kept as is. + */ +export const localizeTo = (to?: string) => + to === undefined || to.startsWith('/') ? `/${LOCALE_ROUTE}${to ?? ''}` : to + +/** Adds the locale param, keeping the function form of `params`. */ +export const localizeParams = (locale: string | undefined, params?: unknown) => + typeof params === 'function' + ? (prev: Record) => ({ locale, ...params(prev) }) + : { locale, ...(typeof params === 'object' ? params : {}) } + +export type RemoveLocaleParam = TVal extends string + ? RemoveLocaleFromString + : TVal + +export type To = RemoveLocaleParam + +type CollapseDoubleSlashes = + TString extends `${infer THead}//${infer TTail}` + ? CollapseDoubleSlashes<`${THead}/${TTail}`> + : TString + +export type LocalizedLinkProps = Omit & { + to?: To +} & JSX.AnchorHTMLAttributes + +type RemoveAll< + TString extends string, + TSub extends string, +> = TString extends `${infer THead}${TSub}${infer TTail}` + ? RemoveAll<`${THead}${TTail}`, TSub> + : TString + +type RemoveLocaleFromString = CollapseDoubleSlashes< + RemoveAll +> + +export const LocalizedLink = (props: LocalizedLinkProps) => { + const { locale } = useLocale() + + return ( + + ) +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts new file mode 100644 index 000000000..eb7b2b422 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/demo-intlayer.content.ts @@ -0,0 +1,29 @@ +import { type Dictionary, t } from 'intlayer' + +const intlayerDemoContent = { + key: 'intlayer-demo', + content: { + title: t({ + en: 'Hello from Intlayer', + fr: 'Bonjour depuis Intlayer', + es: 'Hola desde Intlayer', + }), + description: t({ + en: 'Localized routes live under src/routes/{-$locale}: /demo/intlayer, /fr/demo/intlayer…', + fr: 'Les routes localisées sont dans src/routes/{-$locale} : /demo/intlayer, /fr/demo/intlayer…', + es: 'Las rutas localizadas están en src/routes/{-$locale}: /demo/intlayer, /fr/demo/intlayer…', + }), + currentLocale: t({ + en: 'Current locale:', + fr: 'Langue actuelle :', + es: 'Idioma actual:', + }), + learnMore: t({ + en: 'Learn how Intlayer works with TanStack Start', + fr: 'Découvrir Intlayer avec TanStack Start', + es: 'Descubre Intlayer con TanStack Start', + }), + }, +} satisfies Dictionary + +export default intlayerDemoContent diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts new file mode 100644 index 000000000..72cafb672 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/hooks/useLocalizedNavigate.ts @@ -0,0 +1,46 @@ +import { useNavigate } from '@tanstack/solid-router' +import { getPrefix } from 'intlayer' +import { useLocale } from 'solid-intlayer' +import { + localizeParams, + localizeTo, + type RemoveLocaleParam, +} from '../components/LocalizedLink' +import type { FileRouteTypes } from '../routeTree.gen' + +type NavigateFn = ReturnType +type BaseNavigateOptions = Parameters[0] + +type LocalizedTo = RemoveLocaleParam + +export type LocalizedNavigateOptions = Omit< + BaseNavigateOptions, + 'to' | 'params' +> & { + to: LocalizedTo + params?: Omit, 'locale'> +} + +type LocalizedNavigate = ( + options: LocalizedNavigateOptions, +) => ReturnType + +export const useLocalizedNavigate = () => { + const navigate = useNavigate() + + const { locale } = useLocale() + + const localizedNavigate: LocalizedNavigate = (args: any) => { + const { localePrefix } = getPrefix(locale()) + const { to, params, ...rest } = + typeof args === 'string' ? { to: args } : args + + return navigate({ + ...rest, + to: localizeTo(to), + params: localizeParams(localePrefix, params), + } as any) + } + + return localizedNavigate +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx new file mode 100644 index 000000000..df26b2588 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/demo.intlayer.tsx @@ -0,0 +1,33 @@ +import { createFileRoute } from '@tanstack/solid-router' +import { useIntlayer, useLocale } from 'solid-intlayer' + +import IntlayerLocaleSwitcher from '../../components/IntlayerLocaleSwitcher' + +export const Route = createFileRoute('/{-$locale}/demo/intlayer')({ + component: IntlayerDemo, +}) + +function IntlayerDemo() { + const content = useIntlayer('intlayer-demo') + const { locale } = useLocale() + + return ( +
+
+

{content.title}

+

{content.description}

+

+ {content.currentLocale} {locale()} +

+ + + {content.learnMore} + +
+
+ ) +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx new file mode 100644 index 000000000..fa298760b --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx @@ -0,0 +1,22 @@ +import { createFileRoute, notFound, Outlet } from '@tanstack/solid-router' +import { defaultLocale, validatePrefix } from 'intlayer' +import { IntlayerProvider } from 'solid-intlayer' + +// Routes nested under {-$locale} are localized: /demo/intlayer, /fr/demo/intlayer… +export const Route = createFileRoute('/{-$locale}')({ + beforeLoad: ({ params }) => { + // Unknown locale prefixes (e.g. /xx/demo/intlayer) are not found + if (!validatePrefix(params.locale).isValid) throw notFound() + }, + component: LocaleLayout, +}) + +function LocaleLayout() { + const params = Route.useParams() + + return ( + + + + ) +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/info.json b/packages/create/src/frameworks/solid/add-ons/intlayer/info.json new file mode 100644 index 000000000..28e39224d --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/info.json @@ -0,0 +1,28 @@ +{ + "name": "Intlayer (i18n)", + "description": "Type-safe i18n with localized routes and content declared next to your components.", + "phase": "add-on", + "modes": ["file-router"], + "type": "add-on", + "category": "i18n", + "color": "#6366F1", + "priority": 31, + "link": "https://intlayer.org/doc/environment/tanstack-start/solid", + "routes": [ + { + "icon": "Languages", + "url": "/demo/intlayer", + "name": "Intlayer i18n", + "path": "src/routes/{-$locale}/demo.intlayer.tsx", + "jsName": "IntlayerDemo" + } + ], + "integrations": [ + { + "type": "vite-plugin", + "jsName": "intlayer", + "import": "import { intlayer } from 'vite-intlayer'", + "code": "intlayer()" + } + ] +} diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/package.json b/packages/create/src/frameworks/solid/add-ons/intlayer/package.json new file mode 100644 index 000000000..e42580ce5 --- /dev/null +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/package.json @@ -0,0 +1,10 @@ +{ + "dependencies": { + "intlayer": "^9.8.0", + "solid-intlayer": "^9.8.0" + }, + "devDependencies": { + "vite-intlayer": "^9.8.0", + "@types/node": "^22.10.2" + } +} diff --git a/packages/create/tests/intlayer-addon.test.ts b/packages/create/tests/intlayer-addon.test.ts new file mode 100644 index 000000000..0fcef032c --- /dev/null +++ b/packages/create/tests/intlayer-addon.test.ts @@ -0,0 +1,102 @@ +import { afterEach, describe, expect, it, vi } from 'vitest' + +import { finalizeAddOns, populateAddOnOptionsDefaults } from '../src/add-ons.js' +import { createApp } from '../src/create-app.js' +import { createMemoryEnvironment } from '../src/environment.js' +import { createFrameworkDefinition as createReactFrameworkDefinition } from '../src/frameworks/react/index.js' +import { createFrameworkDefinition as createSolidFrameworkDefinition } from '../src/frameworks/solid/index.js' + +import type { Framework, FrameworkDefinition, Options } from '../src/types.js' + +function frameworkFromDefinition(definition: FrameworkDefinition): Framework { + const { addOns, base, ...framework } = definition + + return { + ...framework, + getFiles: () => Promise.resolve(Object.keys(base)), + getFileContents: (path: string) => Promise.resolve(base[path]), + getDeletedFiles: () => Promise.resolve([]), + getAddOns: () => addOns, + } +} + +const frameworks = { + react: { + createDefinition: createReactFrameworkDefinition, + ui: 'react-intlayer', + }, + solid: { + createDefinition: createSolidFrameworkDefinition, + ui: 'solid-intlayer', + }, +} + +afterEach(() => { + vi.unstubAllGlobals() +}) + +describe('Intlayer add-on', () => { + it.each([ + ['react', true], + ['react', false], + ['solid', true], + ['solid', false], + ] as const)( + '%s: adds the Vite plugin and localized routes (examples: %s)', + async (frameworkId, includeExamples) => { + vi.stubGlobal( + 'fetch', + vi.fn( + async () => + new Response(JSON.stringify({ version: '1.0.0' }), { status: 200 }), + ), + ) + + const framework = frameworkFromDefinition( + frameworks[frameworkId].createDefinition(), + ) + const chosenAddOns = await finalizeAddOns(framework, 'file-router', [ + 'intlayer', + ]) + const { environment, output } = createMemoryEnvironment() + + await createApp(environment, { + projectName: 'intlayer-app', + targetDir: '/intlayer-app', + framework, + mode: 'file-router', + typescript: true, + tailwind: true, + packageManager: 'pnpm', + git: false, + install: false, + intent: false, + includeExamples, + chosenAddOns, + addOnOptions: populateAddOnOptionsDefaults(chosenAddOns), + } as Options) + + const files = output.files + const viteConfig = files['/intlayer-app/vite.config.ts'] + expect(viteConfig).toContain("import { intlayer } from 'vite-intlayer'") + expect(viteConfig).toContain('intlayer()') + + const localeDir = '/intlayer-app/src/routes/{-$locale}' + expect(files[`${localeDir}/route.tsx`]).toContain(' Date: Thu, 19 Nov 2026 09:27:39 -0700 Subject: [PATCH 2/3] fix(create): declare the localized content language --- .../add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx | 4 +++- .../add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx index f3fd2e22c..2d932212e 100644 --- a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx @@ -16,7 +16,9 @@ function LocaleLayout() { return ( - +
+ +
) } diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx index fa298760b..7f7aeb877 100644 --- a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/routes/{-$locale}/route.tsx @@ -16,7 +16,9 @@ function LocaleLayout() { return ( - +
+ +
) } From ac9d76eabc5f53965ed801e9a09e91172e144d50 Mon Sep 17 00:00:00 2001 From: Tanner Linsley Date: Thu, 19 Nov 2026 09:31:56 -0700 Subject: [PATCH 3/3] fix(create): make the locale picker readable --- .../src/components/IntlayerLocaleSwitcher.tsx | 77 +++++++++---------- .../src/components/IntlayerLocaleSwitcher.tsx | 76 +++++++++--------- 2 files changed, 72 insertions(+), 81 deletions(-) diff --git a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx index 95f29101d..da08b15fe 100644 --- a/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx +++ b/packages/create/src/frameworks/react/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx @@ -4,7 +4,6 @@ import { getLocaleName, getPathWithoutLocale, getPrefix, - Locales, } from 'intlayer' import { useLocale } from 'react-intlayer' @@ -19,47 +18,45 @@ export default function IntlayerLocaleSwitcher() { return (
- -
- {availableLocales.map((localeItem) => ( - { - // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale - if ( - event.metaKey || - event.ctrlKey || - event.shiftKey || - event.altKey - ) - return - setLocale(localeItem) - }} - params={{ locale: getPrefix(localeItem).localePrefix }} - to={pathWithoutLocale as To} - replace // Will ensure that the "go back" browser button will redirect to the previous page - > - - {/* Locale - e.g. FR */} - {localeItem} - - - {/* Language in its own Locale - e.g. Français */} - {getLocaleName(localeItem, locale)} - - - {/* Language in current Locale - e.g. Francés with current locale set to Locales.SPANISH */} - {getLocaleName(localeItem)} - - - {/* Language in English - e.g. French */} - {getLocaleName(localeItem, Locales.ENGLISH)} - - - ))} +
+
    + {availableLocales.map((localeItem) => ( +
  • + { + // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale + if ( + event.metaKey || + event.ctrlKey || + event.shiftKey || + event.altKey + ) + return + setLocale(localeItem) + event.currentTarget + .closest('[popover]') + ?.hidePopover() + }} + params={{ locale: getPrefix(localeItem).localePrefix }} + to={pathWithoutLocale as To} + replace // Will ensure that the "go back" browser button will redirect to the previous page + > + + {getLocaleName(localeItem, localeItem)} + + +
  • + ))} +
) diff --git a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx index 2d30c61e8..81d09d216 100644 --- a/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx +++ b/packages/create/src/frameworks/solid/add-ons/intlayer/assets/src/components/IntlayerLocaleSwitcher.tsx @@ -4,7 +4,6 @@ import { getLocaleName, getPathWithoutLocale, getPrefix, - Locales, } from 'intlayer' import { For } from 'solid-js' import { useLocale } from 'solid-intlayer' @@ -20,48 +19,43 @@ export default function IntlayerLocaleSwitcher() { return (
- -
- - {(localeItem) => ( - { - // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale - if ( - event.metaKey || - event.ctrlKey || - event.shiftKey || - event.altKey - ) - return - setLocale(localeItem) - }} - params={{ locale: getPrefix(localeItem).localePrefix }} - to={pathWithoutLocale() as To} - replace // Will ensure that the "go back" browser button will redirect to the previous page - > - - {/* Locale - e.g. FR */} - {localeItem} - - - {/* Language in its own Locale - e.g. Français */} - {getLocaleName(localeItem, locale())} - - - {/* Language in current Locale - e.g. Francés with current locale set to Locales.SPANISH */} - {getLocaleName(localeItem)} - - - {/* Language in English - e.g. French */} - {getLocaleName(localeItem, Locales.ENGLISH)} - - - )} - +
+
    + + {(localeItem) => ( +
  • + { + // Ctrl/Cmd/Shift/Alt-click opens the link elsewhere: keep this page's locale + if ( + event.metaKey || + event.ctrlKey || + event.shiftKey || + event.altKey + ) + return + setLocale(localeItem) + event.currentTarget + .closest('[popover]') + ?.hidePopover() + }} + params={{ locale: getPrefix(localeItem).localePrefix }} + to={pathWithoutLocale() as To} + replace // Will ensure that the "go back" browser button will redirect to the previous page + > + + {getLocaleName(localeItem, localeItem)} + + +
  • + )} +
    +
)