Intlayer를 사용하여 Astro + Lit 사이트 번역하기 | 국제화 (i18n)

목차

대안보다 Intlayer를 선택해야 하는 이유는 무엇입니까?

'astro-i18n' 또는 'i18next'와 같은 주요 솔루션과 비교할 때 Intlayer는 다음과 같은 통합 최적화가 제공되는 솔루션입니다.

Astro + Lit에서 Intlayer 설정을 위한 단계별 가이드

GitHub에서 애플리케이션 템플릿 보기.

1. 1

   종속성 설치

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

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npm install intlayer astro-intlayer lit lit-intlayer @astrojs/lit
   
   npx intlayer init
   

   alt, title, href, aria-label 등과 같은 문자열 속성에서 콘텐츠를 사용하려면 다음과 같이 함수의 값을 사용할 수 있습니다.

   tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   <img src={content.image.src.value} alt={content.image.value} />
   <img src={content.image.src.toString()} alt={content.image.toString()} />
   <img src={String(content.image.src)} alt={String(content.image)} />
   

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npm install intlayer astro-intlayer lit lit-intlayer @astrojs/lit
   

   • intlayer 설정 관리, 번역, 콘텐츠 선언, 트랜스파일 및 CLI 명령어를 위한 국제화 도구를 제공하는 핵심 패키지입니다.

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

   • lit 빠르고 가벼운 웹 컴포넌트를 빌드하기 위한 핵심 Lit 패키지입니다.

   • lit-intlayer Intlayer를 Lit 애플리케이션과 통합하는 패키지입니다. 언어 변경 시 LitElement를 자동으로 다시 렌더링하기 위해 ReactiveController 기반 훅(useIntlayer, useLocale 등)을 제공합니다.

   • @astrojs/lit Astro 페이지에서 Lit 커스텀 엘리먼트를 사용할 수 있게 해주는 공식 Astro 통합 도구입니다.

2. 2

   프로젝트 설정

   애플리케이션의 언어를 설정하기 위한 설정 파일을 생성합니다:

   intlayer.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { Locales, type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [
         Locales.ENGLISH,
         Locales.FRENCH,
         Locales.SPANISH,
         // 기타 로케일
       ],
       defaultLocale: Locales.ENGLISH,
     },
   };
   
   export default config;
   

   이 설정 파일을 통해 로컬라이즈된 URL, 미들웨어 리디렉션, 쿠키 이름, 콘텐츠 선언 위치 및 확장자 설정, 콘솔의 Intlayer 로그 비활성화 등을 구성할 수 있습니다. 사용 가능한 파라미터의 전체 목록은 설정 문서를 참조하세요.

3. 3

   Astro 설정에 Intlayer 통합

   Astro 설정에 intlayer 플러그인과 Lit 통합을 추가합니다.

   astro.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   // @ts-check
   
   import { intlayer } from "astro-intlayer";
   import lit from "@astrojs/lit";
   import { defineConfig } from "astro/config";
   
   // https://astro.build/config
   export default defineConfig({
     integrations: [intlayer(), lit()],
   });
   

   intlayer() 통합 플러그인은 Intlayer를 Astro와 통합하는 데 사용됩니다. 콘텐츠 선언 파일의 빌드를 보장하고 개발 모드에서 이를 감시합니다. Astro 애플리케이션 내에서 Intlayer 환경 변수를 정의하며, 성능 최적화를 위한 에일리어스(alias)를 제공합니다.

   lit() 통합은 Astro 페이지 내에서 Lit 커스텀 엘리먼트를 사용할 수 있게 합니다.

