@intlayer/docs 5.5.8

package/index.d.ts

@@ -0,0 +1,100 @@
+declare module '@intlayer/docs' {
+  enum DocsKeysEnum {
+    introduction,
+    roadmap,
+    how_works_intlayer,
+    configuration,
+    interest_of_intlayer,
+    intlayer_cli,
+    intlayer_visual_editor,
+    intlayer_CMS,
+    intlayer_with_create_react_app,
+    intlayer_with_i18next,
+    intlayer_with_nextjs_15,
+    intlayer_with_nextjs_14,
+    intlayer_with_nextjs_page_router,
+    intlayer_with_vite_react,
+    intlayer_with_vite_vue,
+    intlayer_with_vite_svelte,
+    intlayer_with_vite_solid,
+    intlayer_with_vite_preact,
+    intlayer_with_angular,
+    intlayer_with_react_native_and_expo,
+    intlayer_with_lynx_react,
+    intlayer_with_express,
+    dictionary__translation,
+    dictionary__enumeration,
+    dictionary__condition,
+    dictionary__insertion,
+    dictionary__file,
+    dictionary__nesting,
+    dictionary__markdown,
+    dictionary__function_fetching,
+    dictionary__get_started,
+    dictionary__content_extention_customization,
+    dictionary__per_locale_file,
+    terms_of_service,
+    privacy_notice,
+    'package__intlayer',
+    'package__intlayer__getConfiguration',
+    'package__intlayer__getDictionary',
+    'package__intlayer__getLocaleLang',
+    'package__intlayer__getLocaleName',
+    'package__intlayer__getLocalizedUrl',
+    'package__intlayer__getMultilingualUrls',
+    'package__intlayer__getPathWithoutLocale',
+    'package__intlayer__getTranslation',
+    'package__intlayer__getEnumeration',
+    'package__intlayer__getHTMLTextDir',
+    'package__intlayer__removeLocaleFromUrl',
+    'package__express-intlayer',
+    'package__express-intlayer__t',
+    'package__next-intlayer',
+    'package__next-intlayer__t',
+    'package__next-intlayer__useDictionary',
+    'package__next-intlayer__useIntlayer',
+    'package__next-intlayer__useIntlayerAsync',
+    'package__next-intlayer__useLocale',
+    'package__react-intlayer',
+    'package__react-intlayer__t',
+    'package__react-intlayer__useDictionary',
+    'package__react-intlayer__useIntlayer',
+    'package__react-intlayer__useIntlayerAsync',
+    'package__react-intlayer__useLocale',
+    'package__vite-intlayer',
+    'package__vue-intlayer',
+    'package__svelte-intlayer',
+    'package__solid-intlayer',
+    'package__preact-intlayer',
+    'package__angular-intlayer',
+    'package__lynx-intlayer',
+    'package__react-native-intlayer',
+    'package__react-scripts-intlayer',
+    'package__intlayer-editor',
+    'package__@intlayer_api',
+    'package__@intlayer_chokidar',
+    'package__@intlayer_cli',
+    'package__@intlayer_config',
+    'package__@intlayer_core',
+    'package__@intlayer_design-system',
+    'package__@intlayer_dictionary-entry',
+    'package__@intlayer_webpack',
+    'package__@intlayer_editor',
+    'package__@intlayer_editor-react',
+    vscode_extension,
+    ci_cd,
+    autoFill,
+    mcp_server,
+  }
+
+  export type DocsKeys = keyof typeof DocsKeysEnum;
+
+  export function getDocs(lang?: string): Docs;
+  export function getFequentQuestions(): Record<string, string>;
+  export function getDoc<T extends DocsKeys>(
+    docName: T,
+    lang?: string
+  ): Docs[T];
+
+  export type Docs = Record<DocsKeys, string>;
+}

package/it/CI_CD.md

