@intlayer/docs 7.2.3 → 7.3.0-canary.0

package/docs/id/cli/test.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Uji Terjemahan yang Hilang
+description: Pelajari cara menguji dan mengidentifikasi terjemahan yang hilang dalam kamus Anda.
+keywords:
+  - Uji
+  - Terjemahan yang Hilang
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - test
+---
+
+# Uji terjemahan yang hilang
+
+```bash
+npx intlayer content test
+```
+
+## Alias:
+
+- `npx intlayer test`
+
+Perintah ini menganalisis file deklarasi konten Anda untuk mengidentifikasi terjemahan yang hilang di semua locale yang dikonfigurasi. Ini memberikan laporan komprehensif yang menunjukkan kunci terjemahan mana yang hilang untuk locale mana, membantu Anda menjaga konsistensi di seluruh konten multibahasa Anda.
+
+## Contoh output:
+
+```bash
+pnpm intlayer content test
+Missing translations:
+ - home-page                      - tr         - src/components/HomePage/homePage.content.ts
+ - server-component               - es, tr     - src/components/ServerComponent/serverComponent.content.ts
+ - client-component               - pl, tr     - src/components/ClientComponent/clientComponent.content.ts
+Locales: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Required locales: en
+Missing locales: pl, tr, es
+Missing required locales: -
+Total missing locales: 3
+Total missing required locales: 0
+```
+
+## Argumen:
+
+**Opsi konfigurasi:**
+
+- **`--env`**: Tentukan environment (misalnya, `development`, `production`).
+- **`--env-file [envFile]`**: Berikan file environment khusus untuk memuat variabel.
+- **`--base-dir`**: Tentukan direktori dasar untuk proyek.
+
+  > Contoh: `npx intlayer content test --base-dir ./src --env-file .env.production.local`
+
+- **`--no-cache`**: Nonaktifkan cache.
+
+  > Contoh: `npx intlayer build --no-cache`
+
+**Opsi persiapan:**
+
+- **`--build`**: Bangun kamus sebelum melakukan push untuk memastikan konten terbaru. True akan memaksa build, false akan melewati build, undefined akan menggunakan cache dari build.
+
+**Opsi log:**
+
+- **`--verbose`**: Aktifkan logging verbose untuk debugging. (default true saat menggunakan CLI)
+
+  > Contoh: `npx intlayer content test --verbose`
+
+## Contoh:
+
+```bash
+npx intlayer content test --verbose
+```
+
+Output membantu Anda dengan cepat mengidentifikasi terjemahan mana yang perlu diselesaikan agar aplikasi Anda berfungsi dengan baik di semua locale yang dikonfigurasi.

package/docs/id/cli/transform.md

@@ -0,0 +1,65 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Transformasi Komponen
+description: Pelajari cara mentransformasi komponen yang ada untuk menggunakan Intlayer.
+keywords:
+  - Transformasi
+  - Komponen
+  - Migrasi
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - transform
+---
+
+# Transformasi komponen
+
+```bash
+npx intlayer transform
+```
+
+Perintah ini menganalisis file kode Anda untuk membantu migrasi komponen yang ada agar menggunakan Intlayer. Mendukung pemilihan file secara interaktif atau penargetan file tertentu.
+
+## Alias:
+
+- `npx intlayer trans`
+
+## Argumen:
+
+**Opsi pemilihan file:**
+
+- **`-f, --file [files...]`**: Daftar file spesifik yang akan ditransformasi. Jika tidak diberikan, CLI akan memindai file yang cocok (`**/*.{tsx,jsx,vue,svelte,ts,js}`) dan meminta Anda memilih file mana yang akan ditransformasi.
+
+  > Contoh: `npx intlayer transform -f src/components/MyComponent.tsx`
+
+**Opsi output:**
+
+- **`-o, --output-content-declarations [outputContentDeclarations]`**: Direktori untuk menyimpan file deklarasi konten yang dihasilkan.
+
+  > Contoh: `npx intlayer transform -o src/content`
+
+- **`--code-only`**: Hanya mentransformasi kode komponen (tidak menulis deklarasi konten).
+
+  > Contoh: `npx intlayer transform --code-only`
+
+- **`--declaration-only`**: Hanya menghasilkan deklarasi konten (tidak menulis ulang komponen).
+
+  > Contoh: `npx intlayer transform --declaration-only`
+
+**Opsi konfigurasi:**
+
+- **`--base-dir`**: Menentukan direktori dasar untuk proyek.
+- **`--env`**: Menentukan environment.
+- **`--env-file`**: Menyediakan file environment khusus.
+- **`--verbose`**: Mengaktifkan logging verbose.
+
+**Plugin yang dibutuhkan:**
+
+Perintah transform bekerja tanpa plugin tambahan pada file TypeScript / JSX. Namun, perintah ini membutuhkan plugin berikut untuk diinstal pada proyek Vue dan Svelte:
+
+- **`@intlayer/vue-transformer`**: Untuk file Vue.
+- **`@intlayer/svelte-transformer`**: Untuk file Svelte.

