@intlayer/docs 8.12.4 → 9.0.0-canary.10

package/docs/pl/plugins/sync-json.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-03-13
-updatedAt: 2025-12-13
+updatedAt: 2026-06-21
 title: Wtyczka Sync JSON
 description: Synchronizuj słowniki Intlayer z zewnętrznymi plikami JSON i18n (i18next, next-intl, react-intl, vue-i18n i inne). Zachowaj istniejące i18n, korzystając z Intlayer do zarządzania, tłumaczenia i testowania swoich komunikatów.
 keywords:
@@ -24,9 +24,13 @@ slugs:
   - sync-json
 youtubeVideo: https://www.youtube.com/watch?v=MpGMxniDHNg
 history:
+  - version: 9.0.0
+    date: 2026-06-21
+    changes: "Dodano opcję splitKeys (jeden słownik na klucz przestrzeni nazw najwyższego poziomu) dla układów jednoplikowych next-intl / react-intl"
   - version: 6.1.6
     date: 2025-10-05
     changes: "Pierwsza dokumentacja wtyczki Sync JSON"
+author: aymericzip
 ---
 
 # Sync JSON (mosty i18n) - Sync JSON z obsługą ICU / i18next
@@ -58,9 +62,64 @@ pnpm add -D @intlayer/sync-json-plugin
 npm i -D @intlayer/sync-json-plugin
 ```
 
-## Szybki start
+## Plugins
 
-Dodaj wtyczkę do swojego pliku `intlayer.config.ts` i wskaż ją na istniejącą strukturę JSON.
+This package provides two plugins:
+
+- `loadJSON`: Load JSON files into Intlayer dictionaries.
+  - This plugin is used to load JSON files from a source and will be loaded into Intlayer dictionaries. It can scan all the codebase and search for specific JSON files.
+    This plugin can be used
+    - if you use an i18n library that impose a specific location for your JSON to be loaded (ex: `next-intl`, `i18next`, `react-intl`, `vue-i18n`, etc.), but you want to place your content declaration where you want in your code base.
+    - It can also be used if you want to fetch your messages from a remote source (ex: a CMS, a API, etc.) and store your messages in JSON files.
+
+  > Under the hood, this plugin will scan all the codebase and search for specific JSON files and load them into Intlayer dictionaries.
+  > Note that this plugin will not write the output and translations back to the JSON files.
+
+- `syncJSON`: Synchronize JSON files with Intlayer dictionaries.
+  - This plugin is used to synchronize JSON files with Intlayer dictionaries. It can scan the given location and load the JSON that match the pattern for specific JSON files. This plugin is useful if you want to get the benefits of Intlayer while using another i18n library.
+
+## Using both plugins
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+import { loadJSON, syncJSON } from "@intlayer/sync-json-plugin";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+
+  // Keep your current JSON files in sync with Intlayer dictionaries
+  plugins: [
+    /**
+     * Will load all the JSON files in the src that match the pattern {key}.i18n json
+     */
+    loadJSON({
+      source: ({ key }) => `./src/**/${key}.i18n.json`,
+      locale: Locales.ENGLISH,
+      priority: 1, // Ensures these JSON files take precedence over files at `./locales/en/${key}.json`
+      format: "intlayer", // Format of the JSON content
+    }),
+    /**
+     * Will load, and write the output and translations back to the JSON files in the locales directory
+     */
+    syncJSON({
+      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,
+      priority: 0,
+      format: "i18next",
+    }),
+  ],
+};
+
+export default config;
+```
+
+## `syncJSON` plugin
+
+### Quick start
+
+Add the plugin to your `intlayer.config.ts` and point it at your existing JSON structure.
 
 ```ts fileName="intlayer.config.ts"
 import { Locales, type IntlayerConfig } from "intlayer";
@@ -77,6 +136,7 @@ const config: IntlayerConfig = {
     syncJSON({
       // Układ per-locale, per-namespace (np. next-intl, i18next z przestrzeniami nazw)
       source: ({ key, locale }) => `./locales/${locale}/${key}.json`,
+      format: "icu",
     }),
   ],
 };
@@ -87,14 +147,27 @@ export default config;
 Alternatywa: pojedynczy plik na locale (częste w konfiguracjach i18next/react-intl):
 
 ```ts fileName="intlayer.config.ts"