@@ -0,0 +1,149 @@
+# Generazione Automatica di Traduzioni in un Pipeline CI/CD
+
+Intlayer consente la generazione automatica delle traduzioni per i file di dichiarazione dei contenuti. Esistono diversi modi per ottenere questo risultato a seconda del tuo flusso di lavoro.
+
+## Utilizzo del CMS
+
+Con Intlayer, puoi adottare un flusso di lavoro in cui viene dichiarata localmente solo una singola lingua, mentre tutte le traduzioni vengono gestite in remoto tramite il CMS. Questo consente di separare completamente i contenuti e le traduzioni dal codice, offrendo maggiore flessibilità agli editor di contenuti e abilitando il ricaricamento dinamico dei contenuti (non è necessario ricostruire l'applicazione per applicare le modifiche).
+
+### Configurazione di Esempio
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
+    requiredLocales: [Locales.ENGLISH], // Le lingue opzionali saranno gestite in remoto
+    defaultLocale: Locales.ENGLISH,
+  },
+  editor: {
+    dictionaryPriorityStrategy: "distant_first", // I contenuti remoti hanno la priorità
+
+    applicationURL: process.env.APPLICATION_URL, // URL dell'applicazione utilizzato dal CMS
+
+    clientId: process.env.INTLAYER_CLIENT_ID, // Credenziali del CMS
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+  },
+  ai: {
+    applicationContext: "Questa è un'applicazione di test", // Aiuta a garantire una generazione di traduzioni coerente
+  },
+};
+
+export default config;
+```
+
+Per saperne di più sul CMS, consulta la [documentazione ufficiale](https://github.com/aymericzip/intlayer/blob/main/docs/it/intlayer_CMS.md).
+
+## Utilizzo di Husky
+
+Puoi integrare la generazione delle traduzioni nel tuo flusso di lavoro Git locale utilizzando [Husky](https://typicode.github.io/husky/).
+
+### Configurazione di Esempio
+
+```ts fileName="intlayer.config.ts"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.SPANISH, Locales.FRENCH],
+    requiredLocales: [Locales.ENGLISH], // Le lingue opzionali sono gestite in remoto
+    defaultLocale: Locales.ENGLISH,
+  },
+  editor: {
+    clientId: process.env.INTLAYER_CLIENT_ID,
+    clientSecret: process.env.INTLAYER_CLIENT_SECRET,
+  },
+  ai: {
+    provider: "openai",
+    apiKey: process.env.OPENAI_API_KEY, // Usa la tua chiave API
+
+    applicationContext: "Questa è un'applicazione di test", // Aiuta a garantire una generazione di traduzioni coerente
+  },
+};
+
+export default config;
+```
+
+```bash fileName=".husky/pre-push"
+npx intlayer build                          # Per garantire che i dizionari siano aggiornati
+npx intlayer fill --unpushed --mode fill    # Riempie solo i contenuti mancanti, non aggiorna quelli esistenti
+```
+
+> Per ulteriori informazioni sui comandi CLI di Intlayer e sul loro utilizzo, consulta la [documentazione CLI](https://github.com/aymericzip/intlayer/blob/main/docs/it/intlayer_cli.md).
+
+> Se hai più applicazioni nel tuo repository che utilizzano istanze separate di Intlayer, puoi utilizzare l'argomento `--base-dir` come segue:
+
+```bash fileName=".husky/pre-push"
+# App 1
+npx intlayer build --base-dir ./app1
+npx intlayer fill --base-dir ./app1 --unpushed --mode fill
+
+# App 2
+npx intlayer build --base-dir ./app2
+npx intlayer fill --base-dir ./app2 --unpushed --mode fill
+```
+
+## Utilizzo di GitHub Actions
+
+Intlayer fornisce un comando CLI per riempire automaticamente e rivedere i contenuti dei dizionari. Questo può essere integrato nel tuo flusso di lavoro CI/CD utilizzando GitHub Actions.
+
+```yaml fileName=".github/workflows/intlayer-translate.yml"
+name: Intlayer Auto-Fill
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'src/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'src/**'
+  workflow_dispatch: {}
+
+concurrency:
+  group: 'autofill-${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  autofill:
+    runs-on: ubuntu-latest
+    env:
+      INTLAYER_CLIENT_ID: ${{ secrets.INTLAYER_CLIENT_ID }}
+      INTLAYER_CLIENT_SECRET: ${{ secrets.INTLAYER_CLIENT_SECRET }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+    steps:
+      - name: ⬇️ Checkout repository
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: true
+
+      - name: 🟢 Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: 📦 Install dependencies
+        run: npm ci
+
+      - name: ⚙️ Build Intlayer project
+        run: npx intlayer build
+
+      - name: 🤖 Auto-fill missing translations
+        run: npx intlayer fill --git-diff --mode fill
+
+      - name: 📤 Create or update translation PR
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: chore: auto-fill missing translations [skip ci]
+          branch: auto-translations
+          title: chore: update missing translations
+          labels: translation, automated
+```
+
+> Come per Husky, nel caso di un monorepo, puoi utilizzare l'argomento `--base-dir` per trattare sequenzialmente ogni applicazione.
+
+> Per impostazione predefinita, l'argomento `--git-diff` filtra i dizionari che includono modifiche dalla base (default `origin/main`) al branch corrente (default: `HEAD`).
+
+> Per ulteriori informazioni sui comandi CLI di Intlayer e sul loro utilizzo, consulta la [documentazione CLI](https://github.com/aymericzip/intlayer/blob/main/docs/it/intlayer_cli.md).

package/it/autoFill.md

@@ -0,0 +1,157 @@
+# File di Dichiarazione dei Contenuti Autocompletati
+
+I **file di dichiarazione dei contenuti autocompletati** sono un modo per accelerare il flusso di lavoro di sviluppo.
+
+Il meccanismo di autocompletamento funziona attraverso una relazione _master-slave_ tra i file di dichiarazione dei contenuti. Quando il file principale (master) viene aggiornato, Intlayer applicherà automaticamente queste modifiche ai file di dichiarazione derivati (autocompletati).
+
+```ts fileName="src/components/example/example.content.ts"
+import { Locales, type Dictionary } from "intlayer";
+
+const exampleContent = {
+  key: "example",
+  locale: Locales.ENGLISH,
+  autoFill: "./example.content.json",
+  content: {
+    contentExample: "This is an example of content",
+  },
+} satisfies Dictionary;
+
+export default exampleContent;
+```
+
+Ecco un [file di dichiarazione dei contenuti per lingua](https://github.com/aymericzip/intlayer/blob/main/docs/it/per_locale_file.md) che utilizza l'istruzione `autoFill`.
+
+Quindi, quando esegui il seguente comando:
+
+```bash
+npx intlayer fill --file 'src/components/example/example.content.ts'
+```
+
+Intlayer genererà automaticamente il file di dichiarazione derivato in `src/components/example/example.content.json`, completando tutte le lingue non ancora dichiarate nel file principale.
+
+```json5 fileName="src/components/example/example.content.json"
+{
+  "key": "example",
+  "content": {
+    "contentExample": {
+      "nodeType": "translation",
+      "translation": {
+        "fr": "Ceci est un exemple de contenu",
+        "es": "Este es un ejemplo de contenido",
+      },
+    },
+  },
+}
+```
+
+Successivamente, entrambi i file di dichiarazione verranno uniti in un unico dizionario, accessibile utilizzando l'hook standard `useIntlayer("example")` (react) / composable (vue).
+
+## Formato dei File Autocompletati
+
+Il formato consigliato per i file di dichiarazione autocompletati è **JSON**, che aiuta a evitare vincoli di formattazione. Tuttavia, Intlayer supporta anche i formati `.ts`, `.js`, `.mjs`, `.cjs` e altri.
+
+```ts fileName="src/components/example/example.content.ts"
+const exampleContent = {
+  key: "example",
+  autoFill: "./example.filled.content.ts",
+  content: {
+    // Il tuo contenuto
+  },
+};
+```
+
+Questo genererà il file in:
+
+```
+src/components/example/example.filled.content.ts
+```
+
+> La generazione di file `.js`, `.ts` e simili funziona come segue:
+
+> - Se il file esiste già, Intlayer lo analizzerà utilizzando l'AST (Abstract Syntax Tree) per individuare ogni campo e inserire le traduzioni mancanti.
+
+> - Se il file non esiste, Intlayer lo genererà utilizzando il modello predefinito per i file di dichiarazione dei contenuti.
+
+## Percorsi Assoluti
+
+Il campo `autoFill` supporta anche i percorsi assoluti.
+
+```ts fileName="src/components/example/example.content.ts"
+const exampleContent = {
+  key: "example",
+  autoFill: "/messages/example.content.json",
+  content: {
+    // Il tuo contenuto
+  },
+};
+```
+
+Questo genererà il file in:
+
+```
+/messages/example.content.json
+```
+
+## Generazione Automatica di File di Dichiarazione dei Contenuti per Lingua
+
+Il campo `autoFill` supporta anche la generazione di file di dichiarazione dei contenuti **per lingua**.
+
+```ts fileName="src/components/example/example.content.ts"
+const exampleContent = {
+  key: "example",
+  autoFill: {
+    fr: "./example.fr.content.json",
+    es: "./example.es.content.json",
+  },
+  content: {
+    // Il tuo contenuto
+  },
+};
+```
+
+Questo genererà due file separati:
+
+- `src/components/example/example.fr.content.json`
+- `src/components/example/example.es.content.json`
+
+## Filtrare l'Autocompletamento per Lingua Specifica
+
+L'utilizzo di un oggetto per il campo `autoFill` ti consente di applicare filtri e generare solo file di lingua specifici.
+
+```ts fileName="src/components/example/example.content.ts"
+const exampleContent = {
+  key: "example",
+  autoFill: {
+    fr: "./example.fr.content.json",
+  },
+  content: {
+    // Il tuo contenuto
+  },
+};
+```
+
+Questo genererà solo il file di traduzione francese.
+
+## Variabili di Percorso
+
+Puoi utilizzare variabili all'interno del percorso `autoFill` per risolvere dinamicamente i percorsi di destinazione per i file generati.
+
+**Variabili disponibili:**
+
+- `{{locale}}` – Codice lingua (es. `fr`, `es`)
+- `{{key}}` – Chiave del dizionario (es. `example`)
+
+```ts fileName="src/components/example/example.content.ts"
+const exampleContent = {
+  key: "example",
+  autoFill: "/messages/{{locale}}/{{key}}.content.json",
+  content: {
+    // Il tuo contenuto
+  },
+};
+```
+
+Questo genererà:
+
+- `/messages/fr/example.content.json`
+- `/messages/es/example.content.json`