package/docs/id/cli/version.md

@@ -0,0 +1,24 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Periksa Versi CLI
+description: Pelajari cara memeriksa versi Intlayer CLI yang terpasang.
+keywords:
+  - Versi
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - version
+---
+
+# Periksa versi CLI
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Kedua perintah tersebut menampilkan versi Intlayer CLI yang terpasang.

package/docs/id/cli/watch.md

@@ -0,0 +1,37 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Pantau Kamus
+description: Pelajari cara memantau perubahan pada file deklarasi konten Anda dan secara otomatis membangun kamus.
+keywords:
+  - Pantau
+  - Kamus
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Pantau Kamus
+
+```bash
+npx intlayer watch
+```
+
+Perintah ini akan memantau perubahan pada file deklarasi konten Anda dan membangun kamus di direktori `.intlayer`.
+Perintah ini setara dengan `npx intlayer build --watch --skip-prepare`.
+
+## Alias:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Argumen:
+
+- **`--with`**: Mulai perintah secara paralel dengan pemantauan.
+
+> Contoh: `npx intlayer watch --with "next dev --turbopack"`

package/docs/id/packages/intlayer/getPrefix.md

@@ -0,0 +1,210 @@
+---
+createdAt: 2025-11-16
+updatedAt: 2025-11-16
+title: Dokumentasi Fungsi getPrefix | intlayer
+description: Lihat cara menggunakan fungsi getPrefix untuk paket intlayer
+keywords:
+  - getPrefix
+  - prefix
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPrefix
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Dokumentasi awal
+---
+
+# Dokumentasi: Fungsi `getPrefix` dalam `intlayer`
+
+## Deskripsi
+
+Fungsi `getPrefix` menentukan prefix URL untuk locale tertentu berdasarkan konfigurasi mode routing. Fungsi ini membandingkan locale dengan default locale dan mengembalikan sebuah objek yang berisi tiga format prefix berbeda untuk konstruksi URL yang fleksibel.
+
+**Fitur Utama:**
+
+- Menerima locale sebagai parameter pertama (wajib)
+- Objek `options` opsional dengan `defaultLocale` dan `mode`
+- Mengembalikan objek dengan properti `prefix` dan `localePrefix`
+- Mendukung semua mode routing: `prefix-no-default`, `prefix-all`, `no-prefix`, dan `search-params`
+- Utilitas ringan untuk menentukan kapan menambahkan prefix locale
+
+---
+
+## Tanda Tangan Fungsi
+
+```typescript
+getPrefix(
+  locale: Locales,               // Wajib
+  options?: {                    // Opsional
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): GetPrefixResult
+
+type GetPrefixResult = {
+  prefix: string;   // misalnya, 'fr/' atau ''
+  localePrefix?: Locale; // misalnya, 'fr' atau undefined
+}
+```
+
+---
+
+## Parameter
+
+- `locale: Locales`
+  - **Deskripsi**: Locale yang akan digunakan untuk menghasilkan prefix. Jika nilainya falsy (undefined, null, string kosong), fungsi akan mengembalikan string kosong.
+  - **Tipe**: `Locales`
+  - **Wajib**: Ya
+
+- `options?: object`
+  - **Deskripsi**: Objek konfigurasi untuk penentuan prefix.
+  - **Tipe**: `object`
+  - **Wajib**: Tidak (Opsional)
+
+  - `options.defaultLocale?: Locales`
+    - **Deskripsi**: Locale default untuk aplikasi. Jika tidak disediakan, menggunakan locale default yang dikonfigurasi dari konfigurasi proyek Anda.
+    - **Tipe**: `Locales`
+    - **Default**: [`Konfigurasi Proyek`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Deskripsi**: Mode routing URL untuk penanganan locale. Jika tidak disediakan, menggunakan mode yang dikonfigurasi dari konfigurasi proyek Anda.
+    - **Tipe**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Default**: [`Konfigurasi Proyek`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/configuration.md#middleware)
+    - **Mode**:
+      - `prefix-no-default`: Mengembalikan string kosong ketika locale sama dengan locale default
+      - `prefix-all`: Mengembalikan prefix untuk semua locale termasuk default
+      - `no-prefix`: Mengembalikan string kosong (tanpa prefix di URL)
+      - `search-params`: Mengembalikan string kosong (locale dalam parameter query)
+
+### Mengembalikan
+
+- **Tipe**: `GetPrefixResult`
+- **Deskripsi**: Objek yang berisi tiga format prefix yang berbeda:
+  - `prefix`: Prefix path dengan slash di akhir (misalnya, `'fr/'`, `''`)
+  - `localePrefix`: Identifier locale tanpa slash (misalnya, `'fr'`, `undefined`)
+
+---
+
+## Contoh Penggunaan
+
+### Penggunaan Dasar
+
+```typescript codeFormat="typescript"
+import { getPrefix, Locales } from "intlayer";
+
+// Periksa prefix untuk locale Bahasa Inggris
+getPrefix(Locales.ENGLISH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Mengembalikan: { prefix: 'en/', localePrefix: 'en' }
+
+// Periksa prefix untuk locale Bahasa Perancis
+getPrefix(Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Mengembalikan: { prefix: 'fr/', localePrefix: 'fr' }
+```
+
+```javascript codeFormat="esm"
+import { getPrefix, Locales } from "intlayer";
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+javascript codeFormat="commonjs"
+const { getPrefix, Locales } = require("intlayer");
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Mengembalikan: { prefix: '', localePrefix: undefined }
+```
+
+### Mode Routing Berbeda
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// prefix-all: Selalu mengembalikan prefix
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-all",
+  defaultLocale: Locales.ENGLISH,
+});
+// Mengembalikan: { prefix: '/en', localePrefix: 'en' }
+
+// prefix-no-default: Tidak ada prefix saat locale sama dengan default
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Mengembalikan: { prefix: '', localePrefix: undefined }
+
+// prefix-no-default: Mengembalikan prefix saat locale berbeda dari default
+getPrefix(Locales.FRENCH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Mengembalikan: { prefix: 'fr/', localePrefix: 'fr' }
+
+// no-prefix & search-params: Tidak pernah mengembalikan prefix
+getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
+// Mengembalikan: { prefix: '', localePrefix: undefined }
+
+getPrefix(Locales.ENGLISH, { mode: "search-params" });
+// Mengembalikan: { prefix: '', localePrefix: undefined }
+```
+
+### Contoh Praktis
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// Membangun URL dengan prefix yang sesuai untuk locale tertentu
+const locale = Locales.FRENCH;
+const { prefix, localePrefix } = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+
+// Menggunakan prefix untuk konstruksi path
+const url1 = `/${prefix}about`.replace(/\/+/g, "/");
+// Hasil: "/fr/about"
+
+// Menggunakan localePrefix untuk identifikasi locale
+console.log(`Current locale: ${localePrefix}`);
+// Output: "Current locale: fr"
+```
+
+---
+
+## Fungsi Terkait
+
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/packages/intlayer/getLocalizedUrl.md): Menghasilkan URL yang dilokalkan untuk locale tertentu
+- [`getMultilingualUrls`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/packages/intlayer/getMultilingualUrls.md): Menghasilkan URL untuk semua locale yang dikonfigurasi
+
+---
+
+## TypeScript
+
+```typescript
+type GetPrefixResult = {
+  prefix: string; // Prefix path dengan slash di akhir (misal, 'fr/' atau '')
+  localePrefix?: Locale; // Identifier locale tanpa garis miring (misalnya, 'fr' atau undefined)
+};
+
+function getPrefix(
+  locale: Locales,
+  options?: {
+    defaultLocale?: Locales;
+    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
+  }
+): GetPrefixResult;
+```

