Intlayer 設定ドキュメント

import { Locales, type IntlayerConfig } from "intlayer";
import { nextjsRewrite } from "intlayer/routing";
import { syncJSON } from "@intlayer/sync-json-plugin";
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",

    /**
     * Intlayer のロケールルーティングプロキシ（ミドルウェア）を有効にします。
     * dev、preview、SSR でのロケール検出・リダイレクト・リライトを担います。
     * - 未設定 (auto): dev および preview サーバーは Cookie やヘッダーに保存された
     *   ロケールを無視し、ルーティングを URL 駆動に保ちます。プレフィックスの解決、
     *   ロケールの永続化、Accept-Language 検出は引き続き動作します。
     *   本番環境では `true` と同じ挙動になります。
     * - true: すべての環境で完全な挙動。
     * - false: ロケールルーティングを行いません。
     * デフォルト: undefined (auto)
     */
    enableProxy: undefined,

    /**
     * ユーザーが選択したロケールを保存する場所。
     * オプション: '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,
  },

  /**
   * アナリティクス（analytics）設定。
   */
  analytics: {
    /**
     * アナリティクス収集を有効にするかどうか（ページビュー、コンテンツの露出、A/Bイベント）。
     * `@intlayer/analytics` がインストールされ、帰属（attribution）のために `editor.clientId` が設定されている必要があります。
     * デフォルト: true
     */
    enabled: true,

    /**
     * バックエンドへの自動バッチ送信間のミリ秒数。
     * デフォルト: 20000
     */
    flushInterval: 20000,

    /**
     * 記録するセッションの割合。0（なし）から1（すべて）まで。
     * デフォルト: 1
     */
    sampleRate: 1,
  },

  /**
   * AI による翻訳と生成の設定。
   */
  ai: {
    /**
     * 使用する AI プロバイダー。
     * オプション: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio', 'moonshotai'
     * デフォルト: 'openai'
     */
    provider: "openai",

    /**
     * 選択したプロバイダーで使用するモデル。
     */
    model: "gpt-4o",

    /**
     * プロバイダーの API キー。
     */
    apiKey: process.env.OPENAI_API_KEY,

    /**
     * 翻訳を生成する際に AI をガイドするグローバルコンテキスト。
     */
    applicationContext: "これは旅行予約アプリケーションです。",

    /**
     * AI API のベース URL。
     */
    baseURL: "http://localhost:3000",

    /**
     * データシリアライゼーション
     *
     * オプション:
     * - "json": デフォルト、信頼性が高いがトークン消費が多い。
     * - "toon": トークン消費が少ないが、JSON ほど一貫性がない。
     *
     * デフォルト: "json"
     */
    dataSerialization: "json",
  },

  /**
   * ビルドと最適化の設定。
   */
  build: {
    /**
     * ビルドの実行モード。
     * - "auto": アプリのビルド中に自動的にビルドされます。
     * - "manual": 明示的なビルドコマンドが必要です。
     * デフォルト: "auto"
     */
    mode: "auto",

    /**
     * 未使用の辞書を削除して、最終的なバンドルを最適化するかどうか。
     * デフォルト: 本番環境では true
     */
    optimize: true,

    /**
     * バンドルサイズを削減するために辞書を圧縮（Minify）する。
     * デフォルト: true
     *
     * 注意点:
     * - `optimize` が無効な場合、このオプションは無視されます。
     * - `editor.enabled` が true の場合、このオプションは無視されます。
     */
    minify: true,

    /**
     * 辞書内の未使用のキーを削除（Purge）する。
     * デフォルト: true
     *
     * 注意点:
     * - `optimize` が無効な場合、このオプションは無視されます。
     */
    purge: true,

    /**
     * ロケールごとの辞書チャンクを、それを使用するコード分割境界ごとにグループ化し、遅延読み込みされるページが 1
     * 回のリクエストでコンテンツを取得できるようにします。
     * デフォルト: true
     *
     * 注意点:
     * - `importMode: 'dynamic'` を使用する辞書にのみ適用されます。
     */
    chunkGrouping: true,

    /**
     * チャンクがレンダリングされてから取得するのではなく、そのチャンクを使用する辞書を一緒に読み込みます。読み取りはサスペンドせず同期的にレンダリングされるため、ナビゲーション時にローディング状態がちらつかなくなります。
     * デフォルト: true
     *
     * 注意点:
     * - 解決されたロケールのみを待つため、ページは表示する言語だけをダウンロードします。
     */
    dictionariesPreload: 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(),
    }),
  },

  /**
   * 辞書設定。
   */
  dictionary: {
    /**
     * 辞書のインポート方法を制御します。
     * - "static": ビルド時に静的にインポート。
     * - "dynamic": Suspenseを使用して動的にインポート。
     * - "fetch": ライブ同期APIを介して動的に取得。
     */
    importMode: "static",

    /**
     * プロジェクト内のすべての辞書のデフォルトのメッセージ形式。
     * - 'intlayer': ネイティブの intlayer 形式 (デフォルト)。
     * - 'icu': ICU メッセージ形式。
     * - 'i18next': i18next 形式。
     * - 'vue-i18n': Vue I18n 形式。
     * - 'po': GNU Gettext PO 形式。
     */
    format: "icu",
  },

  /**
   * プラグインの設定。
   */
  plugins: [
    syncJSON({
      format: "icu",
      source: ({ locale }) => `./messages/${locale}.json`,
    }),
  ],
};

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.ts
const 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.ts
const 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.ts
const 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.ts
const 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.ts
import { 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,
  },
};