Intlayer 구성 문서

import { Locales, type IntlayerConfig } from "intlayer";import { nextjsRewrite } from "intlayer/routing";import { z } from "zod";/** * 사용 가능한 모든 옵션을 보여주는 Intlayer 구성 파일 예시입니다. */const config: IntlayerConfig = {  /**   * 국제화 설정 구성.   */  internationalization: {    /**     * 애플리케이션에서 지원하는 로케일 목록.     * 기본값: [Locales.ENGLISH]     */    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    /**     * 각 딕셔너리에 정의되어야 하는 필수 로케일 목록.     * 비어 있는 경우 `strict` 모드에서는 모든 로케일이 필수입니다.     * 기본값: []     */    requiredLocales: [Locales.ENGLISH],    /**     * 국제화된 콘텐츠의 엄격도 수준.     * - "strict": 선언된 로케일이 누락되거나 선언되지 않은 로케일이 사용된 경우 오류.     * - "inclusive": 선언된 로케일이 누락된 경우 경고.     * - "loose": 존재하는 모든 로케일을 수용.     * 기본값: "inclusive"     */    strictMode: "inclusive",    /**     * 요청된 로케일을 찾을 수 없을 때 폴백으로 사용되는 기본 로케일.     * 기본값: Locales.ENGLISH     */    defaultLocale: Locales.ENGLISH,  },  /**   * 딕셔너리 작업 및 폴백 동작을 제어하는 설정.   */  dictionary: {    /**     * 딕셔너리 임포트 방법을 제어합니다.     * - "static": 빌드 시 정적으로 임포트됩니다.     * - "dynamic": Suspense를 사용하여 동적으로 임포트됩니다.     * - "fetch": Live Sync API를 통해 동적으로 가져옵니다.     * 기본값: "static"     */    importMode: "static",    /**     * AI를 사용하여 누락된 번역을 자동으로 채우는 전략.     * 불리언 값이거나 채워진 콘텐츠를 저장할 경로 패턴일 수 있습니다.     * 기본값: true     */    fill: true,    /**     * 딕셔너리 파일의 물리적 위치.     * - "local": 로컬 파일 시스템에 저장됩니다.     * - "remote": Intlayer CMS에 저장됩니다.     * - "hybrid": 로컬 및 Intlayer CMS 모두에 저장됩니다.     * - "plugin" (또는 임의의 문자열): 플러그인이나 사용자 정의 소스에서 제공됩니다.     * 기본값: "local"     */    location: "local",    /**     * 콘텐츠를 자동으로 변환할지 여부(예: Markdown을 HTML로).     * 기본값: false     */    contentAutoTransformation: false,  },  /**   * 라우팅 및 미들웨어 구성.   */  routing: {    /**     * 로케일 라우팅 전략.     * - "prefix-no-default": 기본 언어를 제외한 모든 언어에 접두사 사용(예: /dashboard, /fr/dashboard).     * - "prefix-all": 모든 언어에 접두사 사용(예: /en/dashboard, /fr/dashboard).     * - "no-prefix": URL에 로케일을 표시하지 않음.     * - "search-params": ?locale=... 사용     * 기본값: "prefix-no-default"     */    mode: "prefix-no-default",    /**     * 사용자가 선택한 로케일 저장 위치.     * 옵션: 'cookie', 'localStorage', 'sessionStorage', 'header' 또는 이들의 배열.     * 기본값: ['cookie', 'header']     */    storage: ["cookie", "header"],    /**     * 애플리케이션 URL의 기본 경로.     * 기본값: ""     */    basePath: "",    /**     * 특정 로케일 경로에 대한 사용자 정의 URL 재작성 규칙.     */    rewrite: nextjsRewrite({      "/[locale]/about": {        en: "/[locale]/about",        fr: "/[locale]/a-propos",      },    }),    /**     * 도메인 기반 라우팅을 위해 로케일을 도메인 호스트 이름에 매핑합니다.     * 이 로케일의 URL은 절대 URL이 됩니다(예: https://intlayer.cn/).     * 도메인이 로케일을 의미하므로 경로에 로케일 접두사가 추가되지 않습니다.     * 기본값: undefined     */    domains: {      en: "intlayer.org",      zh: "intlayer.cn",    },  },  /**   * 콘텐츠 파일을 찾고 처리하기 위한 설정.   */  content: {    /**     * 딕셔너리 스캔을 위한 파일 확장자.     * 기본값: ['.content.ts', '.content.js', '.content.json' 등]     */    fileExtensions: [".content.ts", ".content.js", ".content.json"],    /**     * .content 파일이 위치한 디렉토리.     * 기본값: ["."]     */    contentDir: ["src"],    /**     * 소스 코드가 위치한 디렉토리.     * 빌드 최적화 및 코드 변환에 사용됩니다.     * 기본값: ["."]     */    codeDir: ["src"],    /**     * 스캔에서 제외할 패턴.     * 기본값: ['node_modules', '.intlayer' 등]     */    excludedPath: ["node_modules"],    /**     * 개발 중 변경 사항을 감시하고 딕셔너리를 재생성할지 여부.     * 기본값: 개발 모드에서 true     */    watch: true,    /**     * 새로 생성/업데이트된 .content 파일을 포맷팅하는 명령.     */    formatCommand: 'npx prettier --write "{{file}}"',  },  /**   * 비주얼 에디터 구성.   */  editor: {    /**     * 비주얼 에디터 활성화 여부.     * 기본값: false     */    enabled: true,    /**     * 오리진 검증을 위한 애플리케이션 URL.     * 기본값: ""     */    applicationURL: "http://localhost:3000",    /**     * 로컬 에디터 서버 포트.     * 기본값: 8000     */    port: 8000,    /**     * 에디터 공개 URL.     * 기본값: "http://localhost:8000"     */    editorURL: "http://localhost:8000",    /**     * Intlayer CMS URL.     * 기본값: "https://app.intlayer.org"     */    cmsURL: "https://app.intlayer.org",    /**     * 백엔드 API 서버 URL.     * 기본값: "https://back.intlayer.org"     */    backendURL: "https://back.intlayer.org",    /**     * 실시간 콘텐츠 동기화 활성화 여부.     * 기본값: false     */    liveSync: true,  },  /**   * AI 기반 번역 및 생성 설정.   */  ai: {    /**     * 사용할 AI 프로바이더.     * 옵션: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio'     * 기본값: 'openai'     */    provider: "openai",    /**     * 선택한 프로바이더에 사용할 모델.     */    model: "gpt-4o",    /**     * 프로바이더의 API 키.     */    apiKey: process.env.OPENAI_API_KEY,    /**     * AI의 번역 생성을 돕기 위한 글로벌 컨텍스트.     */    applicationContext: "이것은 여행 예약 애플리케이션입니다.",    /**     * AI API의 기본 URL.     */    baseURL: "http://localhost:3000",    /**     * 데이터 직렬화 (Data Serialization)     *     * 옵션:     * - "json": 기본값, 안정적임; 더 많은 토큰 소비.     * - "toon": 더 빠르고 토큰 소모가 적지만 JSON보다 일관성이 낮음.     *     * 기본값: "json"     */    dataSerialization: "json",  },  /**   * 빌드 및 최적화 설정.   */  build: {    /**     * 빌드 실행 모드.     * - "auto": 애플리케이션 빌드 중 자동 빌드.     * - "manual": 명시적인 빌드 명령 필요.     * 기본값: "auto"     */    mode: "auto",    /**     * 사용되지 않는 딕셔너리를 제거하여 최종 번들을 최적화할지 여부.     * 기본값: 프로덕션 환경에서 true     */    optimize: true,    /**     * 번들 크기를 줄이기 위해 딕셔너리를 압축(Minify)합니다.     * 기본값: false     *     * 주의:     * - `optimize`가 비활성화된 경우 이 옵션은 무시됩니다.     * - `editor.enabled`가 true인 경우 이 옵션은 무시됩니다.     */    minify: true,    /**     * 딕셔너리에서 사용하지 않는 키를 제거합니다.     * 기본값: false     *     * 주의:     * - `optimize`가 비활성화된 경우 이 옵션은 무시됩니다.     */    purge: true,    /**     * 생성된 딕셔너리 파일의 출력 형식.     * 기본값: ['cjs', 'esm']     */    outputFormat: ["cjs", "esm"],    /**     * 빌드 중에 TypeScript 타입 체크를 수행할지 여부.     * 기본값: false     */    checkTypes: false,  },  /**   * 로거 구성.   */  log: {    /**     * 로깅 모드.     * - "default": 표준 로깅.     * - "verbose": 디버깅을 위한 상세 로깅.     * - "disabled": 로깅 비활성화.     * 기본값: "default"     */    mode: "default",    /**     * 모든 로그 메시지의 접두사.     * 기본값: "[intlayer]"     */    prefix: "[intlayer]",  },  /**   * 시스템 구성 (고급 용도)   */  system: {    /**     * 로컬라이즈된 딕셔너리가 저장되는 디렉토리.     */    dictionariesDir: ".intlayer/dictionary",    /**     * 모듈 보강(module augmentation) 디렉토리.     */    moduleAugmentationDir: ".intlayer/types",    /**     * 병합되지 않은 딕셔너리 저장 디렉토리.     */    unmergedDictionariesDir: ".intlayer/unmerged_dictionary",    /**     * 딕셔너리 타입 디렉토리.     */    typesDir: ".intlayer/types",    /**     * 주 애플리케이션 파일 위치.     */    mainDir: ".intlayer/main",    /**     * 컴파일된 구성 파일 디렉토리.     */    configDir: ".intlayer/config",    /**     * 캐시 파일 디렉토리.     */    cacheDir: ".intlayer/cache",  },  /**   * 컴파일러 구성 (고급 용도)   */  compiler: {    /**     * 컴파일러 활성화 여부.     *     * - false: 컴파일러 비활성화.     * - true: 컴파일러 활성화.     * - "build-only": 빠른 시작을 위해 개발 단계에서는 컴파일러 건너뜀.     *     * 기본값: false     */    enabled: true,    /**     * 출력 파일의 경로를 정의합니다. `outputDir`을 대체합니다.     *     * - `./` 경로는 컴포넌트 디렉토리를 기준으로 해석됩니다.     * - `/` 경로는 프로젝트 루트(`baseDir`)를 기준으로 해석됩니다.     *     * - 경로에 `{{locale}}` 변수가 포함되어 있으면 언어별로 별도의 딕셔너리 생성을 트리거합니다.     *     * 예시:     * ```ts     * {     *   // 컴포넌트 근처에 다국어 .content.ts 파일 생성     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,     *     *   // output: './{{fileName}}{{extension}}', // 템플릿 문자열을 사용한 동일한 동작     * }     * ```     *     * ```ts     * {     *   // 프로젝트 루트의 로케일별 폴더에 JSON 파일 생성     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,     *     *   // output: '/locales/{{locale}}/{{key}}.content.json', // 템플릿 문자열을 사용한 동일한 동작     * }     * ```     *     * 변수 목록:     *   - `fileName`: 파일 이름.     *   - `key`: 콘텐츠 키.     *   - `locale`: 콘텐츠 로케일.     *   - `extension`: 파일 확장자.     *   - `componentFileName`: 컴포넌트 파일 이름.     *   - `componentExtension`: 컴포넌트 파일 확장자.     *   - `format`: 딕셔너리 형식.     *   - `componentFormat`: 컴포넌트 딕셔너리 형식.     *   - `componentDirPath`: 컴포넌트 디렉토리 경로.     */    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,    /**     * 변환 후 컴포넌트를 저장할지 여부.     * 이렇게 하면 컴파일러를 한 번 실행하여 앱을 변환한 다음 나중에 제거할 수 있습니다.     */    saveComponents: false,    /**     * 생성된 파일에 콘텐츠만 유지할지 여부. 로케일별 i18next 또는 ICU MessageFormat JSON 출력에 유용합니다.     */    noMetadata: false,    /**     * 딕셔너리 키 접두사     */    dictionaryKeyPrefix: "", // 추출된 딕셔너리 키에 선택적 접두사 추가  },  /**   * 딕셔너리 콘텐츠 검증을 위한 사용자 정의 스키마.   */  schemas: {    "my-schema": z.object({      title: z.string(),    }),  },  /**   * 플러그인 구성.   */  plugins: [],};export default config;

routing: {  mode: "prefix-no-default", // 폴백 전략  rewrite: nextjsRewrite({    "/about": {      en: "/about",      fr: "/a-propos",    },    "/product/[slug]": {      en: "/product/[slug]",      fr: "/produit/[slug]",    },    "/blog/[category]/[id]": {      en: "/blog/[category]/[id]",      fr: "/journal/[category]/[id]",    },  }),}

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default",    storage: [      {        type: "localStorage",        name: "user-locale",      },      {        type: "cookie",        name: "user-locale",        secure: true,        sameSite: "strict",        httpOnly: false,      },    ],    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "search-params",    storage: "localStorage",    basePath: "",  },};export default config;

import { Locales, type IntlayerConfig } from "intlayer";// intlayer.config.tsconst config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr", "es"],    defaultLocale: "en",  },  routing: {    mode: "no-prefix",    storage: {      type: "sessionStorage",      name: "app-locale",    },    basePath: "/my-app",  },};export default config;

// intlayer.config.tsimport { nextjsRewrite } from "intlayer/routing";const config: IntlayerConfig = {  internationalization: {    locales: ["en", "fr"],    defaultLocale: "en",  },  routing: {    mode: "prefix-no-default", // 재작성되지 않은 경로에 대한 폴백    storage: "cookie",    rewrite: nextjsRewrite({      "/about": {        en: "/about",        fr: "/a-propos",      },      "/product/[slug]": {        en: "/product/[slug]",        fr: "/produit/[slug]",      },      "/blog/[category]/[id]": {        en: "/blog/[category]/[id]",        fr: "/journal/[category]/[id]",      },    }),  },};export default config;

dictionary: {  fill: {    en: "/locales/en/{{key}}.content.json",    fr: ({ key }) => `/locales/fr/${key}.content.json`,    es: false,  },};