Intlayer Yapılandırma Dokümantasyonu

Genel Bakış

Intlayer yapılandırma dosyaları, uluslararasılaştırma, ara katman (middleware) ve içerik işleme gibi eklentinin çeşitli yönlerinin özelleştirilmesine olanak tanır. Bu belge, yapılandırmadaki her bir özelliğin ayrıntılı açıklamasını sağlar.

Yapılandırma Dosyası Desteği

Intlayer, JSON, JS, MJS ve TS yapılandırma dosyası formatlarını kabul eder:

• intlayer.config.ts
• intlayer.config.js
• intlayer.config.json
• intlayer.config.cjs
• intlayer.config.mjs
• .intlayerrc

Örnek yapılandırma dosyası

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [Locales.ENGLISH], // Desteklenen diller  },  content: {    autoFill: "./{{fileName}}.content.json", // İçeriğin otomatik doldurulacağı dosya yolu    contentDir: ["src", "../ui-library"], // İçerik dizinleri  },  middleware: {    noPrefix: false, // Önek kullanımı  },  editor: {    applicationURL: "https://example.com", // Uygulama URL'si  },  ai: {    apiKey: process.env.OPENAI_API_KEY, // AI API anahtarı    applicationContext: "This is a test application", // Uygulama bağlamı  },  build: {    importMode: "dynamic", // İçe aktarma modu  },};export default config;

Konfigürasyon Referansı

Aşağıdaki bölümler, Intlayer için mevcut olan çeşitli konfigürasyon ayarlarını açıklamaktadır.

Uluslararasılaştırma Konfigürasyonu

Uygulama için mevcut yerel ayarları ve varsayılan yerel ayarı içeren uluslararasılaştırma ile ilgili ayarları tanımlar.

Özellikler

• locales:

  • Tür: string[]
  • Varsayılan: ['en']
  • Açıklama: Uygulamada desteklenen yerel ayarların listesi.
  • Örnek: ['en', 'fr', 'es']
• requiredLocales:
  • Tür: string[]
  • Varsayılan: []
  • Açıklama: Uygulamada zorunlu olan yerel ayarların listesi.
  • Örnek: []
  • Not: Boşsa, strict modda tüm yerel ayarlar gereklidir.
  • Not: Gereken yerel ayarların locales alanında da tanımlandığından emin olun.

• strictMode:

  • Tür: string
  • Varsayılan: inclusive
  • Açıklama: Typescript kullanarak uluslararasılaştırılmış içeriğin güçlü uygulamalarını sağlar.
  • Not: "strict" olarak ayarlanırsa, çeviri t fonksiyonu her bildirilen yerel ayarın tanımlanmasını gerektirir. Bir yerel ayar eksikse veya yapılandırmanızda bildirilmemişse, hata verir.
  • Not: "inclusive" olarak ayarlanırsa, çeviri t fonksiyonu her bildirilen yerel ayarın tanımlanmasını gerektirir. Bir yerel ayar eksikse uyarı verir. Ancak yapılandırmanızda bildirilmemiş ama mevcut olan bir yerel ayarı kabul eder.
  • Not: "loose" olarak ayarlanırsa, çeviri t fonksiyonu mevcut olan herhangi bir yerel ayarı kabul edecektir.

• defaultLocale:

  • Tür: string
  • Varsayılan: 'en'
  • Açıklama: İstenen yerel ayar bulunamadığında kullanılan varsayılan yerel ayar.
  • Örnek: 'en'
  • Not: URL, çerez veya başlıkta yerel ayar belirtilmediğinde kullanılacak yerel ayarı belirlemek için kullanılır.

Editör Yapılandırması

Entegre editörle ilgili ayarları, sunucu portu ve aktiflik durumu dahil olmak üzere tanımlar.

Özellikler

• applicationURL:

  • Tür: string
  • Varsayılan: http://localhost:3000
  • Açıklama: Uygulamanın URL'si. Güvenlik nedenleriyle editörün kaynağını kısıtlamak için kullanılır.
  • Örnek:
    • 'http://localhost:3000'
    • 'https://example.com'
    • process.env.INTLAYER_EDITOR_URL
  • Not: Uygulamanın URL'si. Güvenlik nedenleriyle editörün kaynağını kısıtlamak için kullanılır. '*' olarak ayarlanırsa, editöre herhangi bir kaynaktan erişilebilir.