4. 4

   콘텐츠 선언

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

   src/components/lit/app.content.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { t, type Dictionary } from "intlayer";
   
   const litDemoContent = {
     key: "lit-demo",
     content: {
       greeting: t({
         en: "Hello World",
         fr: "Bonjour le monde",
         es: "Hola mundo",
         ko: "안녕하세요",
       }),
       description: t({
         en: "Welcome to my multilingual Astro + Lit site.",
         fr: "Bienvenue sur mon site Astro + Lit multilingue.",
         es: "Bienvenido a mi sitio Astro + Lit multilingüe.",
         ko: "다국어 Astro + Lit 사이트에 오신 것을 환영합니다.",
       }),
     },
   } satisfies Dictionary;
   
   export default litDemoContent;
   

   콘텐츠 선언은 contentDir(기본값 ./src)에 포함되어 있고 콘텐츠 선언 파일 확장자(기본값 .content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})와 일치한다면 애플리케이션 어디에서나 정의할 수 있습니다.

   자세한 내용은 콘텐츠 선언 문서를 참조하세요.

5. 5

   Astro에서 콘텐츠 사용

   intlayer에서 내보낸 핵심 헬퍼를 사용하여 .astro 파일에서 직접 사전을 소비할 수 있습니다. 또한 각 페이지에 hreflang 및 canonical 링크와 같은 SEO 메타데이터를 추가해야 합니다. Lit 커스텀 엘리먼트는 클라이언트 사이드 <script>를 통해 임포트되어 body에 배치됩니다.

   src/pages/[...locale]/index.astro

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   ---
   import {
     getIntlayer,
     getLocaleFromPath,
     getLocalizedUrl,
     getHTMLTextDir,
     getPrefix,
     localeMap,
     defaultLocale,
     type LocalesValues,
   } from "intlayer";
   
   export const getStaticPaths = () => {
     return localeMap(({ locale }) => ({
       params: { locale: getPrefix(locale).localePrefix },
     }));
   };
   
   const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;
   const { greeting } = getIntlayer("lit-demo", locale);
   ---
   
   <!doctype html>
   <html lang={locale} dir={getHTMLTextDir(locale)}>
     <head>
       <meta charset="utf-8" />
       <meta name="viewport" content="width=device-width" />
       <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
       <title>{greeting}</title>
   
       <!-- Canonical 링크 -->
       <link
         rel="canonical"
         href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)}
       />
   
       <!-- Hreflang 링크 -->
       {
         localeMap(({ locale: mapLocale }) => (
           <link
             rel="alternate"
             hreflang={mapLocale}
             href={new URL(
               getLocalizedUrl(Astro.url.pathname, mapLocale),
               Astro.site
             )}
           />
         ))
       }
   
       <link
         rel="alternate"
         hreflang="x-default"
         href={new URL(
           getLocalizedUrl(Astro.url.pathname, defaultLocale),
           Astro.site
         )}
       />
     </head>
     <body>
       <!-- Lit 커스텀 엘리먼트 - 서버에서 감지된 로케일을 프로퍼티로 받습니다 -->
       <lit-demo locale={locale}></lit-demo>
     </body>
   </html>
   
   <script>
     import "../../components/lit/LitDemo";
   </script>
   

   string 속성(예: alt, title, href, aria-label 등)에서 콘텐츠를 사용하려면 함수의 값을 다음과 같이 사용할 수 있습니다:

   tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   <img src={content.image.src.value} alt={content.image.value} />
   <img src={content.image.src.toString()} alt={content.image.toString()} />
   <img src={String(content.image.src)} alt={String(content.image)} />
   

   라우팅 설정에 관한 참고 사항: 사용하는 디렉토리 구조는 intlayer.config.ts의 middleware.routing 설정에 따라 달라집니다:

   • prefix-no-default (기본값): 루트(프레픽스 없음)에 기본 언어를 유지하고 나머지에 프레픽스를 붙입니다. 모든 케이스를 처리하려면 [...locale]을 사용하세요.
   • prefix-all: 모든 URL에 언어 프레픽스가 붙습니다. 루트를 분리해서 처리할 필요가 없다면 표준 [locale]을 사용할 수 있습니다.
   • search-param 또는 no-prefix: 로케일 폴더가 필요 없습니다. 로케일은 검색 파라미터나 쿠키를 통해 처리됩니다.