package/docs/it/cli/build.md

@@ -0,0 +1,64 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Costruire Dizionari
+description: Impara come costruire i tuoi dizionari Intlayer dai file di dichiarazione dei contenuti.
+keywords:
+  - Costruire
+  - Dizionari
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - build
+---
+
+# Costruire Dizionari
+
+Per costruire i tuoi dizionari, puoi eseguire i comandi:
+
+```bash
+npx intlayer build
+```
+
+oppure in modalità watch
+
+```bash
+npx intlayer build --watch
+```
+
+Questo comando troverà i tuoi file di dichiarazione dei contenuti di default in `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}`. E costruirà i dizionari nella directory `.intlayer`.
+
+## Alias:
+
+- `npx intlayer dictionaries build`
+- `npx intlayer dictionary build`
+- `npx intlayer dic build`
+
+## Argomenti:
+
+- **`--base-dir`**: Specifica la directory base per il progetto. Per recuperare la configurazione di intlayer, il comando cercherà il file `intlayer.config.{ts,js,json,cjs,mjs}` nella directory base.
+
+  > Esempio: `npx intlayer build --base-dir ./src`
+
+- **`--env`**: Specifica l'ambiente (ad esempio, `development`, `production`). Utile nel caso in cui si utilizzino variabili d'ambiente nel file di configurazione di intlayer.
+
+  > Esempio: `npx intlayer build --env production`
+
+- **`--env-file`**: Fornisce un file di ambiente personalizzato da cui caricare le variabili. Utile nel caso in cui si utilizzino variabili d'ambiente nel file di configurazione di intlayer.
+
+  > Esempio: `npx intlayer build --env-file .env.production.local`
+
+- **`--with`**: Avvia un comando in parallelo con la build.
+
+  > Esempio: `npx intlayer build --with "next dev --turbopack"`
+
+- **`--skip-prepare`**: Salta il passaggio di preparazione.
+
+  > Esempio: `npx intlayer build --skip-prepare`
+
+- **`--no-cache`**: Disabilita la cache.
+
+  > Esempio: `npx intlayer build --no-cache`