• port:

  • Tür: number
  • Varsayılan: 8000
  • Açıklama: Görsel editör sunucusunun kullandığı port.

• editorURL:

  • Tür: string
  • Varsayılan: 'http://localhost:8000'
  • Açıklama: Editör sunucusunun URL'si. Güvenlik nedenleriyle editörün kaynağını kısıtlamak için kullanılır.
    • 'http://localhost:3000'
    • 'https://example.com'
    • process.env.INTLAYER_EDITOR_URL
  • Not: Uygulamadan erişilecek editör sunucusunun URL'si. Güvenlik nedenleriyle uygulamayla etkileşime girebilecek kaynakları kısıtlamak için kullanılır. '*' olarak ayarlanırsa, editöre herhangi bir kaynaktan erişilebilir. Port değiştirildiğinde veya editör farklı bir alan adında barındırılıyorsa ayarlanmalıdır.

• cmsURL:

  • Tür: string
  • Varsayılan: 'https://intlayer.org'
  • Açıklama: Intlayer CMS'nin URL'si.
  • Örnek: 'https://intlayer.org'
  • Not: Intlayer CMS'nin URL'si.

• backendURL:

  • Tür: string
  • Varsayılan: https://back.intlayer.org
  • Açıklama: Backend sunucusunun URL'si.
  • Örnek: http://localhost:4000

• enabled:

  • Tür: boolean
  • Varsayılan: true
  • Açıklama: Uygulamanın görsel editörle etkileşimde bulunup bulunmadığını belirtir.
  • Örnek: process.env.NODE_ENV !== 'production'
  • Not: Eğer true ise, editör uygulamayla etkileşimde bulunabilir. Eğer false ise, editör uygulamayla etkileşimde bulunamaz. Her durumda, editör yalnızca görsel editör tarafından etkinleştirilebilir. Belirli ortamlar için editörün devre dışı bırakılması, güvenliği sağlamak için bir yöntemdir.

• clientId:

  • Tür: string | undefined
  • Varsayılan: undefined
  • Açıklama: clientId ve clientSecret, intlayer paketlerinin backend ile oAuth2 kimlik doğrulaması kullanarak kimlik doğrulaması yapmasını sağlar. Bir erişim belirteci, projeyle ilişkili kullanıcıyı doğrulamak için kullanılır. Bir erişim belirteci almak için https://intlayer.org/dashboard/project adresine gidip bir hesap oluşturun.
  • Örnek: true
  • Not: Önemli: clientId ve clientSecret gizli tutulmalı ve kamuya açık şekilde paylaşılmamalıdır. Lütfen bunları ortam değişkenleri gibi güvenli bir yerde sakladığınızdan emin olun.

• clientSecret:

  • Tür: string | undefined
  • Varsayılan: undefined
  • Açıklama: clientId ve clientSecret, intlayer paketlerinin backend ile oAuth2 kimlik doğrulaması kullanarak doğrulanmasını sağlar. Bir erişim belirteci, projeyle ilişkili kullanıcıyı doğrulamak için kullanılır. Bir erişim belirteci almak için https://intlayer.org/dashboard/project adresine gidip bir hesap oluşturun.
  • Örnek: true
  • Not: Önemli: clientId ve clientSecret gizli tutulmalı ve kamuya açık şekilde paylaşılmamalıdır. Lütfen bunları ortam değişkenleri gibi güvenli bir yerde sakladığınızdan emin olun.

• dictionaryPriorityStrategy:

  • Tür: string
  • Varsayılan: 'local_first'
  • Açıklama: Hem yerel hem de uzak sözlüklerin mevcut olduğu durumlarda sözlüklerin önceliklendirilme stratejisi. 'distant_first' olarak ayarlanırsa, uygulama uzak sözlüklere yerel sözlüklerden daha fazla öncelik verir. 'local_first' olarak ayarlanırsa, uygulama yerel sözlüklere uzak sözlüklerden daha fazla öncelik verir.
  • Örnek: 'distant_first'