6. 6

   Lit 커스텀 엘리먼트 생성

   Lit 커스텀 엘리먼트를 생성합니다. 클라이언트에서 Intlayer 싱글톤을 초기화하기 위해 서버에서 감지된 locale 프로퍼티를 사용하여 connectedCallback에서 installIntlayer를 호출합니다.

   src/components/lit/LitDemo.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { LitElement, html } from "lit";
   import { installIntlayer, useIntlayer, useLocale } from "lit-intlayer";
   import { getLocalizedUrl, getLocaleName, type LocalesValues } from "intlayer";
   
   class LitDemo extends LitElement {
     static properties = {
       locale: { type: String },
     };
   
     locale: LocalesValues = "en" as LocalesValues;
   
     private _content = useIntlayer(this, "lit-demo");
     private _localeCtrl = useLocale(this, {
       onLocaleChange: (newLocale: LocalesValues) => {
         window.location.href = getLocalizedUrl(
           window.location.pathname,
           newLocale
         );
       },
     });
   
     override connectedCallback() {
       super.connectedCallback();
       // 서버에서 감지된 로케일로 초기화
       installIntlayer({ locale: this.locale as any });
     }
   
     override render() {
       const { greeting, description } = this._content;
       const {
         locale: currentLocale,
         availableLocales,
         setLocale,
       } = this._localeCtrl;
   
       return html`
         <div>
           <h1>${greeting}</h1>
           <p>${description}</p>
           <!-- 언어 전환기는 LitElement 내에 렌더링됩니다 -->
           <div class="locale-switcher">
             <span class="switcher-label">언어 전환:</span>
             <div class="locale-buttons">
               ${availableLocales.map(
                 (localeItem) => html`
                   <button
                     class="locale-btn ${
                       localeItem === currentLocale ? "active" : ""
                     }"
                     ?disabled=${localeItem === currentLocale}
                     @click=${() => setLocale(localeItem)}
                   >
                     <span class="ls-own-name">${getLocaleName(localeItem)}</span>
                     <span class="ls-current-name"
                       >${getLocaleName(localeItem, currentLocale)}</span
                     >
                     <span class="ls-code">${localeItem.toUpperCase()}</span>
                   </button>
                 `
               )}
             </div>
           </div>
         </div>
       `;
     }
   }
   
   customElements.define("lit-demo", LitDemo);
   

   locale 프롭은 Astro 페이지(서버 감지)에서 전달되어 connectedCallback에서 installIntlayer를 초기화하는 데 사용되며, 이로 인해 엘리먼트 내 모든 ReactiveController 훅의 초기 로케일이 결정됩니다.

   useIntlayer는 ReactiveController로 등록됩니다. 언어가 변경되면 엘리먼트가 자동으로 다시 렌더링되므로 추가 설정이 필요 없습니다.

