Intlayer의 향후 출시 예정에 대한 알림을 받으세요
    생성:2025-09-09마지막 업데이트:2025-12-11

    Intlayer로 Tanstack Start 번역하기 | 국제화(i18n)

    목차

    이 가이드는 로케일 인식 라우팅, TypeScript 지원 및 최신 개발 방식을 갖춘 Tanstack Start 프로젝트에서 Intlayer를 통합하여 원활한 국제화(i18n)를 구현하는 방법을 보여줍니다.

    Intlayer란 무엇인가요?

    Intlayer는 현대 웹 애플리케이션에서 다국어 지원을 간소화하기 위해 설계된 혁신적이고 오픈 소스인 국제화(i18n) 라이브러리입니다.

    Intlayer를 사용하면 다음을 할 수 있습니다:

    • 컴포넌트 수준에서 선언적 사전을 사용하여 번역을 쉽게 관리할 수 있습니다.
    • 메타데이터, 라우트 및 콘텐츠를 동적으로 현지화할 수 있습니다.
    • 자동 생성된 타입으로 TypeScript 지원을 보장하여 자동 완성 및 오류 감지를 향상시킵니다.
    • 동적 로케일 감지 및 전환과 같은 고급 기능을 활용할 수 있습니다.
    • Tanstack Start의 파일 기반 라우팅 시스템을 사용하여 로케일 인식 라우팅 활성화.

    Tanstack Start 애플리케이션에서 Intlayer 설정 단계별 가이드

    GitHub에서 애플리케이션 템플릿을 참조하세요.

    1단계: 프로젝트 생성

    TanStack Start 웹사이트의 새 프로젝트 시작하기 가이드를 따라 새 TanStack Start 프로젝트를 생성합니다.

    2단계: Intlayer 패키지 설치

    선호하는 패키지 관리자를 사용하여 필요한 패키지를 설치합니다:

    npm install intlayer react-intlayernpm install vite-intlayer --save-dev
    • intlayer

    핵심 패키지로서 구성 관리, 번역, 콘텐츠 선언, 트랜스파일링 및 CLI 명령어를 위한 국제화 도구를 제공합니다.

    • react-intlayer
      Intlayer를 React 애플리케이션과 통합하는 패키지입니다. React 국제화를 위한 컨텍스트 프로바이더와 훅을 제공합니다.

    • vite-intlayer
      Intlayer를 Vite 번들러와 통합하기 위한 Vite 플러그인과, 사용자의 선호 로케일 감지, 쿠키 관리, URL 리디렉션 처리를 위한 미들웨어를 포함합니다.

    3단계: 프로젝트 구성

    애플리케이션의 언어를 구성하기 위한 설정 파일을 만드세요:

    intlayer.config.ts
    import type { IntlayerConfig } from "intlayer";import { Locales } from "intlayer";const config: IntlayerConfig = {  internationalization: {    defaultLocale: Locales.ENGLISH,    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],  },};export default config;
    이 설정 파일을 통해 지역화된 URL, 미들웨어 리디렉션, 쿠키 이름, 콘텐츠 선언의 위치 및 확장자, 콘솔에서 Intlayer 로그 비활성화 등 다양한 설정을 할 수 있습니다. 사용 가능한 모든 매개변수 목록은 설정 문서를 참조하세요.

    4단계: Vite 구성에 Intlayer 통합하기

    구성에 intlayer 플러그인을 추가하세요:

    vite.config.ts
    import { tanstackStart } from "@tanstack/react-start/plugin/vite";import viteReact from "@vitejs/plugin-react";import { nitro } from "nitro/vite";import { defineConfig } from "vite";import { intlayer } from "vite-intlayer";import viteTsConfigPaths from "vite-tsconfig-paths";const config = defineConfig({  plugins: [    nitro(),    viteTsConfigPaths({      projects: ["./tsconfig.json"],    }),    tanstackStart(),    viteReact(),    intlayer(), // To add  ],});export default config;
    intlayer() Vite 플러그인은 Intlayer를 Vite와 통합하는 데 사용됩니다. 이 플러그인은 콘텐츠 선언 파일을 빌드하고 개발 모드에서 이를 모니터링합니다. 또한 Vite 애플리케이션 내에서 Intlayer 환경 변수를 정의합니다. 추가로, 성능 최적화를 위한 별칭(alias)도 제공합니다.

    5단계: 레이아웃 컴포넌트 생성

    루트 레이아웃과 로케일별 레이아웃을 설정하세요:

    루트 레이아웃

    src/routes/{-$locale}/route.tsx
    import { createFileRoute, Outlet } from "@tanstack/react-router";import { IntlayerProvider, useLocale } from "react-intlayer";import { useI18nHTMLAttributes } from "@/hooks/useI18nHTMLAttributes";export const Route = createFileRoute("/{-$locale}")({  component: LayoutComponent,});function LayoutComponent() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    <IntlayerProvider locale={locale ?? defaultLocale}>      <Outlet />    </IntlayerProvider>  );}

    6단계: 콘텐츠 선언

    번역을 저장하기 위해 콘텐츠 선언을 생성하고 관리하세요:

    src/contents/page.content.ts
    import type { Dictionary } from "intlayer";import { t } from "intlayer";const appContent = {  content: {    links: {      about: t({        ko: "소개",        en: "About",        es: "Acerca de",        fr: "À propos",      }),      home: t({        ko: "홈",        en: "Home",        es: "Inicio",        fr: "Accueil",      }),    },    meta: {      description: t({        ko: "이것은 TanStack Router와 함께 Intlayer를 사용하는 예제입니다",        en: "This is an example of using Intlayer with TanStack Router",        es: "Este es un ejemplo de uso de Intlayer con TanStack Router",        fr: "Ceci est un exemple d'utilisation d'Intlayer avec TanStack Router",      }),    },    title: t({      ko: "Intlayer + TanStack Router에 오신 것을 환영합니다",      en: "Welcome to Intlayer + TanStack Router",      es: "Bienvenido a Intlayer + TanStack Router",      fr: "Bienvenue à Intlayer + TanStack Router",    }),  },  key: "app",} satisfies Dictionary;export default appContent;
    콘텐츠 선언은 애플리케이션 내 어디에서나 정의할 수 있으며, contentDir 디렉토리(기본값: ./app)에 포함되면 자동으로 인식됩니다. 또한 콘텐츠 선언 파일 확장자(기본값: .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx})와 일치해야 합니다.
    자세한 내용은 콘텐츠 선언 문서를 참조하세요.

    7단계: 로케일 인식 컴포넌트 및 훅 생성

    로케일 인식 내비게이션을 위한 LocalizedLink 컴포넌트를 생성합니다:

    src/components/localized-link.tsx
    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;// 주요 유틸리티export type RemoveLocaleParam<T> = T extends string  ? RemoveLocaleFromString<T>  : T;export type To = RemoveLocaleParam<LinkComponentProps["to"]>;type CollapseDoubleSlashes<S extends string> =  S extends `${infer H}//${infer T}` ? CollapseDoubleSlashes<`${H}/${T}`> : S;type LocalizedLinkProps = {  to?: To;} & Omit<LinkComponentProps, "to">;// 헬퍼 함수들type RemoveAll<  S extends string,  Sub extends string,> = S extends `${infer H}${Sub}${infer T}` ? RemoveAll<`${H}${T}`, Sub> : S;type RemoveLocaleFromString<S extends string> = CollapseDoubleSlashes<  RemoveAll<S, typeof LOCALE_ROUTE>>;export const LocalizedLink: FC<LocalizedLinkProps> = (props) => {  const { locale } = useLocale();  const { localePrefix } = getPrefix(locale);  return (    <Link      {...props}      params={{        locale: localePrefix,        ...(typeof props?.params === "object" ? props?.params : {}),      }}      to={`/${LOCALE_ROUTE}${props.to}` as LinkComponentProps["to"]}    />  );};

    이 컴포넌트는 두 가지 목적을 가지고 있습니다:

    • URL에서 불필요한 {-$locale} 접두사를 제거합니다.
    • URL에 locale 매개변수를 주입하여 사용자가 로컬라이즈된 경로로 직접 리디렉션되도록 보장합니다.

    그 다음, 프로그래밍 방식의 내비게이션을 위해 useLocalizedNavigate 훅을 생성할 수 있습니다:

    src/hooks/useLocalizedNavigate.tsx
    import { useNavigate } from "@tanstack/react-router";import { getPrefix } from "intlayer";import { useLocale } from "react-intlayer";import { LOCALE_ROUTE } from "@/components/localized-link";import type { FileRouteTypes } from "@/routeTree.gen";type StripLocalePrefix<T extends string> = T extends  | `/${typeof LOCALE_ROUTE}`  | `/${typeof LOCALE_ROUTE}/`  ? "/"  : T extends `/${typeof LOCALE_ROUTE}/${infer Rest}`    ? `/${Rest}`    : never;type LocalizedTo = StripLocalePrefix<FileRouteTypes["to"]>;type LocalizedNavigate = {  (to: LocalizedTo): ReturnType<ReturnType<typeof useNavigate>>;  (    opts: { to: LocalizedTo } & Record<string, unknown>  ): ReturnType<ReturnType<typeof useNavigate>>;};export const useLocalizedNavigate = () => {  const navigate = useNavigate();  const { locale } = useLocale();  const localizedNavigate: LocalizedNavigate = (args: any) => {    const { localePrefix } = getPrefix(locale);    if (typeof args === "string") {      return navigate({        to: `/${LOCALE_ROUTE}${args}`,        params: { locale: localePrefix },      });    }    const { to, ...rest } = args;    const localizedTo = `/${LOCALE_ROUTE}${to}` as any;    return navigate({      to: localizedTo,      params: { locale: localePrefix, ...rest } as any,    });  };  return localizedNavigate;};

    8단계: 페이지에서 Intlayer 사용하기

    애플리케이션 전반에서 콘텐츠 사전을 액세스하세요:

    현지화된 홈 페이지

    src/routes/{-$locale}/index.tsx
    import { createFileRoute } from "@tanstack/react-router";import { getIntlayer } from "intlayer";import { useIntlayer } from "react-intlayer";import LocaleSwitcher from "@/components/locale-switcher";import { LocalizedLink } from "@/components/localized-link";import { useLocalizedNavigate } from "@/hooks/useLocalizedNavigate";export const Route = createFileRoute("/{-$locale}/")({  component: RouteComponent,  head: ({ params }) => {    const { locale } = params;    const metaContent = getIntlayer("app", locale);    return {      meta: [        { title: metaContent.title },        { content: metaContent.meta.description, name: "description" },      ],    };  },});function RouteComponent() {  const content = useIntlayer("app");  const navigate = useLocalizedNavigate();  return (    <div>      <div>        {content.title}        <LocaleSwitcher />        <div>          <LocalizedLink to="/">{content.links.home}</LocalizedLink>          <LocalizedLink to="/about">{content.links.about}</LocalizedLink>        </div>        <div>          <button onClick={() => navigate({ to: "/" })}>            {content.links.home}          </button>          <button onClick={() => navigate({ to: "/about" })}>            {content.links.about}          </button>        </div>      </div>    </div>  );}
    useIntlayer 훅에 대해 더 알아보려면 문서를 참고하세요.

    9단계: 로케일 스위처 컴포넌트 만들기

    사용자가 언어를 변경할 수 있도록 컴포넌트를 만듭니다:

    src/components/locale-switcher.tsx
    import type { FC } from "react";import { useLocation } from "@tanstack/react-router";import {  getHTMLTextDir,  getLocaleName,  getPathWithoutLocale,  getPrefix,  Locales,} from "intlayer";import { useLocale } from "react-intlayer";import { LocalizedLink, To } from "./localized-link";export const LocaleSwitcher: FC = () => {  const { pathname } = useLocation();  const { availableLocales, locale, setLocale } = useLocale();  const pathWithoutLocale = getPathWithoutLocale(pathname);  return (    <ol>      {availableLocales.map((localeEl) => (        <li key={localeEl}>          <LocalizedLink            aria-current={localeEl === locale ? "page" : undefined}            onClick={() => setLocale(localeEl)}            params={{ locale: getPrefix(localeEl).localePrefix }}          >            <span>              {/* 로케일 - 예: FR */}              {localeEl}            </span>            <span>              {/* 해당 로케일 내 언어 - 예: Français */}              {getLocaleName(localeEl, locale)}            </span>            <span dir={getHTMLTextDir(localeEl)} lang={localeEl}>              {/* 현재 로케일 내 언어 - 예: 현재 로케일이 Locales.SPANISH일 때 Francés */}              {getLocaleName(localeEl)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* 영어로 된 언어 - 예: French */}              {getLocaleName(localeEl, Locales.ENGLISH)}            </span>          </LocalizedLink>        </li>      ))}    </ol>  );};
    useLocale 훅에 대해 더 알아보려면 문서를 참조하세요.

    10단계: HTML 속성 관리 추가 (선택 사항)

    HTML의 lang 및 dir 속성을 관리하는 훅을 만듭니다:

    src/hooks/useI18nHTMLAttributes.tsx
    // src/hooks/useI18nHTMLAttributes.tsximport { getHTMLTextDir } from "intlayer";import { useEffect } from "react";import { useLocale } from "react-intlayer";export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    document.documentElement.lang = locale;    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

    그런 다음 루트 컴포넌트에서 사용하세요:

    src/routes/{-$locale}/index.tsx
    import { createFileRoute, Outlet } from "@tanstack/react-router";import { IntlayerProvider, useLocale } from "react-intlayer";import { useI18nHTMLAttributes } from "@/hooks/useI18nHTMLAttributes"; // 훅을 임포트합니다.export const Route = createFileRoute("/{-$locale}")({  component: LayoutComponent,});function LayoutComponent() {  useI18nHTMLAttributes(); // 이 줄을 추가합니다.  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    <IntlayerProvider locale={locale ?? defaultLocale}>      <Outlet />    </IntlayerProvider>  );}

    11단계: 미들웨어 추가 (선택 사항)

    intlayerProxy를 사용하여 애플리케이션에 서버 사이드 라우팅을 추가할 수도 있습니다. 이 플러그인은 URL을 기반으로 현재 로케일을 자동으로 감지하고 적절한 로케일 쿠키를 설정합니다. 로케일이 지정되지 않은 경우, 플러그인은 사용자의 브라우저 언어 설정을 기반으로 가장 적합한 로케일을 결정합니다. 로케일이 감지되지 않으면 기본 로케일로 리디렉션합니다.

    intlayerProxy를 프로덕션 환경에서 사용하려면 vite-intlayer 패키지를 devDependencies에서 dependencies로 변경해야 한다는 점에 유의하세요.
    vite.config.ts
    import { reactRouter } from "@react-router/dev/vite";import tailwindcss from "@tailwindcss/vite";import { defineConfig } from "vite";import { intlayer, intlayerProxy } from "vite-intlayer";import tsconfigPaths from "vite-tsconfig-paths";export default defineConfig({  plugins: [    intlayerProxy(), // Nitro를 사용하는 경우 프록시는 서버 앞에 배치해야 합니다    tailwindcss(),    reactRouter(),    tsconfigPaths(),    intlayer(),  ],});

    12단계: 메타데이터 국제화 (선택 사항)

    애플리케이션 전체에서 콘텐츠 사전에 액세스하기 위해 getIntlayer 훅을 사용할 수도 있습니다:

    src/routes/{-$locale}/index.tsx
    import { createFileRoute } from "@tanstack/react-router";import { getIntlayer } from "intlayer";export const Route = createFileRoute("/{-$locale}/")({  component: RouteComponent,  head: ({ params }) => {    const { locale } = params;    const metaContent = getIntlayer("page-metadata", locale);    return {      meta: [        { title: metaContent.title },        { content: metaContent.description, name: "description" },      ],    };  },});

    Step 13: Retrieve the locale in your server actions (Optional)

    You may want to access the current locale from inside your server actions or API endpoints. You can do this using the getLocale helper from intlayer.

    Here's an example using TanStack Start's server functions:

    src/routes/{-$locale}/index.tsx
    import { createServerFn } from "@tanstack/react-start";import {  getRequestHeader,  getRequestHeaders,} from "@tanstack/react-start/server";import { getCookie, getIntlayer, getLocale } from "intlayer";export const getLocaleServer = createServerFn().handler(async () => {  const locale = await getLocale({    // Get the cookie from the request (default: 'INTLAYER_LOCALE')    getCookie: (name) => {      const cookieString = getRequestHeader("cookie");      return getCookie(name, cookieString);    },    // Get the header from the request (default: 'x-intlayer-locale')    // Fallback using Accept-Language negotiation    getHeader: (name) => getRequestHeader(name),  });  // Retrieve some content using getIntlayer()  const content = getIntlayer("app", locale);  return { locale, content };});

    14단계: 찾을 수 없는 페이지 관리 (선택 사항)

    사용자가 존재하지 않는 페이지를 방문할 때 사용자 정의 찾을 수 없음 페이지를 표시할 수 있으며, 로케일 접두사는 찾을 수 없음 페이지가 트리거되는 방식에 영향을 줄 수 있습니다.

    로케일 접두사로 TanStack Router의 404 처리 이해하기

    TanStack Router에서 현지화된 경로로 404 페이지를 처리하려면 다층 접근 방식이 필요합니다:

    1. 전용 404 경로: 404 UI를 표시하는 특정 경로
    2. 경로 수준 검증: 로케일 접두사를 검증하고 잘못된 접두사를 404로 리디렉션
    3. Catch-all 경로: 로케일 세그먼트 내에서 일치하지 않는 모든 경로를 캡처
    src/routes/{-$locale}/404.tsx
    import { createFileRoute } from "@tanstack/react-router";// 이것은 전용 /[locale]/404 경로를 생성합니다// 직접 경로로 사용되거나 다른 파일에서 컴포넌트로 가져올 수 있습니다export const Route = createFileRoute("/{-$locale}/404")({  component: NotFoundComponent,});// notFoundComponent 및 catch-all 경로에서 재사용할 수 있도록 별도로 내보냅니다export function NotFoundComponent() {  return (    <div>      <h1>404</h1>    </div>  );}
    src/routes/{-$locale}/route.tsx
    import { createFileRoute, Outlet, redirect } from "@tanstack/react-router";import { validatePrefix } from "intlayer";import { IntlayerProvider, useLocale } from "react-intlayer";import { LocaleSwitcher } from "@/components/locale-switcher";import { NotFoundComponent } from "./404";export const Route = createFileRoute("/{-$locale}")({  // beforeLoad는 경로가 렌더링되기 전에 실행됩니다 (서버와 클라이언트 모두에서)  // 로케일 접두사를 검증하기에 이상적인 장소입니다  beforeLoad: ({ params }) => {    // 경로 매개변수에서 로케일 가져오기 (서버 헤더에서 가져오지 않음, beforeLoad는 클라이언트와 서버 모두에서 실행되기 때문)    const localeParam = params.locale;    // validatePrefix는 로케일이 intlayer 구성에 따라 유효한지 확인합니다    // 반환: { isValid: boolean, localePrefix: string }    // - isValid: 접두사가 구성된 로케일과 일치하면 true (또는 접두사가 선택 사항일 때 비어 있음)    // - localePrefix: 검증된 접두사 또는 리디렉션을 위한 기본 로케일 접두사    const { isValid, localePrefix } = validatePrefix(localeParam);    if (isValid) {      // 로케일이 유효합니다. 경로가 정상적으로 렌더링되도록 허용합니다      return;    }    // 잘못된 로케일 접두사 (예: "xyz"가 유효한 로케일이 아닌 /xyz/about)    // 유효한 로케일 접두사가 있는 404 페이지로 리디렉션    // 이것은 404 페이지가 여전히 제대로 현지화되도록 보장합니다    throw redirect({      to: "/{-$locale}/404",      params: { locale: localePrefix },    });  },  component: RouteComponent,  // notFoundComponent는 자식 경로가 존재하지 않을 때 호출됩니다  // 예: /en/존재하지-않는-페이지가 /en 레이아웃 내에서 이를 트리거합니다  notFoundComponent: NotFoundLayout,});function RouteComponent() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    // 전체 로케일 세그먼트를 IntlayerProvider로 래핑    // 로케일 매개변수가 undefined일 때 defaultLocale로 폴백 (선택적 접두사 모드)    <IntlayerProvider locale={locale ?? defaultLocale}>      <Outlet />    </IntlayerProvider>  );}// NotFoundLayout는 404 컴포넌트를 IntlayerProvider로 래핑합니다// 이것은 404 페이지에서 번역이 여전히 작동하도록 보장합니다function NotFoundLayout() {  const { defaultLocale } = useLocale();  const { locale } = Route.useParams();  return (    <IntlayerProvider locale={locale ?? defaultLocale}>      <NotFoundComponent />      {/* 사용자가 404에서도 언어를 변경할 수 있도록 LocaleSwitcher 포함 */}      <LocaleSwitcher />    </IntlayerProvider>  );}
    src/routes/{-$locale}/$.tsx
    import { createFileRoute } from "@tanstack/react-router";import { NotFoundComponent } from "./404";// $ (splat/catch-all) 경로는 다른 경로와 일치하지 않는 모든 경로와 일치합니다// 예: /en/어떤/깊게/중첩된/유효하지-않은/경로// 이것은 로케일 내의 일치하지 않는 모든 경로가 404 페이지를 표시하도록 보장합니다// 이것이 없으면 일치하지 않는 깊은 경로가 빈 페이지나 오류를 표시할 수 있습니다export const Route = createFileRoute("/{-$locale}/$")({  component: NotFoundComponent,});

    15단계: TypeScript 구성 (선택 사항)

    Intlayer는 모듈 확장을 사용하여 TypeScript의 이점을 활용하고 코드베이스를 더욱 견고하게 만듭니다.

    TypeScript 구성에 자동 생성된 타입이 포함되어 있는지 확인하세요:

    tsconfig.json
    {  // ... 기존 구성  include: [    // ... 기존 포함 항목    ".intlayer/**/*.ts", // 자동 생성된 타입 포함  ],}

    Git 구성

    Intlayer가 생성한 파일은 Git 저장소에 커밋하지 않도록 무시하는 것이 권장됩니다.

    이를 위해 .gitignore 파일에 다음 지침을 추가할 수 있습니다:

    이를 위해 .gitignore 파일에 다음 지침을 추가할 수 있습니다:

    .gitignore
    # Intlayer에서 생성된 파일 무시.intlayer

    VS 코드 확장 프로그램

    Intlayer와 함께 개발 경험을 향상시키기 위해 공식 Intlayer VS 코드 확장 프로그램을 설치할 수 있습니다.

    VS 코드 마켓플레이스에서 설치하기

    이 확장 프로그램은 다음을 제공합니다:

    • 번역 키에 대한 자동 완성.
    • 누락된 번역에 대한 실시간 오류 감지.
    • 번역된 콘텐츠의 인라인 미리보기.
    • 번역을 쉽게 생성하고 업데이트할 수 있는 빠른 작업.

    확장 기능 사용 방법에 대한 자세한 내용은 Intlayer VS Code 확장 문서를 참조하세요.


    더 나아가기

    더 나아가려면 비주얼 에디터를 구현하거나 CMS를 사용하여 콘텐츠를 외부화할 수 있습니다.


    문서 참고 자료

    이 종합 가이드는 지역 인식 라우팅과 TypeScript 지원을 갖춘 완전한 국제화 애플리케이션을 위해 Intlayer를 Tanstack Start와 통합하는 데 필요한 모든 것을 제공합니다.

    Intlayer의 향후 출시 예정에 대한 알림을 받으세요