• liveSync:

  • Tür: boolean
  • Varsayılan: false
  • Açıklama: CMS / Görsel Editör / Backend üzerinde bir değişiklik algılandığında uygulama sunucusunun içeriği sıcak yeniden yükleyip yüklemeyeceğini belirtir.
  • Örnek: true
  • Not: Örneğin, yeni bir sözlük eklendiğinde veya güncellendiğinde, uygulama sayfada görüntülenecek içeriği günceller.
  • Not: Canlı senkronizasyon, uygulamanın içeriğini başka bir sunucuya dışa aktarmayı gerektirir. Bu, uygulamanın performansını biraz etkileyebilir. Bunu sınırlamak için, uygulamanın ve canlı senkronizasyon sunucusunun aynı makinede barındırılmasını öneriyoruz. Ayrıca, canlı senkronizasyon ile optimize kombinasyonu, canlı senkronizasyon sunucusuna önemli sayıda istek gönderebilir. Altyapınıza bağlı olarak, her iki seçeneği ve kombinasyonlarını test etmenizi öneririz.

• liveSyncPort:

  • Tür: number
  • Varsayılan: 4000
  • Açıklama: Canlı senkronizasyon sunucusunun portu.
  • Örnek: 4000
  • Not: Canlı senkronizasyon sunucusunun portu.

• liveSyncURL:

  • Tür: string
  • Varsayılan: 'http://localhost:{liveSyncPort}'
  • Açıklama: Canlı senkronizasyon sunucusunun URL'si.
  • Örnek: 'https://example.com'
  • Not: Varsayılan olarak localhost'a işaret eder ancak uzak bir canlı senkronizasyon sunucusu durumunda herhangi bir URL'ye değiştirilebilir.

Ara Katman (Middleware) Yapılandırması

Uygulamanın çerezleri, başlıkları ve yerel yönetimi için URL öneklerini nasıl yönettiğini kontrol eden ayarlar.

Özellikler

• headerName:

  • Tür: string
  • Varsayılan: 'x-intlayer-locale'
  • Açıklama: Yerel ayarı belirlemek için kullanılan HTTP başlığının adı.
  • Örnek: 'x-custom-locale'
  • Not: API tabanlı yerel belirleme için faydalıdır.

• cookieName:

  • Tür: string
  • Varsayılan: 'intlayer-locale'
  • Açıklama: Yerel ayarı saklamak için kullanılan çerezin adı.
  • Örnek: 'custom-locale'
  • Not: Oturumlar arasında yerel ayarın korunması için kullanılır.

• prefixDefault:

  • Tür: boolean
  • Varsayılan: false
  • Açıklama: Varsayılan yerel ayarın URL'de dahil edilip edilmeyeceği.
  • Örnek: true
  • Not:
    • Eğer true ve defaultLocale = 'en' ise: yol = /en/dashboard veya /fr/dashboard
    • Eğer false ve defaultLocale = 'en' ise: yol = /dashboard veya /fr/dashboard

• basePath:

  • Tür: string
  • Varsayılan: ''
  • Açıklama: Uygulama URL'leri için temel yol.
  • Örnek: '/my-app'
  • Not:
    • Uygulama https://example.com/my-app adresinde barındırılıyorsa
    • Temel yol '/my-app' olur
    • URL https://example.com/my-app/en olacaktır
    • Eğer base path ayarlanmazsa, URL https://example.com/en olacaktır.

• serverSetCookie:

  • Tür: string
  • Varsayılan: 'always'
  • Açıklama: Sunucuda locale çerezinin ayarlanma kuralı.
  • Seçenekler: 'always', 'never'
  • Örnek: 'never'
  • Not: Locale çerezinin her istekte mi yoksa hiç mi ayarlanacağını kontrol eder.

• noPrefix:

  • Tür: boolean
  • Varsayılan: false
  • Açıklama: URL'lerden locale önekinin çıkarılıp çıkarılmayacağı.
  • Örnek: true
  • Not:
    • Eğer true ise: URL'de önek olmaz
    • Eğer false ise: URL'de önek olur
    • basePath = '/my-app' örneği:
      • Eğer noPrefix = false ise: URL https://example.com/my-app/en olur
      • Eğer noPrefix = true ise: URL https://example.com olur

İçerik Yapılandırması

