Documentação de Configuração do Intlayer

import { Locales, type IntlayerConfig } from "intlayer";import { nextjsRewrite } from "intlayer/routing";import { z } from "zod";/** * Exemplo de ficheiro de configuração do Intlayer que mostra todas as opções disponíveis. */const config: IntlayerConfig = {  /**   * Configuração para as definições de internacionalização.   */  internationalization: {    /**     * Lista de idiomas suportados na aplicação.     * Padrão: [Locales.ENGLISH]     */    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    /**     * Lista de idiomas obrigatórios que devem ser definidos em cada dicionário.     * Se vazio, todos os idiomas são obrigatórios no modo `strict`.     * Padrão: []     */    requiredLocales: [Locales.ENGLISH],    /**     * Nível de severidade para o conteúdo internacionalizado.     * - "strict": Erro se faltar um idioma declarado ou se não estiver declarado.     * - "inclusive": Aviso se faltar um idioma declarado.     * - "loose": Aceita qualquer idioma existente.     * Padrão: "inclusive"     */    strictMode: "inclusive",    /**     * Idioma padrão usado como fallback se o idioma solicitado não for encontrado.     * Padrão: Locales.ENGLISH     */    defaultLocale: Locales.ENGLISH,  },  /**   * Configurações que controlam as operações do dicionário e o comportamento de fallback.   */  dictionary: {    /**     * Controla como os dicionários são importados.     * - "static": Importado estaticamente no momento da build.     * - "dynamic": Importado dinamicamente usando Suspense.     * - "fetch": Recuperado dinamicamente através da API Live Sync.     * Padrão: "static"     */    importMode: "static",    /**     * Estratégia para o preenchimento automático de traduções em falta usando IA.     * Pode ser um booleano ou um padrão de caminho para armazenar o conteúdo preenchido.     * Padrão: true     */    fill: true,    /**     * Localização física dos ficheiros do dicionário.     * - "local": Armazenado no sistema de ficheiros local.     * - "remote": Armazenado no Intlayer CMS.     * - "hybrid": Armazenado no sistema de ficheiros local e no Intlayer CMS.     * - "plugin" (ou qualquer string personalizada): Fornecido por um plugin ou fonte personalizada.     * Padrão: "local"     */    location: "local",    /**     * Se deve transformar automaticamente os conteúdos (ex: Markdown para HTML).     * Padrão: false     */    contentAutoTransformation: false,  },  /**   * Configuração de roteamento e middleware.   */  routing: {    /**     * Estratégia de roteamento de idiomas.     * - "prefix-no-default": Prefixo para todos exceto o idioma padrão (ex: /dashboard, /fr/dashboard).     * - "prefix-all": Prefixo para todos os idiomas (ex: /en/dashboard, /fr/dashboard).     * - "no-prefix": Sem idioma no URL.     * - "search-params": Usa ?locale=...     * Padrão: "prefix-no-default"     */    mode: "prefix-no-default",    /**     * Onde armazenar o idioma selecionado pelo utilizador.     * Opções: 'cookie', 'localStorage', 'sessionStorage', 'header', ou um array destes.     * Padrão: ['cookie', 'header']     */    storage: ["cookie", "header"],    /**     * Caminho base para os URLs da aplicação.     * Padrão: ""     */    basePath: "",    /**     * Regras de reescrita de URL personalizadas para caminhos específicos de idioma.     */    rewrite: nextjsRewrite({      "/[locale]/about": {        en: "/[locale]/about",        fr: "/[locale]/a-propos",      },    }),    /**     * Mapeia idiomas para nomes de host de domínio para roteamento baseado em domínio.     * URLs para estes idiomas serão absolutos (ex: https://intlayer.cn/).     * O domínio implica le idioma, portanto não é adicionado prefixo de idioma ao caminho.     * Padrão: undefined     */    domains: {      en: "intlayer.org",      zh: "intlayer.cn",    },  },  /**   * Configurações para encontrar e processar ficheiros de conteúdo.   */  content: {    /**     * Extensões de ficheiro a analisar para dicionários.     * Padrão: ['.content.ts', '.content.js', '.content.json', etc.]     */    fileExtensions: [".content.ts", ".content.js", ".content.json"],    /**     * Diretórios onde os ficheiros .content residem.     * Padrão: ["."]     */    contentDir: ["src"],    /**     * Diretório onde o código fonte reside.     * Usado para otimização de build e transformação de código.     * Padrão: ["."]     */    codeDir: ["src"],    /**     * Padrões a excluir da análise.     * Padrão: ['node_modules', '.intlayer', etc.]     */    excludedPath: ["node_modules"],    /**     * Se deve monitorizar alterações e regenerar dicionários durante o desenvolvimento.     * Padrão: true em desenvolvimento     */    watch: true,    /**     * Comando para formatar ficheiros .content recém-criados / atualizados.     */    formatCommand: 'npx prettier --write "{{file}}"',  },  /**   * Configuração do Visual Editor.   */  editor: {    /**     * Se o visual editor está ativado.     * Padrão: false     */    enabled: true,    /**     * URL da sua aplicação para validação de origem.     * Padrão: ""     */    applicationURL: "http://localhost:3000",    /**     * Porta para o servidor local do editor.     * Padrão: 8000     */    port: 8000,    /**     * URL pública para o editor.     * Padrão: "http://localhost:8000"     */    editorURL: "http://localhost:8000",    /**     * URL do Intlayer CMS.     * Padrão: "https://app.intlayer.org"     */    cmsURL: "https://app.intlayer.org",    /**     * URL da API do backend.     * Padrão: "https://back.intlayer.org"     */    backendURL: "https://back.intlayer.org",    /**     * Se deve ativar a sincronização de conteúdo em tempo real.     * Padrão: false     */    liveSync: true,  },  /**   * Definições de tradução e geração assistida por IA.   */  ai: {    /**     * Provedor de IA a utilizar.     * Opções: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio'     * Padrão: 'openai'     */    provider: "openai",    /**     * Modelo a utilizar do provedor selecionado.     */    model: "gpt-4o",    /**     * Chave da API do provedor.     */    apiKey: process.env.OPENAI_API_KEY,    /**     * Contexto global para guiar a IA na geração de traduções.     */    applicationContext: "Esta é uma aplicação de reserva de viagens.",    /**     * URL base para a API de IA.     */    baseURL: "http://localhost:3000",    /**     * Serialização de dados     *     * Opções:     * - "json": Padrão, fiável; consome mais tokens.     * - "toon": Menos tokens, menos consistente que JSON.     *     * Padrão: "json"     */    dataSerialization: "json",  },  /**   * Configurações de build e otimização.   */  build: {    /**     * Modo de execução da build.     * - "auto": Build automática durante a build da app.     * - "manual": Requer um comando de build explícito.     * Padrão: "auto"     */    mode: "auto",    /**     * Se deve otimizar o bundle final removendo dicionários não utilizados.     * Padrão: true em produção     */    optimize: true,    /**     * Minifica os dicionários para reduzir o tamanho do bundle.     * Padrão: false     *     * Nota:     * - Esta opção será ignorada se `optimize` estiver desativada.     * - Esta opção será ignorada se `editor.enabled` for true.     */    minify: true,    /**     * Purga as chaves não utilizadas nos dicionários.     * Padrão: false     *     * Nota:     * - Esta opção será ignorada se `optimize` estiver desativada.     */    purge: true,    /**     * Formato de saída para os ficheiros de dicionário gerados.     * Padrão: ['cjs', 'esm']     */    outputFormat: ["cjs", "esm"],    /**     * Indica se a build deve verificar os tipos TypeScript.     * Padrão: false     */    checkTypes: false,  },  /**   * Configuração do Logger.   */  log: {    /**     * Nível de registo.     * - "default": Registo padrão.     * - "verbose": Registo de depuração detalhado.     * - "disabled": Sem registo.     * Padrão: "default"     */    mode: "default",    /**     * Prefixo para todas as mensagens de registo.     * Padrão: "[intlayer]"     */    prefix: "[intlayer]",  },  /**   * Configuração do Sistema (Casos de uso avançados)   */  system: {    /**     * Diretório para armazenar dicionários localizados.     */    dictionariesDir: ".intlayer/dictionary",    /**     * Diretório para a "module augmentation".     */    moduleAugmentationDir: ".intlayer/types",    /**     * Diretório para armazenar dicionários não fundidos.     */    unmergedDictionariesDir: ".intlayer/unmerged_dictionary",    /**     * Diretório para armazenar tipos de dicionário.     */    typesDir: ".intlayer/types",    /**     * Diretório onde os ficheiros principais da aplicação estão armazenados.     */    mainDir: ".intlayer/main",    /**     * Diretório onde os ficheiros de configuração estão armazenados.     */    configDir: ".intlayer/config",    /**     * Diretório onde os ficheiros de cache estão armazenados.     */    cacheDir: ".intlayer/cache",  },  /**   * Configuração do Compilador (Casos de uso avançados)   */  compiler: {    /**     * Indica se o compilador deve estar ativado.     *     * - false: Desativar compilador.     * - true: Ativar compilador.     * - "build-only": Ignorar o compilador durante o desenvolvimento para acelerar o arranque.     *     * Padrão: false     */    enabled: true,    /**     * Define o caminho para os ficheiros de saída. Substitui `outputDir`.     *     * - Caminhos `./` são resolvidos relativamente ao diretório da componente.     * - Caminhos `/` são resolvidos relativamente à raiz do projeto (`baseDir`).     *     * - Incluir a variável `{{locale}}` no caminho irá ativar a geração de dicionários separados por idioma.     *     * Exemplo:     * ```ts     * {     *   // Criar ficheiros .content.ts multi-idioma perto da componente     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,     *     *   // output: './{{fileName}}{{extension}}', // Equivalente usando template string     * }     * ```     *     * ```ts     * {     *   // Criar JSONs centralizados por idioma na raiz do projeto     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,     *     *   // output: '/locales/{{locale}}/{{key}}.content.json', // Equivalente usando template string     * }     * ```     *     * Lista de variáveis:     *   - `fileName`: O nome do ficheiro.     *   - `key`: A chave do conteúdo.     *   - `locale`: O idioma do conteúdo.     *   - `extension`: A extensão do ficheiro.     *   - `componentFileName`: O nome do ficheiro da componente.     *   - `componentExtension`: A extensão do ficheiro da componente.     *   - `format`: O formato do dicionário.     *   - `componentFormat`: O formato do dicionário da componente.     *   - `componentDirPath`: O caminho do diretório da componente.     */    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,    /**     * Se deve guardar as componentes após serem transformadas.     *     * - Se `true`, o compilador reescreverá o arquivo do componente no disco. Portanto, a transformação será permanente, e o compilador pulará a transformação para o próximo processo. Dessa forma, o compilador pode transformar o app, e então pode ser removido.     *     * - Se `false`, o compilador injetará a chamada da função `useIntlayer()` no código apenas na saída da build, e manterá a base de código original intacta. A transformação será feita apenas em memória.     */    saveComponents: false,    /**     * Inserir apenas o conteúdo no ficheiro gerado. Útil para saídas i18next ou ICU MessageFormat JSON por idioma.     */    noMetadata: false,    /**     * Prefixo da chave do dicionário     */    dictionaryKeyPrefix: "", // Adicionar prefixo opcional para as chaves de dicionário extraídas  },  /**   * Esquemas personalizados para validar o conteúdo dos dicionários.   */  schemas: {    "my-schema": z.object({      title: z.string(),    }),  },  /**   * Configuração de plugins.   */  plugins: [],};export default config;

routing: {  mode: "prefix-no-default", // Estratégia de fallback  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", // Fallback para caminhos não reescritos    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,  },};