-plugins: [
-  syncJSON({
-    source: ({ locale }) => `./locales/${locale}.json`,
-  }),
-];
+import { Locales, type IntlayerConfig } from "intlayer";
+import { syncJSON } from "@intlayer/sync-json-plugin";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH],
+    defaultLocale: Locales.ENGLISH,
+  },
+  plugins: [
+    syncJSON({
+      format: "i18next",
+      source: ({ locale }) => `./locales/${locale}.json`,
+      format: "i18next",
+    }),
+  ],
+};
+
+export default config;
 ```
 
-### Jak to działa
+#### How it works
 
 - Odczyt: wtyczka wykrywa pliki JSON zdefiniowane przez twój builder `source` i ładuje je jako słowniki Intlayer.
 - Zapis: po budowaniu i wypełnianiu, zapisuje zlokalizowane pliki JSON z powrotem pod te same ścieżki (z końcowym znakiem nowej linii, aby uniknąć problemów z formatowaniem).
@@ -108,6 +181,7 @@ syncJSON({
   location?: string, // opcjonalna etykieta, domyślnie: "plugin"
   priority?: number, // opcjonalny priorytet do rozstrzygania konfliktów, domyślnie: 0
   format?: 'intlayer' | 'icu' | 'i18next', // opcjonalny formatator, używany dla kompatybilności z runtime Intlayer
+  splitKeys?: boolean, // opcjonalnie, dzieli pojedynczy plik na jeden słownik na klucz przestrzeni nazw najwyższego poziomu (automatycznie wykrywane)
 });
 ```
 
@@ -132,11 +206,43 @@ syncJSON({
 }),
 ```
 
-## Wiele źródeł JSON i priorytet
+#### `splitKeys` (boolean)
+
+Kontroluje, czy pojedynczy plik JSON, którego **klucze pierwszego poziomu są przestrzeniami nazw**, powinien stać się jednym słownikiem na klucz najwyższego poziomu, zamiast pojedynczego słownika zawierającego cały plik.
+
+Odpowiada to modelowi przestrzeni nazw bibliotek takich jak `next-intl` i `react-intl`, gdzie jeden plik `messages/{locale}.json` grupuje kilka przestrzeni nazw według kluczy pierwszego poziomu, z których każda jest adresowana niezależnie (np. `useTranslations('Hero')` rozwiązuje się do słownika `Hero`).
+
+- `undefined` (domyślnie): **automatycznie wykrywane** — plik jest dzielony, gdy wzorzec `source` nie zawiera segmentu `{key}` (jeden plik zawiera każdą przestrzeń nazw), i zachowywany jako pojedynczy słownik w przeciwnym razie (jeden plik na klucz).
+- `true`: zawsze dzieli każdy klucz najwyższego poziomu na własny słownik.
+- `false`: nigdy nie dzieli; cały plik staje się pojedynczym słownikiem.
+
+Biorąc pod uwagę pojedynczy plik `messages/{locale}.json`:
+
+```json fileName="messages/en.json"
+{
+  "Hero": { "title": "Full-stack developer" },
+  "Nav": { "work": "Work", "about": "About" },
+  "About": { "lead": "I build apps end to end." }
+}
+```
+
+```ts fileName="intlayer.config.ts"
+syncJSON({
+  format: "icu",
+  source: ({ locale }) => `./messages/${locale}.json`,
+  // splitKeys: true, // domyślne, ponieważ wzorzec nie zawiera segmentu `{key}`
+}),
+```
+
+Tworzy to trzy słowniki — `Hero`, `Nav` i `About` — dzięki czemu `useTranslations('Hero')` (next-intl) rozwiązuje się poprawnie. Podczas zapisu zwrotnego wszystkie przestrzenie nazw są ponownie składane w ten sam plik dla danej lokalizacji.
 
-Możesz dodać wiele wtyczek `syncJSON`, aby synchronizować różne źródła JSON. Jest to przydatne, gdy masz wiele bibliotek i18n lub różne struktury JSON w swoim projekcie.
+> Kiedy zachowujesz jawny segment `{key}` w swoim `source` (np. `./locales/${locale}/${key}.json`), każdy plik jest już jedną przestrzenią nazw, więc dzielenie jest domyślnie wyłączone.
 
-### System priorytetów
+### Multiple JSON sources and priority
+
+You can add multiple `syncJSON` plugins to synchronize different JSON sources. This is useful when you have multiple i18n libraries or different JSON structures in your project.
+
+#### System priorytetów
 
 Gdy wiele wtyczek celuje w ten sam klucz słownika, parametr `priority` decyduje, która wtyczka ma pierwszeństwo:
 
@@ -185,73 +291,140 @@ const config: IntlayerConfig = {
 export default config;
 ```
 