Uygulama içindeki içerik yönetimi ile ilgili ayarlar; dizin isimleri, dosya uzantıları ve türetilmiş yapılandırmalar dahil.

Özellikler

• autoFill:

  • Tür: boolean | string | { [key in Locales]?: string }
  • Varsayılan: undefined
  • Açıklama: İçeriğin yapay zeka kullanılarak otomatik olarak nasıl doldurulacağını belirtir. intlayer.config.ts dosyasında global olarak tanımlanabilir.
  • Örnek: true
  • Örnek: './{{fileName}}.content.json'
  • Örnek: { fr: './{{fileName}}.fr.content.json', es: './{{fileName}}.es.content.json' }
  • Not: Otomatik doldurma yapılandırması. Şunlar olabilir:
    • boolean: Tüm yereller için otomatik doldurmayı etkinleştirir
    • string: Değişkenler içeren tek bir dosya yolu veya şablon
    • object: Yerel bazında dosya yolları

• watch:

  • Tür: boolean
  • Varsayılan: process.env.NODE_ENV === 'development'
  • Açıklama: Intlayer'ın uygulamadaki içerik beyan dosyalarındaki değişiklikleri izleyip ilgili sözlükleri yeniden oluşturup oluşturmayacağını belirtir.

• fileExtensions:

  • Tür: string[]
  • Varsayılan: ['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']
  • Açıklama: Sözlükler oluşturulurken aranacak dosya uzantıları.
  • Örnek: ['.data.ts', '.data.js', '.data.json']
  • Not: Dosya uzantılarının özelleştirilmesi çakışmaları önlemeye yardımcı olabilir.

• baseDir:

  • Tür: string
  • Varsayılan: process.cwd()
  • Açıklama: Projenin temel dizini.
  • Örnek: '/path/to/project'
  • Not: Tüm Intlayer ile ilgili dizinlerin çözülmesinde kullanılır.

• dictionaryOutput:

  • Tür: string[]
  • Varsayılan: ['intlayer']
  • Açıklama: Kullanılacak sözlük çıktısı türü, örn. 'intlayer' veya 'i18next'.

• contentDir:

  • Tür: string[]
  • Varsayılan: ['.']
  • Örnek: ['src', '../../ui-library', require.resolve("@my-package/content")]
  • Açıklama: İçeriğin depolandığı dizin yolu.

• dictionariesDir:

  • Tür: string
  • Varsayılan: '.intlayer/dictionaries'
  • Açıklama: Ara sonuçların veya çıktıların depolanacağı dizin yolu.

• moduleAugmentationDir:

  • Tür: string
  • Varsayılan: '.intlayer/types'
  • Açıklama: Modül genişletme için dizin, daha iyi IDE önerileri ve tip kontrolü sağlar.
  • Örnek: 'intlayer-types'
  • Not: Bunu tsconfig.json dosyanıza eklediğinizden emin olun.

• unmergedDictionariesDir:

  • Tür: string
  • Varsayılan: '.intlayer/unmerged_dictionary'
  • Açıklama: Birleştirilmemiş sözlüklerin depolanacağı dizin.
  • Örnek: 'translations'

• dictionariesDir:

  • Tür: string
  • Varsayılan: '.intlayer/dictionary'
  • Açıklama: Yerelleştirme sözlüklerinin saklandığı dizin.
  • Örnek: 'translations'

• i18nextResourcesDir:

  • Tür: string
  • Varsayılan: 'i18next_dictionary'
  • Açıklama: i18n sözlüklerinin saklandığı dizin.
  • Örnek: 'translations'
  • Not: Bu dizinin i18next çıktı türü için yapılandırıldığından emin olun.

• typesDir:

  • Tür: string
  • Varsayılan: 'types'
  • Açıklama: Sözlük türlerinin saklandığı dizin.
  • Örnek: 'intlayer-types'

• mainDir:

  • Tür: string
  • Varsayılan: 'main'
  • Açıklama: Ana uygulama dosyalarının saklandığı dizin.
  • Örnek: 'intlayer-main'

• excludedPath:

  • Tür: string[]
  • Varsayılan: ['node_modules']
  • Açıklama: İçerik aramasından hariç tutulan dizinler.
  • Not: Bu ayar henüz kullanılmamaktadır, ancak gelecekte uygulanması planlanmaktadır.