package/docs/it/cli/configuration.md

@@ -0,0 +1,63 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Gestire la Configurazione
+description: Scopri come ottenere e inviare la tua configurazione Intlayer al CMS.
+keywords:
+  - Configurazione
+  - Config
+  - CLI
+  - Intlayer
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - configuration
+---
+
+# Gestire la Configurazione
+
+## Ottenere la Configurazione
+
+Il comando `configuration get` recupera la configurazione corrente di Intlayer, in particolare le impostazioni della locale. Questo è utile per verificare la tua configurazione.
+
+```bash
+npx intlayer configuration get
+```
+
+## Alias:
+
+- `npx intlayer config get`
+- `npx intlayer conf get`
+
+## Argomenti:
+
+- **`--env`**: Specifica l'ambiente (es. `development`, `production`).
+- **`--env-file`**: Fornisci un file ambiente personalizzato da cui caricare le variabili.
+- **`--base-dir`**: Specifica la directory base per il progetto.
+- **`--verbose`**: Abilita il logging dettagliato per il debug. (impostato di default su true tramite CLI)
+- **`--no-cache`**: Disabilita la cache.
+
+## Inviare la Configurazione
+
+Il comando `configuration push` carica la tua configurazione nel CMS e nell'editor di Intlayer. Questo passaggio è necessario per abilitare l'uso di dizionari remoti nell'Intlayer Visual Editor.
+
+```bash
+npx intlayer configuration push
+```
+
+## Alias:
+
+- `npx intlayer config push`
+- `npx intlayer conf push`
+
+## Argomenti:
+
+- **`--env`**: Specifica l'ambiente (es. `development`, `production`).
+- **`--env-file`**: Fornisci un file ambiente personalizzato da cui caricare le variabili.
+- **`--base-dir`**: Specifica la directory base per il progetto.
+- **`--verbose`**: Abilita il logging dettagliato per il debug. (impostato di default su true tramite CLI)
+- **`--no-cache`**: Disabilita la cache.
+
+Spingendo la configurazione, il tuo progetto è completamente integrato con il CMS di Intlayer, permettendo una gestione fluida dei dizionari tra i team.