7. 7

   언어 전환기 추가

   언어 전환 기능은 Lit 커스텀 엘리먼트의 render() 메서드(6단계 참조)에 직접 통합되어 있습니다. lit-intlayer의 useLocale을 사용하며, 사용자가 새 언어를 선택할 때 로컬라이즈된 URL로 이동합니다:

   src/components/lit/LitDemo.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   // LitElement 클래스 내에서 useLocale 설정(6단계 항목) 이후:
   
   private _localeCtrl = useLocale(this, {
     onLocaleChange: (newLocale: LocalesValues) => {
       // 언어 변경 시 로컬라이즈된 URL로 이동
       window.location.href = getLocalizedUrl(window.location.pathname, newLocale);
     },
   });
   
   override render() {
     const { locale: currentLocale, availableLocales, setLocale } = this._localeCtrl;
   
     return html`
       <div class="locale-switcher">
         <span class="switcher-label">언어 전환:</span>
         <div class="locale-buttons">
           ${availableLocales.map(
             (localeItem) => html`
               <button
                 class="locale-btn ${localeItem === currentLocale ? "active" : ""}"
                 ?disabled=${localeItem === currentLocale}
                 @click=${() => setLocale(localeItem)}
               >
                 <span class="ls-own-name">${getLocaleName(localeItem)}</span>
                 <span class="ls-current-name">${getLocaleName(localeItem, currentLocale)}</span>
                 <span class="ls-code">${localeItem.toUpperCase()}</span>
               </button>
             `
           )}
         </div>
       </div>
     `;
   }
   

   Lit 반응성에 관한 참고 사항: useLocale은 ReactiveController를 반환합니다. setLocale이 호출되면 컨트롤러가 자동으로 다시 렌더링을 예약하므로 별도의 DOM 조작 없이도 활성 버튼 상태가 업데이트됩니다.

   영속성에 관한 참고 사항: window.location.href를 통한 리디렉션을 위해 onLocaleChange를 사용하면 새 언어 URL이 확실히 방문되도록 보장합니다. 이를 통해 Intlayer 미들웨어가 언어 쿠키를 설정하고 향후 방문 시 사용자의 선호도를 기억할 수 있습니다.

8. 8

   Sitemap 및 Robots.txt

   Intlayer는 동적으로 로컬라이즈된 사이트맵과 robots.txt 파일을 생성하기 위한 유틸리티를 제공합니다.

   사이트맵

   Intlayer는 애플리케이션의 사이트맵을 쉽게 만들 수 있는 내장 사이트맵 생성기를 제공합니다. 로컬라이즈된 경로를 처리하고 검색 엔진에 필요한 메타데이터를 추가합니다.

   Intlayer에서 생성한 사이트맵은 xhtml:link 네임스페이스(Hreflang XML 확장)를 지원합니다. 원시 URL만 나열하는 기본 사이트맵 생성기와 달리, Intlayer는 페이지의 모든 언어 버전(예: /about, /about?lang=fr, /about?lang=es) 간에 필요한 양항향 링크를 자동으로 생성합니다. 이를 통해 검색 엔진이 올바른 언어 버전을 올바른 사용자에게 색인화하고 제공할 수 있도록 보장합니다.

   모든 로컬라이즈된 경로를 포함하는 사이트맵을 생성하기 위해 src/pages/sitemap.xml.ts를 생성합니다.

   src/pages/sitemap.xml.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { APIRoute } from "astro";
   import { generateSitemap, type SitemapUrlEntry } from "intlayer";
   
   const pathList: SitemapUrlEntry[] = [
     { path: "/", changefreq: "daily", priority: 1.0 },
     { path: "/about", changefreq: "monthly", priority: 0.7 },
   ];
   
   const SITE_URL = import.meta.env.SITE ?? "http://localhost:4321";
   
   export const GET: APIRoute = async ({ site }) => {
     const xmlOutput = generateSitemap(pathList, { siteUrl: SITE_URL });
   
     return new Response(xmlOutput, {
       headers: { "Content-Type": "application/xml" },
     });
   };
   

   Robots.txt

   검색 엔진 크롤링을 제어하기 위해 src/pages/robots.txt.ts를 생성합니다.

   src/pages/robots.txt.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { APIRoute } from "astro";
   import { getMultilingualUrls } from "intlayer";
   
   const getAllMultilingualUrls = (urls: string[]) =>
     urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);
   
   const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);
   
   export const GET: APIRoute = ({ site }) => {
     const robotsTxt = [
       "User-agent: *",
       "Allow: /",
       ...disallowedPaths.map((path) => `Disallow: ${path}`),
       "",
       `Sitemap: ${new URL("/sitemap.xml", site).href}`,
     ].join("\n");
   
     return new Response(robotsTxt, {
       headers: { "Content-Type": "text/plain" },
     });
   };
   