Logger Yapılandırması

Logger'ı kontrol eden ayarlar, kullanılacak önek dahil.

Özellikler

• mode:

  • Tür: string
  • Varsayılan: default
  • Açıklama: Logger modunu belirtir.
  • Seçenekler: default, verbose, disabled
  • Örnek: default
  • Not: Logger modu. Verbose modu daha fazla bilgi kaydeder, ancak hata ayıklama amaçlı kullanılabilir. Disabled modu logger'ı devre dışı bırakır.

• prefix:

  • Tür: string
  • Varsayılan: '[intlayer] '
  • Açıklama: Logger'ın öneki.
  • Örnek: '[my custom prefix] '
  • Not: Günlüğün ön eki.

AI Yapılandırması

Intlayer'ın AI özelliklerini kontrol eden ayarlar, sağlayıcı, model ve API anahtarı dahil.

Bu yapılandırma, bir erişim anahtarı kullanarak Intlayer Kontrol Paneli üzerinden kayıtlıysanız isteğe bağlıdır. Intlayer, ihtiyaçlarınız için en verimli ve maliyet-etkin AI çözümünü otomatik olarak yönetecektir. Varsayılan seçenekleri kullanmak, Intlayer'ın en uygun modelleri kullanmak için sürekli güncellenmesi nedeniyle uzun vadeli bakım kolaylığı sağlar.

Kendi API anahtarınızı veya belirli bir modeli kullanmayı tercih ediyorsanız, özel AI yapılandırmanızı tanımlayabilirsiniz. Bu AI yapılandırması, Intlayer ortamınız genelinde kullanılacaktır. CLI komutları, bu ayarları komutlar için varsayılan olarak kullanacaktır (örneğin fill), ayrıca SDK, Görsel Editör ve CMS de bu ayarları kullanır. Belirli kullanım durumları için bu varsayılan değerleri komut parametreleriyle geçersiz kılabilirsiniz.

Intlayer, artırılmış esneklik ve seçenek için birden fazla AI sağlayıcısını destekler. Şu anda desteklenen sağlayıcılar şunlardır:

• OpenAI (varsayılan)
• Anthropic Claude
• Mistral AI
• DeepSeek
• Google Gemini
• Meta Llama

Özellikler

• provider:

  • Tür: string
  • Varsayılan: 'openai'
  • Açıklama: Intlayer'ın AI özellikleri için kullanılacak sağlayıcı.
  • Seçenekler: 'openai', 'anthropic', 'mistral', 'deepseek', 'gemini'
  • Örnek: 'anthropic'
  • Not: Farklı sağlayıcılar farklı API anahtarları gerektirebilir ve farklı fiyatlandırma modellerine sahip olabilir.

• model:

  • Tür: string
  • Varsayılan: Yok
  • Açıklama: Intlayer'ın yapay zeka özellikleri için kullanılacak model.
  • Örnek: 'gpt-4o-2024-11-20'
  • Not: Kullanılacak spesifik model sağlayıcıya göre değişir.

• temperature:

  • Tür: number
  • Varsayılan: Yok
  • Açıklama: Sıcaklık, yapay zekanın yanıtlarının rastgeleliğini kontrol eder.
  • Örnek: 0.1
  • Not: Daha yüksek bir sıcaklık, yapay zekayı daha yaratıcı ve daha az tahmin edilebilir yapar.

• apiKey:

  • Tür: string
  • Varsayılan: Yok
  • Açıklama: Seçilen sağlayıcı için API anahtarınız.
  • Not: Önemli: API anahtarları gizli tutulmalı ve kamuya açık şekilde paylaşılmamalıdır. Lütfen bunları ortam değişkenleri gibi güvenli bir yerde sakladığınızdan emin olun.

• applicationContext:

  • Tür: string
  • Varsayılan: Yok
  • Açıklama: AI modeline uygulamanız hakkında ek bağlam sağlar, böylece daha doğru ve bağlama uygun çeviriler oluşturmasına yardımcı olur. Bu, uygulamanızın alanı, hedef kitlesi, tonu veya belirli terminolojisi hakkında bilgiler içerebilir.

Derleme Yapılandırması

Intlayer'ın uygulamanızın uluslararasılaştırmasını nasıl optimize edip derleyeceğini kontrol eden ayarlar.