package/docs/it/cli/debug.md

@@ -0,0 +1,46 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Debug del comando Intlayer
+description: Scopri come eseguire il debug e risolvere i problemi della CLI di Intlayer.
+keywords:
+  - Debug
+  - Risoluzione problemi
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - debug
+---
+
+# Debug del comando intlayer
+
+## 1. **Assicurati di utilizzare l'ultima versione**
+
+Esegui:
+
+```bash
+npx intlayer --version                  # versione locale corrente di intlayer
+npx intlayer@latest --version           # versione più recente disponibile di intlayer
+```
+
+## 2. **Verifica se il comando è registrato**
+
+Puoi verificare con:
+
+```bash
+npx intlayer --help                     # Mostra la lista dei comandi disponibili e le informazioni sull'uso
+npx intlayer dictionary build --help    # Mostra la lista delle opzioni disponibili per un comando
+```
+
+## 3. **Riavvia il terminale**
+
+A volte è necessario riavviare il terminale per riconoscere nuovi comandi.
+
+## 4. **Pulisci la cache di npx (se sei bloccato su una versione più vecchia)**
+
+```bash
+npx clear-npx-cache
+```

package/docs/it/cli/doc-review.md

@@ -0,0 +1,43 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Revisione Documento
+description: Scopri come revisionare i file di documentazione per qualità, coerenza e completezza tra diverse localizzazioni.
+keywords:
+  - Revisione
+  - Documento
+  - Documentazione
+  - AI
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-review
+---
+
+# Revisione Documento
+
+Il comando `doc review` analizza i file di documentazione per qualità, coerenza e completezza tra diverse localizzazioni.
+
+```bash
+npx intlayer doc review
+```
+
+Può essere utilizzato per revisionare file già tradotti e per verificare se la traduzione è corretta.
+
+Per la maggior parte dei casi d'uso,
+
+- preferisci usare `doc translate` quando la versione tradotta di questo file non è disponibile.
+- preferisci usare `doc review` quando la versione tradotta di questo file esiste già.
+
+> Nota che il processo di revisione consuma più token di input rispetto al processo di traduzione per revisionare completamente lo stesso file. Tuttavia, il processo di revisione ottimizzerà i chunk da revisionare e salterà le parti che non sono state modificate.
+
+## Argomenti:
+
+Il comando `doc review` accetta gli stessi argomenti di `doc translate`, permettendoti di revisionare file di documentazione specifici e applicare controlli di qualità.
+
+Se hai attivato una delle opzioni git, il comando revisionerà solo la parte dei file che viene modificata. Lo script processerà il file suddividendolo in chunk e revisionerà ogni chunk. Se non ci sono modifiche nel chunk, lo script lo salterà per velocizzare il processo di revisione e limitare il costo dell'API del provider AI.
+
+Per un elenco completo degli argomenti, consulta la documentazione del comando [Translate Document](https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/cli/doc-translate.md).