9. 15

   컴포넌트에서 콘텐츠 추출

   선택사항

   기존 codebase가 있다면, 수천 개의 파일을 변환하는 것은 시간이 많이 걸릴 수 있습니다.

   이 프로세스를 쉽게 하기 위해, Intlayer는 컴포넌트를 변환하고 콘텐츠를 추출하기 위한 compiler / extractor를 제안합니다.

   이를 설정하려면 intlayer.config.ts 파일에 compiler 섹션을 추가할 수 있습니다:

   intlayer.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     // ... Rest of your config
     compiler: {
       /**
        * 컴파일러를 활성화해야 하는지 여부를 나타냅니다.
        */
       enabled: true,
   
       /**
        * 출력 파일 경로를 정의합니다.
        */
       output: ({ fileName, extension }) => `./${fileName}${extension}`,
   
       /**
        * 컴포넌트를 변환한 후 저장해야 하는지 여부를 나타냅니다.
        *
        * - `true`인 경우, 컴파일러가 디스크의 컴포넌트 파일을 다시 작성합니다. 따라서 변환이 영구적이며, 컴파일러는 다음 프로세스에서 변환을 건너뜁니다. 이러한 방식으로 컴파일러는 앱을 변환한 다음 제거할 수 있습니다.
        *
        * - `false`인 경우, 컴파일러는 `useIntlayer()` 함수 호출을 빌드 출력의 코드에만 주입하고 기본 codebase를 유지합니다. 변환은 메모리에서만 수행됩니다.
        */
       saveComponents: false,
   
       /**
        * 사전 키 접두사
        */
       dictionaryKeyPrefix: "",
     },
   };
   
   export default config;
   

   Extract commandBabel compiler

   extractor를 실행하여 컴포넌트를 변환하고 콘텐츠를 추출합니다

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npx intlayer extract
   

   v9부터 intlayerCompiler는 intlayer plugin에 포함되어 있습니다. 따라서 수동으로 추가할 필요가 없습니다.

   vite.config.ts를 업데이트하여 intlayerCompiler 플러그인을 포함합니다:

   vite.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { defineConfig } from "vite";
   import { intlayer, intlayerCompiler } from "vite-intlayer";
   
   export default defineConfig({
     plugins: [
       intlayer(),
       intlayerCompiler(), // 컴파일러 플러그인 추가
     ],
   });
   

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npm run build # 또는 npm run dev
   

TypeScript 설정

Intlayer는 모듈 증강(module augmentation)을 사용하여 TypeScript의 이점을 활용함으로써 코드베이스를 더 견고하게 만듭니다. 데코레이터 구문을 사용하는 경우 Lit에서 experimentalDecorators를 활성화해야 합니다.

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

{
  compilerOptions: {
    // ...
    experimentalDecorators: true,
    useDefineForClassFields: false, // 데코레이터 지원을 위해 Lit에서 필수
  },
  include: [
    // ... 기존 TypeScript 설정
    ".intlayer/**/*.ts", // 자동 생성된 타입 포함
  ],
}

Git 설정

Intlayer가 생성한 파일은 무시하는 것이 좋습니다. 이를 통해 Git 리포지토리에 커밋되는 것을 방지할 수 있습니다.

무시하려면 .gitignore 파일에 다음 지침을 추가하세요:

# Intlayer가 생성한 파일 무시
.intlayer

VS Code 확장 프로그램

Intlayer 개발 환경을 개선하기 위해 공식 Intlayer VS Code 확장 프로그램을 설치할 수 있습니다.

VS Code Marketplace에서 설치

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

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

확장 프로그램 사용에 대한 자세한 내용은 Intlayer VS Code 확장 프로그램 문서를 참조하세요.

더 알아보기

더 자세히 알고 싶다면 비주얼 에디터를 구현하거나 CMS를 사용하여 콘텐츠를 외부화할 수 있습니다.

자주 묻는 질문