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 将是绝对的（例如，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",    /**     * 数据序列化方式     *     * 选项：     * - "json": 默认，可靠；使用更多 token。     * - "toon": 更快，更少 token，但不如 JSON 稳定。     *     * 默认值："json"     */    dataSerialization: "json",  },  /**   * 构建和优化设置。   */  build: {    /**     * 构建执行模式。     * - "auto": 应用程序构建期间自动构建。     * - "manual": 需要显式构建命令。     * 默认值："auto"     */    mode: "auto",    /**     * 是否通过删除未使用的字典来优化应用程序包。     * 默认值：生产环境中为 true     */    optimize: true,    /**     * 压缩字典以减小包体大小。     * 默认值：true     *     * 注意：     * - 如果禁用 `optimize`，此选项将被忽略。     * - 如果 `editor.enabled` 为 true，此选项将被忽略。     */    minify: true,    /**     * 清除字典中未使用的键。     * 默认值：true     *     * 注意：     * - 如果禁用 `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`,    /**     * 转换组件后是否保存它们。     *     * - 如果为 `true`，编译器将重写磁盘中的组件文件。因此转换将是永久性的，编译器将跳过下一次进程的转换。这样，编译器可以在转换应用后被移除。     *     * - 如果为 `false`，编译器仅在构建输出中将 `useIntlayer()` 函数调用注入代码中，并保持基础代码库不变。转换将仅在内存中进行。     */    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,  },};