Derleme seçenekleri @intlayer/babel ve @intlayer/swc eklentilerine uygulanır.

Geliştirme modunda, Intlayer geliştirme deneyimini basitleştirmek için sözlüklerde statik importlar kullanır.

Optimize edildiğinde, Intlayer chunking'i optimize etmek için sözlük çağrılarını değiştirir, böylece nihai paket yalnızca gerçekten kullanılan sözlükleri import eder.

Özellikler

• optimize:

  • Tür: boolean
  • Varsayılan: process.env.NODE_ENV === 'production'
  • Açıklama: Derlemenin optimize edilip edilmeyeceğini kontrol eder.
  • Örnek: true
  • Not: Etkinleştirildiğinde, Intlayer chunking'i optimize etmek için tüm sözlük çağrılarını değiştirir. Böylece nihai paket yalnızca kullanılan sözlükleri import eder. Tüm importlar, sözlüklerin yüklenmesi sırasında asenkron işlemi önlemek için statik import olarak kalır.
  • Not: Intlayer, useIntlayer çağrılarının tümünü importMode seçeneği ile tanımlanan moda ve getIntlayer çağrılarını getDictionary ile değiştirir.
  • Not: Bu seçenek @intlayer/babel ve @intlayer/swc eklentilerine dayanır.
  • Not: useIntlayer çağrılarında tüm anahtarların statik olarak tanımlandığından emin olun. Örneğin useIntlayer('navbar').
• importMode:
  • Tür: 'static' | 'dynamic' | 'live'
  • Varsayılan: 'static'
  • Açıklama: Sözlüklerin nasıl içe aktarılacağını kontrol eder.
  • Örnek: 'dynamic'
  • Not: Mevcut modlar:
    • "static": Sözlükler statik olarak içe aktarılır. useIntlayer useDictionary ile değiştirilir.
    • "dynamic": Sözlükler Suspense kullanılarak dinamik olarak içe aktarılır. useIntlayer useDictionaryDynamic ile değiştirilir.
• "live": Sözlükler, canlı senkronizasyon API'si kullanılarak dinamik olarak getirilir. useIntlayer fonksiyonunu useDictionaryFetch ile değiştirir.
• Not: Dinamik importlar Suspense'e dayanır ve render performansını biraz etkileyebilir.
• Not: Devre dışı bırakılırsa, kullanılmasalar bile tüm yereller aynı anda yüklenecektir.
• Not: Bu seçenek @intlayer/babel ve @intlayer/swc eklentilerine bağlıdır.
• Not: useIntlayer çağrılarında tüm anahtarların statik olarak tanımlandığından emin olun. Örneğin useIntlayer('navbar').

• Not: optimize devre dışı bırakılırsa, bu seçenek göz ardı edilir.

  • Not: Eğer "live" olarak ayarlanırsa, yalnızca uzak içerik içeren ve "live" bayrağı olarak ayarlanmış sözlükler canlı mod olarak dönüştürülür. Diğerleri, sorgu sayısını optimize etmek ve yükleme performansını artırmak için dinamik modda dinamik olarak içe aktarılır.
  • Not: Canlı mod, sözlükleri almak için canlı senkronizasyon API'sini kullanır. API çağrısı başarısız olursa, sözlükler dinamik modda dinamik olarak içe aktarılır.
  • Not: Bu seçenek getIntlayer, getDictionary, useDictionary, useDictionaryAsync ve useDictionaryDynamic fonksiyonlarını etkilemez.

• traversePattern:

  • Tür: string[]
  • Varsayılan: ['**/*.{js,ts,mjs,cjs,jsx,tsx,mjx,cjx}', '!**/node_modules/**']
  • Açıklama: Optimizasyon sırasında hangi dosyaların taranacağını tanımlayan desenler.
    • Örnek: ['src/**/*.{ts,tsx}', '../ui-library/**/*.{ts,tsx}', '!**/node_modules/**']
  • Not: Optimizasyonu ilgili kod dosyalarıyla sınırlamak ve derleme performansını artırmak için bunu kullanın.
  • Not: Bu seçenek optimize devre dışı bırakılırsa dikkate alınmaz.
  • Not: Glob deseni kullanın.