-### Rozwiązywanie konfliktów
+## Load JSON plugin
 
-Gdy ten sam klucz tłumaczenia występuje w wielu źródłach JSON:
+### Quick start
 
-1. Wtyczka o najwyższym priorytecie decyduje o ostatecznej wartości
-2. Źródła o niższym priorytecie są używane jako zapasowe dla brakujących kluczy
-3. Pozwala to na utrzymanie tłumaczeń dziedziczonych podczas stopniowej migracji do nowych struktur
+Add the plugin to your `intlayer.config.ts` to ingest existing JSON files as Intlayer dictionaries. This plugin is read‑only (no writes to disk):
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+import { loadJSON } from "@intlayer/sync-json-plugin";
 
-## Integracje
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
 
-Poniżej znajdują się typowe mapowania. Zachowaj swój runtime bez zmian; dodaj tylko wtyczkę.
+  plugins: [
+    // Ingest JSON messages located anywhere in your source tree
+    loadJSON({
+      source: ({ key }) => `./src/**/${key}.i18n.json`,
+      // Load a single locale per plugin instance (defaults to the config defaultLocale)
+      locale: Locales.ENGLISH,
+      priority: 0,
+    }),
+  ],
+};
 
-### i18next
+export default config;
+```
 
-Typowy układ plików: `./public/locales/{locale}/{namespace}.json` lub `./locales/{locale}/{namespace}.json`.
+Alternative: per‑locale layout, still read‑only (only the selected locale is loaded):
 
 ```ts fileName="intlayer.config.ts"
-import { syncJSON } from "@intlayer/sync-json-plugin";
+import { Locales, type IntlayerConfig } from "intlayer";
+import { loadJSON } from "@intlayer/sync-json-plugin";
 
