Intlayer Yapılandırma Belgeleri

import { Locales, type IntlayerConfig } from "intlayer";
import { nextjsRewrite } from "intlayer/routing";
import { syncJSON } from "@intlayer/sync-json-plugin";
import { z } from "zod";

/**
 * Mevcut tüm seçenekleri gösteren Intlayer yapılandırma dosyası örneği.
 */
const config: IntlayerConfig = {
  /**
   * Uluslararasılaştırma ayarları için yapılandırma.
   */
  internationalization: {
    /**
     * Uygulamada desteklenen dillerin listesi.
     * Varsayılan: [Locales.ENGLISH]
     */
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],

    /**
     * Her sözlükte tanımlanması gereken zorunlu dillerin listesi.
     * Boşsa, `strict` modda tüm diller zorunludur.
     * Varsayılan: []
     */
    requiredLocales: [Locales.ENGLISH],

    /**
     * Uluslararasılaştırılmış içerik için katılık seviyesi.
     * - "strict": Bildirilen bir dil eksikse veya bildirilmemişse hata verir.
     * - "inclusive": Bildirilen bir dil eksikse uyarı verir.
     * - "loose": Mevcut herhangi bir dili kabul eder.
     * Varsayılan: "inclusive"
     */
    strictMode: "inclusive",

    /**
     * İstenen dil bulunamadığında geri dönüş (fallback) olarak kullanılan varsayılan dil.
     * Varsayılan: Locales.ENGLISH
     */
    defaultLocale: Locales.ENGLISH,
  },

  /**
   * Sözlük işlemlerini ve geri dönüş davranışını kontrol eden ayarlar.
   */
  dictionary: {
    /**
     * Sözlüklerin nasıl içe aktarılacağını kontrol eder.
     * - "static": Derleme zamanında statik olarak içe aktarılır.
     * - "dynamic": Suspense kullanılarak dinamik olarak içe aktarılır.
     * - "fetch": Live Sync API aracılığıyla dinamik olarak getirilir.
     * Varsayılan: "static"
     */
    importMode: "static",

    /**
     * Eksik çevirileri yapay zeka kullanarak otomatik doldurma stratejisi.
     * Bir boolean değer veya doldurulan içeriği saklamak için bir yol kalıbı olabilir.
     * Varsayılan: true
     */
    fill: true,

    /**
     * Sözlük dosyalarının fiziksel konumu.
     * - "local": Yerel dosya sisteminde saklanır.
     * - "remote": Intlayer CMS'de saklanır.
     * - "hybrid": Hem yerel dosya sisteminde hem de Intlayer CMS'de saklanır.
     * - "plugin" (veya herhangi bir özel dize): Bir eklenti veya özel bir kaynak tarafından sağlanır.
     * Varsayılan: "local"
     */
    location: "local",

    /**
     * İçeriklerin otomatik olarak dönüştürülüp dönüştürülmeyeceği (örneğin Markdown'dan HTML'e).
     * Varsayılan: false
     */
    contentAutoTransformation: false,
  },

  /**
   * Yönlendirme ve ara yazılım yapılandırması.
   */
  routing: {
    /**
     * Dil yönlendirme stratejisi.
     * - "prefix-no-default": Varsayılan dil dışındaki tüm diller için önek (örneğin /dashboard, /fr/dashboard).
     * - "prefix-all": Tüm diller için önek (örneğin /en/dashboard, /fr/dashboard).
     * - "no-prefix": URL'de dil yok.
     * - "search-params": ?locale=... kullanır.
     * Varsayılan: "prefix-no-default"
     */
    mode: "prefix-no-default",

    /**
     * Intlayer yerel ayar yönlendirme proxy'sini (middleware) etkinleştirir.
     * dev, preview ve SSR ortamlarında yerel ayar tespiti, yönlendirme ve yeniden yazmayı yönetir.
     * - ayarlanmamış (auto): dev ve preview sunucuları, çerezlerde ve başlıklarda saklanan
     *   yerel ayarı yok sayarak yönlendirmeyi URL odaklı tutar. Önekler yine çözümlenir,
     *   yerel ayar yine kalıcı hale getirilir ve Accept-Language tespiti yine geçerlidir.
     *   Üretimde `true` gibi davranır.
     * - true: her ortamda tam davranış.
     * - false: yerel ayar yönlendirmesi yok.
     * Varsayılan: undefined (auto)
     */
    enableProxy: undefined,

    /**
     * Kullanıcının seçtiği dilin nerede saklanacağı.
     * Seçenekler: 'cookie', 'localStorage', 'sessionStorage', 'header' veya bunların bir dizisi.
     * Varsayılan: ['cookie', 'header']
     */
    storage: ["cookie", "header"],

    /**
     * Uygulama URL'leri için temel yol.
     * Varsayılan: ""
     */
    basePath: "",

    /**
     * Dile özel yollar için özel URL yeniden yazma kuralları.
     */
    rewrite: nextjsRewrite({
      "/[locale]/about": {
        en: "/[locale]/about",
        fr: "/[locale]/a-propos",
      },
    }),

    /**
     * Alan adı tabanlı yönlendirme için dilleri alan adı ana bilgisayar adlarıyla eşleştirir.
     * Bu dillerin URL'leri mutlak olacaktır (örneğin, https://intlayer.cn/).
     * Alan adı dili ima eder, bu nedenle yola herhangi bir dil öneki eklenmez.
     * Varsayılan: undefined
     */
    domains: {
      en: "intlayer.org",
      zh: "intlayer.cn",
    },
  },

  /**
   * İçerik dosyalarını bulma ve işleme ayarları.
   */
  content: {
    /**
     * Sözlükler için taranacak dosya uzantıları.
     * Varsayılan: ['.content.ts', '.content.js', '.content.json', vb.]
     */
    fileExtensions: [".content.ts", ".content.js", ".content.json"],

    /**
     * .content dosyalarının bulunduğu dizinler.
     * Varsayılan: ["."]
     */
    contentDir: ["src"],

    /**
     * Kaynak kodun bulunduğu dizin.
     * Derleme optimizasyonu ve kod dönüşümü için kullanılır.
     * Varsayılan: ["."]
     */
    codeDir: ["src"],

    /**
     * Taramadan hariç tutulacak kalıplar.
     * Varsayılan: ['node_modules', '.intlayer', vb.]
     */
    excludedPath: ["node_modules"],

    /**
     * Geliştirme sırasında değişikliklerin izlenip izlenmeyeceği ve sözlüklerin yeniden oluşturulup oluşturulmayacağı.
     * Varsayılan: Geliştirmede true
     */
    watch: true,

    /**
     * Yeni oluşturulan / güncellenen .content dosyalarını biçimlendirmek için komut.
     */
    formatCommand: 'npx prettier --write "{{file}}"',
  },

  /**
   * Görsel Editör yapılandırması.
   */
  editor: {
    /**
     * Görsel editörün etkin olup olmadığı.
     * Varsayılan: false
     */
    enabled: true,

    /**
     * Kaynak doğrulaması için uygulamanızın URL'si.
     * Varsayılan: ""
     */
    applicationURL: "http://localhost:3000",

    /**
     * Yerel editör sunucusu için port.
     * Varsayılan: 8000
     */
    port: 8000,

    /**
     * Editör için genel URL.
     * Varsayılan: "http://localhost:8000"
     */
    editorURL: "http://localhost:8000",

    /**
     * Intlayer CMS URL'si.
     * Varsayılan: "https://app.intlayer.org"
     */
    cmsURL: "https://app.intlayer.org",

    /**
     * Arka uç API URL'si.
     * Varsayılan: "https://back.intlayer.org"
     */
    backendURL: "https://back.intlayer.org",

    /**
     * Gerçek zamanlı içerik senkronizasyonunun etkinleştirilip etkinleştirilmeyeceği.
     * Varsayılan: false
     */
    liveSync: true,
  },

  /**
   * Analitik (analytics) yapılandırması.
   */
  analytics: {
    /**
     * Analitik toplamanın etkin olup olmadığı (sayfa görüntülemeleri, içerik gösterimleri, A/B olayları).
     * `@intlayer/analytics` paketinin kurulu olması ve atıflandırma (attribution) için `editor.clientId` ayarlanmış olması gerekir.
     * Varsayılan: true
     */
    enabled: true,

    /**
     * Backend'e otomatik toplu gönderimler arasındaki milisaniye.
     * Varsayılan: 20000
     */
    flushInterval: 20000,

    /**
     * Kaydedilecek oturumların oranı, 0 (hiçbiri) ile 1 (tümü) arasında.
     * Varsayılan: 1
     */
    sampleRate: 1,
  },

  /**
   * Yapay zeka destekli çeviri ve oluşturma ayarları.
   */
  ai: {
    /**
     * Kullanılacak yapay zeka sağlayıcısı.
     * Seçenekler: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini', 'ollama', 'openrouter', 'alibaba', 'fireworks', 'groq', 'huggingface', 'bedrock', 'googlevertex', 'togetherai', 'lmstudio', 'moonshotai'
     * Varsayılan: 'openai'
     */
    provider: "openai",

    /**
     * Seçilen sağlayıcıdan kullanılacak model.
     */
    model: "gpt-4o",

    /**
     * Sağlayıcının API anahtarı.
     */
    apiKey: process.env.OPENAI_API_KEY,

    /**
     * Çeviri oluştururken yapay zekaya rehberlik edecek küresel bağlam.
     */
    applicationContext: "Bu bir seyahat rezervasyon uygulamasıdır.",

    /**
     * Yapay zeka API'si için temel URL.
     */
    baseURL: "http://localhost:3000",

    /**
     * Veri Serileştirme
     *
     * Seçenekler:
     * - "json": Varsayılan, güvenilir; daha fazla token tüketir.
     * - "toon": Daha az token, JSON kadar tutarlı değil.
     *
     * Varsayılan: "json"
     */
    dataSerialization: "json",
  },

  /**
   * Derleme ve optimizasyon ayarları.
   */
  build: {
    /**
     * Derleme yürütme modu.
     * - "auto": Uygulama derlemesi sırasında otomatik derleme.
     * - "manual": Açık bir derleme komutu gerektirir.
     * Varsayılan: "auto"
     */
    mode: "auto",

    /**
     * Kullanılmayan sözlükleri kaldırarak final paketinin optimize edilip edilmeyeceği.
     * Varsayılan: Üretimde true
     */
    optimize: true,

    /**
     * Demet boyutunu azaltmak için sözlükleri küçültün (Minify).
     * Varsayılan: false
     *
     * Not:
     * - `optimize` devre dışı bırakılırsa bu seçenek yoksayılır.
     * - `editor.enabled` true ise bu seçenek yoksayılır.
     */
    minify: true,

    /**
     * Sözlüklerdeki kullanılmayan anahtarları temizleyin (Purge).
     * Varsayılan: false
     *
     * Not:
     * - `optimize` devre dışı bırakılırsa bu seçenek yoksayılır.
     */
    purge: true,

    /**
     * Yerel ayara özgü sözlük parçalarını, onları kullanan kod bölme sınırına göre
     * grupla; böylece geç yüklenen bir sayfa içeriğini tek istekte alır.
     * Varsayılan: true
     *
     * Not:
     * - Yalnızca `importMode: 'dynamic'` kullanan sözlükler için geçerlidir.
     */
    chunkGrouping: true,

    /**
     * Bir sözlüğü, onu kullanan parça render edildikten sonra getirmek yerine o
     * parçayla birlikte yükle. Okumalar askıya alınmak yerine eşzamanlı render
     * edilir, böylece gezinme sırasında artık yükleme durumu görünmez.
     * Varsayılan: true
     *
     * Not:
     * - Yalnızca çözümlenen yerel ayar beklenir, bu nedenle sayfa yalnızca
     *   gösterdiği dili indirir.
     */
    dictionariesPreload: true,

    /**
     * Oluşturulan sözlük dosyaları için çıktı formatı.
     * Varsayılan: ['cjs', 'esm']
     */
    outputFormat: ["cjs", "esm"],

    /**
     * Derlemenin TypeScript türlerini kontrol edip etmeyeceği.
     * Varsayılan: false
     */
    checkTypes: false,
  },

  /**
   * Logger yapılandırması.
   */
  log: {
    /**
     * Günlük kaydı seviyesi.
     * - "default": Standart günlük kaydı.
     * - "verbose": Ayrıntılı hata ayıklama günlüğü.
     * - "disabled": Günlük kaydı yok.
     * Varsayılan: "default"
     */
    mode: "default",

    /**
     * Tüm günlük mesajları için önek.
     * Varsayılan: "[intlayer]"
     */
    prefix: "[intlayer]",
  },

  /**
   * Sistem Yapılandırması (Gelişmiş Kullanım Durumları)
   */
  system: {
    /**
     * Yerelleştirilmiş sözlükleri saklamak için dizin.
     */
    dictionariesDir: ".intlayer/dictionary",

    /**
     * Modül genişletme (module augmentation) dizini.
     */
    moduleAugmentationDir: ".intlayer/types",

    /**
     * Birleştirilmemiş sözlükleri saklamak için dizin.
     */
    unmergedDictionariesDir: ".intlayer/unmerged_dictionary",

    /**
     * Sözlük türlerini saklamak için dizin.
     */
    typesDir: ".intlayer/types",

    /**
     * Ana uygulama dosyalarının saklandığı dizin.
     */
    mainDir: ".intlayer/main",

    /**
     * Yapılandırma dosyalarının saklandığı dizin.
     */
    configDir: ".intlayer/config",

    /**
     * Önbellek dosyalarının saklandığı dizin.
     */
    cacheDir: ".intlayer/cache",
  },

  /**
   * Derleyici Yapılandırması (Gelişmiş Kullanım Durumları)
   */
  compiler: {
    /**
     * Derleyicinin etkin olup olmayacağı.
     *
     * - false: Derleyiciyi devre dışı bırak.
     * - true: Derleyiciyi etkinleştir.
     * - "build-only": Başlangıç sürelerini hızlandırmak için geliştirme sırasında derleyiciyi atla.
     *
     * Varsayılan: false
     */
    enabled: true,

    /**
     * Çıktı dosyaları için yolu belirler. `outputDir` yerine geçer.
     *
     * - `./` yolları bileşen dizinine göre çözümlenir.
     * - `/` yolları proje köküne (`baseDir`) göre çözümlenir.
     *
     * - Yol içinde `{{locale}}` değişkeninin bulunması, dile göre ayrı sözlükler oluşturulmasını tetikler.
     *
     * Örnek:
     * ```ts
     * {
     *   // Bileşenin yanında çok dilli .content.ts dosyaları oluştur
     *   output: ({ fileName, extension }) => `./${fileName}${extension}`,
     *
     *   // output: './{{fileName}}{{extension}}', // Şablon dizesi kullanarak eşdeğer
     * }
     * ```
     *
     * ```ts
     * {
     *   // Proje kökünde dile göre merkezileştirilmiş JSON'lar oluştur
     *   output: ({ key, locale }) => `/locales/${locale}/${key}.content.json`,
     *
     *   // output: '/locales/{{locale}}/{{key}}.content.json', // Şablon dizesi kullanarak eşdeğer
     * }
     * ```
     *
     * Değişken Listesi:
     *   - `fileName`: Dosya adı.
     *   - `key`: İçerik anahtarı.
     *   - `locale`: İçerik dili (locale).
     *   - `extension`: Dosya uzantısı.
     *   - `componentFileName`: Bileşen dosya adı.
     *   - `componentExtension`: Bileşen dosya uzantısı.
     *   - `format`: Sözlük formatı.
     *   - `componentFormat`: Bileşen sözlük formatı.
     *   - `componentDirPath`: Bileşen dizin yolu.
     */
    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,

    /**
     * Dönüştürüldükten sonra bileşenlerin kaydedilip kaydedilmeyeceği.
     * Bu sayede derleyici uygulamayı dönüştürmek için yalnızca bir kez çalıştırılabilir ve ardından kaldırılabilir.
     */
    saveComponents: false,

    /**
     * Oluşturulan dosyaya yalnızca içeriği ekle. Dile göre i18next veya ICU MessageFormat JSON çıktıları için yararlıdır.
     */
    noMetadata: false,

    /**
     * Sözlük anahtar öneki
     */
    dictionaryKeyPrefix: "", // Çıkarılan sözlük anahtarları için isteğe bağlı önek ekleyin
  },

  /**
   * Sözlüklerin içeriğini doğrulamak için özel şemalar.
   */
  schemas: {
    "my-schema": z.object({
      title: z.string(),
    }),
  },

  /**
   * Sözlük yapılandırması.
   */
  dictionary: {
    /**
     * Sözlüklerin nasıl içe aktarıldığını kontrol eder.
     * - "static": Derleme zamanında statik olarak içe aktarılır.
     * - "dynamic": Suspense kullanılarak dinamik olarak içe aktarılır.
     * - "fetch": Canlı senkronizasyon API'si aracılığıyla dinamik olarak alınır.
     */
    importMode: "static",

    /**
     * Projedeki tüm sözlükler için varsayılan mesaj biçimi.
     * - 'intlayer': Yerel intlayer biçimi (varsayılan).
     * - 'icu': ICU mesaj biçimi.
     * - 'i18next': i18next biçimi.
     * - 'vue-i18n': Vue I18n biçimi.
     * - 'po': GNU Gettext PO biçimi.
     */
    format: "icu",
  },

  /**
   * Eklenti yapılandırması.
   */
  plugins: [
    syncJSON({
      format: "icu",
      source: ({ locale }) => `./messages/${locale}.json`,
    }),
  ],
};

export default config;

routing: {
  mode: "prefix-no-default", // Geri dönüş stratejisi
  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", // Yeniden yazılmayan yollar için geri dönüş
    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,
  },
};