Intlayer를 사용하여 react-intl JSON 번역 자동화하는 방법

목차

Intlayer란 무엇인가요?

Intlayer는 전통적인 i18n 솔루션의 한계를 해결하기 위해 설계된 혁신적이고 오픈 소스인 국제화 라이브러리입니다. React 애플리케이션에서 콘텐츠 관리를 위한 현대적인 접근 방식을 제공합니다.

react-intl과의 구체적인 비교는 저희 블로그 게시물 react-i18next vs. react-intl vs. Intlayer에서 확인할 수 있습니다.

왜 Intlayer를 react-intl과 함께 사용해야 할까요?

Intlayer는 훌륭한 독립형 i18n 솔루션을 제공하지만(자세한 내용은 React 통합 가이드를 참조), 다음과 같은 여러 이유로 react-intl과 결합하여 사용하고자 할 수 있습니다:

1. 기존 코드베이스: 이미 구축된 react-intl 구현이 있으며 Intlayer의 향상된 개발자 경험으로 점진적으로 마이그레이션하고자 합니다.
2. 레거시 요구사항: 프로젝트가 기존 react-intl 플러그인 또는 워크플로우와의 호환성을 필요로 합니다.
3. 팀 친숙도: 팀이 react-intl에 익숙하지만 더 나은 콘텐츠 관리를 원합니다.
4. Intlayer 기능 사용: 콘텐츠 선언, 번역 자동화, 번역 테스트 등 Intlayer의 기능을 활용하고자 합니다.

이를 위해 Intlayer는 react-intl의 어댑터로 구현되어 CLI 또는 CI/CD 파이프라인에서 JSON 번역 자동화, 번역 테스트 등을 지원할 수 있습니다.

이 가이드는 react-intl과의 호환성을 유지하면서 Intlayer의 우수한 콘텐츠 선언 시스템을 활용하는 방법을 보여줍니다.

react-intl과 함께 Intlayer를 설정하는 단계별 가이드

1단계: 의존성 설치

필요한 패키지를 설치하세요:

npm install intlayer @intlayer/sync-json-plugin --save-devnpx intlayer init

패키지 설명:

• intlayer: 국제화 관리, 콘텐츠 선언 및 빌드를 위한 핵심 라이브러리
• @intlayer/sync-json-plugin: Intlayer 콘텐츠 선언을 react-intl 호환 JSON 형식으로 내보내는 플러그인

2단계: JSON을 래핑하기 위한 Intlayer 플러그인 구현

지원하는 로케일을 정의하기 위해 Intlayer 구성 파일을 만듭니다:

react-intl용 JSON 사전도 내보내고 싶다면, syncJSON 플러그인을 추가하세요:

import { Locales, type IntlayerConfig } from "intlayer";import { syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },  plugins: [    syncJSON({      format: 'i18next',      source: ({ key, locale }) => `./intl/messages/${locale}/${key}.json`,    }),  ],};`export default config;

syncJSON 플러그인은 JSON을 자동으로 래핑합니다. 콘텐츠 구조를 변경하지 않고 JSON 파일을 읽고 씁니다.

만약 JSON과 intlayer 콘텐츠 선언 파일(.content 파일)을 공존시키고 싶다면, Intlayer는 다음과 같이 처리합니다:

1. JSON과 콘텐츠 선언 파일을 모두 불러와서 intlayer 사전(dictionary)으로 변환합니다.
2. JSON과 콘텐츠 선언 파일 간에 충돌이 있을 경우, Intlayer는 모든 사전을 병합합니다. 이때 플러그인의 우선순위와 콘텐츠 선언 파일의 우선순위에 따라 처리되며, 모두 설정 가능합니다.

CLI를 사용해 JSON을 번역하거나 CMS를 통해 변경이 이루어지면, Intlayer는 새로운 번역으로 JSON 파일을 업데이트합니다.

syncJSON 플러그인에 대한 자세한 내용을 보려면 syncJSON 플러그인 문서를 참조하세요.

(선택 사항) 3단계: 컴포넌트별 JSON 번역 구현

기본적으로 Intlayer는 JSON 파일과 콘텐츠 선언 파일을 모두 로드, 병합 및 동기화합니다. 자세한 내용은 콘텐츠 선언 문서를 참조하세요. 하지만 원한다면 Intlayer 플러그인을 사용하여 코드베이스 어디에서나 지역화된 JSON을 컴포넌트별로 관리할 수도 있습니다.

이를 위해 loadJSON 플러그인을 사용할 수 있습니다.

import { Locales, type IntlayerConfig } from "intlayer";import { loadJSON, syncJSON } from "@intlayer/sync-json-plugin";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },  // 현재 JSON 파일을 Intlayer 사전과 동기화 상태로 유지합니다  plugins: [    /**     * src 내에서 {key}.i18n.json 패턴과 일치하는 모든 JSON 파일을 로드합니다     */    loadJSON({      source: ({ key }) => `./src/**/${key}.i18n.json`,      locale: Locales.ENGLISH,      priority: 1, // 이 JSON 파일들이 `./locales/en/${key}.json` 파일보다 우선하도록 보장합니다    }),    /**     * locales 디렉토리 내 JSON 파일에 출력 및 번역을 다시 기록하며 로드합니다     */    syncJSON({      format: "icu",      source: ({ key, locale }) => `./messages/${locale}/${key}.json`,      priority: 0,    }),  ],};export default config;

이 설정은 src 디렉토리 내에서 {key}.i18n.json 패턴과 일치하는 모든 JSON 파일을 로드하여 Intlayer 사전으로 불러옵니다.

Git 설정

자동 생성되는 Intlayer 파일은 무시하는 것이 권장됩니다:

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

이 파일들은 빌드 과정에서 다시 생성될 수 있으므로 버전 관리에 커밋할 필요가 없습니다.

VS Code 확장 프로그램

개발자 경험 향상을 위해 공식 Intlayer VS Code 확장 프로그램을 설치하세요:

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