-export default {
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH],
+    defaultLocale: Locales.ENGLISH,
+  },
   plugins: [
-    syncJSON({
-      format: "i18next",
+    loadJSON({
+      // Only files for Locales.FRENCH will be loaded from this pattern
       source: ({ key, locale }) => `./locales/${locale}/${key}.json`,
+      locale: Locales.FRENCH,
     }),
   ],
 };
+
+export default config;
 ```
 
-### next-intl
+### How it works
 
-Wiadomości JSON na locale (często `./messages/{locale}.json`) lub na namespace.
+- Discover: builds a glob from your `source` builder and collects matching JSON files.
+- Ingest: loads each JSON file as an Intlayer dictionary with the provided `locale`.
+- Read‑only: does not write or format output files; use `syncJSON` if you need round‑trip sync.
+- Auto‑fill ready: defines a `fill` pattern so `intlayer content fill` can populate missing keys.
 
-```ts fileName="intlayer.config.ts"
-plugins: [
-  syncJSON({
-    source: ({ locale, key }) => `./messages/${locale}/${key}.json`,
-  }),
-];
+### API
+
+```ts
+loadJSON({
+  // Build paths to your JSON. `locale` is optional if your structure has no locale segment
+  source: ({ key, locale }) => string,
+
+  // Target locale for the dictionaries loaded by this plugin instance
+  // Defaults to configuration.internationalization.defaultLocale
+  locale?: Locale,
+
+  // Optional label to identify the source
+  location?: string, // default: "plugin"
+
+  // Priority used for conflict resolution against other sources
+  priority?: number, // default: 0
+
+  // Optional formatter for the JSON content
+  format?: 'intlayer' | 'icu' | 'i18next', // default: 'intlayer'
+
+  // Split a single file into one dictionary per top-level key (auto-detected)
+  splitKeys?: boolean,
+});
 ```
 
-Zobacz także: `docs/pl/intlayer_with_next-intl.md`.
+#### `format` ('intlayer' | 'icu' | 'i18next')
 
-### react-intl
+Specifies the formatter to use for the dictionary content when loading JSON files. This allows using different message formatting syntaxes compatible with various i18n libraries.
 
-Pojedynczy JSON na locale jest powszechny:
+- `'intlayer'`: The default Intlayer formatter (default).
+- `'icu'`: Uses ICU message formatting (compatible with libraries like react-intl, vue-i18n).
+- `'i18next'`: Uses i18next message formatting (compatible with i18next, next-i18next, Solid-i18next).
 
-```ts fileName="intlayer.config.ts"
-plugins: [
-  syncJSON({
-    source: ({ locale }) => `./locales/${locale}.json`,
-  }),
-];
+**Example:**
+
+```ts
+loadJSON({
+  source: ({ key }) => `./src/**/${key}.i18n.json`,
+  locale: Locales.ENGLISH,
+  format: "icu", // Use ICU formatting for compatibility
+}),
 ```
 
-### vue-i18n
+#### `splitKeys` (boolean)
 
-Może to być pojedynczy plik na locale lub na namespace:
+Takie samo zachowanie jak w [`syncJSON`](#splitkeys-boolean): gdy pojedynczy plik JSON grupuje kilka przestrzeni nazw według kluczy pierwszego poziomu, każdy klucz najwyższego poziomu staje się własnym słownikiem.
 
-```ts fileName="intlayer.config.ts"
-plugins: [
-  syncJSON({
-    source: ({ key, locale }) => `./src/locales/${locale}/${key}.json`,
-  }),
-];
+- `undefined` (domyślnie): **automatycznie wykrywane** — dzieli, gdy wzorzec `source` nie zawiera segmentu `{key}`, w przeciwnym razie pojedynczy słownik.
+- `true` / `false`: wymusza lub wyłącza dzielenie.
+
+```ts
+loadJSON({
+  source: ({ locale }) => `./messages/${locale}.json`,
+  format: "icu",
+  // splitKeys auto-enabled: `Hero`, `Nav`, `About`, … each become a dictionary
+}),
 ```
 
+### Behavior and conventions
+
+- If your `source` mask includes a locale placeholder, only files for the selected `locale` are ingested.
+- Jeśli w masce nie ma segmentu `{key}`, każdy klucz najwyższego poziomu pliku staje się domyślnie własnym słownikiem (zobacz [`splitKeys`](#splitkeys-boolean)). Ustaw `splitKeys: false`, aby zamiast tego załadować cały plik jako pojedynczy słownik indeksowy.
+- Keys are derived from file paths by substituting the `{key}` placeholder in your `source` builder.
+- The plugin only uses discovered files and does not fabricate missing locales or keys.
+- The `fill` path is inferred from your `source` and used to update missing values via CLI when you opt‑in.
+
+## Conflict resolution
+
+When the same translation key exists in multiple JSON sources:
+
+1. Wtyczka o najwyższym priorytecie decyduje o ostatecznej wartości
+2. Źródła o niższym priorytecie są używane jako zapasowe dla brakujących kluczy
+3. Pozwala to na utrzymanie tłumaczeń dziedziczonych podczas stopniowej migracji do nowych struktur
+
 ## CLI
 
 Synchronizowane pliki JSON będą traktowane jak inne pliki `.content`. Oznacza to, że wszystkie polecenia intlayer będą dostępne dla synchronizowanych plików JSON. W tym:

package/docs/pl/plugins/sync-po.md

@@ -18,6 +18,7 @@ history:
   - version: 8.9.4
     date: 2026-05-10
     changes: "Początkowa dokumentacja pluginu Sync PO"
+author: aymericzip
 ---
 
 # Sync PO (mosty i18n) - Sync PO ze wsparciem ICU / i18next

package/docs/pl/releases/v6.md

@@ -18,12 +18,17 @@ slugs:
   - doc
   - releases
   - v6
+author: aymericzip
 ---
 
 # Nowy Intlayer v6 - Co nowego?
 
 Witamy w Intlayer v6! Ta wersja skupia się na wydajności, doświadczeniu deweloperskim oraz niezawodności. Poniżej znajdują się najważniejsze zmiany wraz z notatkami migracyjnymi i przykładami do kopiowania.
 
+## Spis treści
+
+<TOC levels={[2]} maxDepth={1} />
+
 ## Najważniejsze zmiany
 
 - Nowa komenda: `npx intlayer content test` do wykrywania brakujących tłumaczeń

package/docs/pl/releases/v7.md

@@ -18,12 +18,17 @@ slugs:
   - doc
   - releases
   - v7
+author: aymericzip
 ---
 
 # Nowy Intlayer v7 - Co nowego?
 
 Witamy w Intlayer v7! To duże wydanie wprowadza znaczące ulepszenia w wydajności, bezpieczeństwie typów oraz doświadczeniu deweloperskim. Poniżej znajdują się najważniejsze zmiany, wraz z notatkami migracyjnymi i praktycznymi przykładami.
 
+## Spis treści
+
+<TOC levels={[2]} maxDepth={1} />
+
 ## Najważniejsze zmiany
 
 - Strategia buforowania dla szybszych kompilacji
@@ -259,6 +264,126 @@ Skutkuje to szybszym czasem pobierania i lepszą wydajnością działania Twojej
 
 ---
 
+## Automatyczne formatowanie kodu: konfiguracja formatCommand
+
+v7 wprowadza opcję `formatCommand` w konfiguracji edytora, pozwalającą na automatyczne formatowanie plików zawartości podczas ich zapisywania przez Intlayer. Zapewnia to spójny styl kodu i formatowanie we wszystkich plikach deklaracji zawartości.
+
+Jeśli nie jest ustawiony, Intlayer spróbuje automatycznie wykryć polecenie formatowania. Próbując rozwiązać następujące polecenia: prettier, biome, eslint.
+
+### Konfiguracja
+
+Opcja `formatCommand` akceptuje szablon ciągu znaków, w którym `{{file}}` zostanie zastąpiony rzeczywistą ścieżką pliku:
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    formatCommand: 'bun x biome format "{{file}}" --write --log-level none',
+  },
+};
+```
+
+### Obsługiwane formatory
+
+Możesz używać dowolnego formatera kodu, który akceptuje ścieżki plików jako argumenty:
+
+**Używając Biome:**
+
+```typescript
+formatCommand: 'bun x biome format "{{file}}" --write --log-level none';
+```
+
+**Używając Prettier:**
+
+```typescript
+formatCommand: 'npx prettier --write "{{file}}" --log-level silent';
+```
+
+**Używając ESLint:**
+
+```typescript
+formatCommand: 'npx eslint --fix "{{file}}" --quiet';
+```
+
+**Używając wbudowanego formatera Bun:**
+
+```typescript
+formatCommand: 'bun format "{{file}}"';
+```
+
+### Korzyści
+
+- **Spójne formatowanie**: Wszystkie pliki zawartości są automatycznie formatowane zgodnie z wytycznymi stylu Twojego projektu
+- **Doświadczenie deweloperskie**: Nie ma potrzeby ręcznego formatowania plików po ich wygenerowaniu przez Intlayer
+- **Spójność zespołu**: Zapewnia, że wszyscy członkowie zespołu mają zastosowane to samo formatowanie do plików zawartości
+- **Integracja CI/CD**: Pliki zawartości zachowują spójne formatowanie w zautomatyzowanych przepływach pracy
+
+### Jak to działa
+
+Gdy Intlayer zapisuje lub aktualizuje plik deklaracji zawartości (`.content.ts`, `.content.js`, itp.), automatycznie uruchamia określone polecenie formatowania na pliku. Symbol zastępczy `{{file}}` jest zastępowany rzeczywistą ścieżką pliku, a polecenie jest wykonywane w katalogu bazowym projektu.
+
+---
+
+## Konfiguracja Dictionary: Lepsza organizacja i struktura
+
+v7 wprowadza nową dedykowaną sekcję konfiguracji `dictionary`, która zapewnia lepszą organizację ustawień związanych ze słownikiem i ulepszone zarządzanie zawartością.
+
+### Nowa struktura konfiguracji słownika
+
+Właściwość `fill` została przeniesiona z sekcji `content` do nowej sekcji `dictionary`, zapewniając wyraźniejsze rozdzielenie odpowiedzialności:
+
+**Konfiguracja v6:**
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    autoFill: "./{{fileName}}.content.json",
+    contentDir: ["src"],
+  },
+};
+```
+
+**Konfiguracja v7:**
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    contentDir: ["src"],
+  },
+  dictionary: {
+    fill: "./{{fileName}}.content.json",
+  },
+};
+```
+
+### Korzyści nowej struktury
+
+- **Wyraźniejsza organizacja**: Ustawienia specyficzne dla słownika są teraz pogrupowane
+- **Lepsza separacja obaw**: Odkrywanie zawartości a operacje na słowniku są wyraźnie rozdzielone
+- **Ulepszona łatwość utrzymania**: Łatwiej zrozumieć i modyfikować konfiguracje związane ze słownikami
+- **Przyszła rozszerzalność**: Sekcja słownika może zawierać dodatkowe ustawienia specyficzne dla słownika
+- **Kompleksowe zarządzanie słownikami**: Obejmuje właściwości takie jak `title`, `live`, `priority`, `tags`, `version` i `description` do tworzenia i zarządzania nowymi słownikami
+
+### Użycie konfiguracji
+
+Konfiguracja słownika służy dwóm głównym celom:
+
+1. **Wartości domyślne**: Definiowanie wartości domyślnych podczas tworzenia plików deklaracji treści
+2. **Zachowanie fallbacku**: Dostarczanie wartości fallbacku, gdy określone pola nie są zdefiniowane, umożliwiając globalną definicję zachowania operacji słownika
+
+Sekcja słownika zawiera kompleksowe właściwości do zarządzania słownikiem:
+
+- **`fill`**: Zachowanie auto-fill dla generowania treści
+- **`title`**: Domyślny tytuł dla nowych słowników
+- **`live`**: Konfiguracja live sync dla aktualizacji w czasie rzeczywistym
+- **`priority`**: Ustawienia priorytetu dla rozdzielczości słownika
+- **`tags`**: Domyślne tagi do organizacji treści
+- **`version`**: Zarządzanie wersjami dla aktualizacji słownika
+- **`description`**: Domyślny opis dla nowej treści
+
+Aby uzyskać więcej informacji o plikach deklaracji treści i sposobie zastosowania wartości konfiguracji, zobacz [Dokumentację pliku treści](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pl/dictionary/content_file.md).
+
+---
+
 ## Komenda fill: Zaktualizowane zachowanie dla lepszego zarządzania treścią
 
 Wersja 7 wprowadza ulepszone zachowanie komendy `fill`, zapewniając bardziej przewidywalne i elastyczne zarządzanie treścią:
@@ -406,6 +531,10 @@ System automatycznie:
 - **`middleware.prefixDefault`**: Zastąpione przez `routing.mode`
 - **`middleware.noPrefix`**: Zastąpione przez `routing.mode`
 
+### Nowe konfiguracje
+
+- **`editor.formatCommand`**: Nowa opcja do automatycznego formatowania kodu plików zawartości
+
 ### Mapowanie migracji
 
 #### Mapowanie konfiguracji