Comment Intlayer fonctionne

Vue d'ensemble

L'idée principale derrière Intlayer est d'adopter une gestion de contenu par composant. Ainsi, l'idée derrière Intlayer est de vous permettre de déclarer votre contenu n'importe où dans votre base de code, comme dans le même répertoire que votre composant.

.└── Components    └── MyComponent        ├── index.content.cjs        └── index.mjs

Pour ce faire, le rôle d'Intlayer est de trouver tous vos fichiers de déclaration de contenu, dans tous les formats différents présents dans votre projet, puis de générer les dictionnaires à partir de ceux-ci.

Il y a donc deux étapes principales :

• Étape de construction
• Étape d'interprétation

Étape de construction des dictionnaires

L'étape de construction peut être réalisée de trois manières :

• en utilisant la CLI avec npx intlayer build
• en utilisant l'extension vscode
• en utilisant les plugins d'application tels que le package vite-intlayer, ou leurs équivalents pour Next.js. Lorsque vous utilisez l'un de ces plugins, Intlayer construira automatiquement vos dictionnaires lorsque vous démarrez (dev) ou construisez (prod) votre application.

1. Déclaration des fichiers de contenu

   • Les fichiers de contenu peuvent être définis dans divers formats, tels que TypeScript, ECMAScript, CommonJS ou JSON.
   • Les fichiers de contenu peuvent être définis partout dans le projet, ce qui permet une meilleure maintenance et évolutivité. Il est important de respecter les conventions d'extension de fichier pour les fichiers de contenu. Cette extension est par défaut *.content.{js|cjs|mjs|ts|tsx|json}, mais elle peut être modifiée dans le fichier de configuration.

2. Génération des dictionnaires

   • Les dictionnaires sont générés à partir des fichiers de contenu. Par défaut, les dictionnaires Intlayer sont générés dans le répertoire .intlayer/dictionaries du projet.
   • Ces dictionnaires sont générés dans différents formats pour répondre à tous les besoins et optimiser les performances de l'application.

3. Génération des types de dictionnaires

Basé sur vos dictionnaires, Intlayer générera des types pour les rendre utilisables dans votre application.

• Les types de dictionnaires sont générés à partir des dictionnaires Intlayer. Par défaut, les types de dictionnaires Intlayer sont générés dans le répertoire .intlayer/types du projet.

• L'augmentation de module d'Intlayer est une fonctionnalité TypeScript qui vous permet de définir des types supplémentaires pour Intlayer. Cela rend l'expérience de développement plus facile en suggérant les arguments disponibles ou requis. Parmi les types générés, les types de dictionnaires Intlayer ou même les types de configuration de langue sont ajoutés au fichier types/intlayer.d.ts et utilisés par d'autres packages. Pour cela, il est nécessaire que le fichier tsconfig.json soit configuré pour inclure le répertoire types du projet.

Étape d'interprétation des dictionnaires

Avec Intlayer, vous accéderez à votre contenu dans votre application en utilisant le hook useIntlayer.

const MyComponent = () => {  const content = useIntlayer("my-component");  return <div>{content.title}</div>;};

Ce hook gérera pour vous la détection de la locale et renverra le contenu pour la locale actuelle. En utilisant ce hook, vous pourrez également interpréter le markdown, gérer la pluralisation, et bien plus encore.

Pour voir toutes les fonctionnalités d'Intlayer, vous pouvez lire la documentation des dictionnaires.

Contenu distant

Intlayer vous permet de déclarer du contenu localement, puis de l'exporter vers le CMS pour le rendre éditable par votre équipe non technique.

Ainsi, vous pourrez pousser et tirer du contenu depuis le CMS vers votre application, de manière similaire à ce que vous faites avec Git pour votre code.

Si configuré sur votre projet, Intlayer gérera automatiquement pour vous la récupération du contenu depuis le CMS lorsque l'application démarre (dev) / se construit (prod).

Éditeur visuel

Intlayer fournit également un éditeur visuel pour vous permettre d'éditer votre contenu de manière visuelle. Cet éditeur visuel est disponible dans le package externe intlayer-editor.

Optimisation de la construction de l'application

Pour optimiser la taille du bundle de votre application, Intlayer fournit deux plugins pour optimiser la construction de votre application : les plugins @intlayer/babel et @intlayer/swc.

En mode développement, Intlayer utilise une importation statique centralisée pour les dictionnaires afin de simplifier l'expérience de développement.

En optimisant la construction, Intlayer remplacera tous les appels des dictionnaires pour optimiser le découpage. Ainsi, le bundle final n'importera que les dictionnaires utilisés.

En activant l'option activateDynamicImport dans la configuration, Intlayer utilisera l'importation dynamique pour charger les dictionnaires. Cette option est désactivée par défaut pour éviter le traitement asynchrone lors du rendu de l'application.

@intlayer/babel est disponible par défaut dans le package vite-intlayer,

@intlayer/swc n'est pas installé par défaut dans le package next-intlayer car les plugins SWC sont encore expérimentaux sur Next.js.

Pour voir comment configurer la construction de votre application, vous pouvez lire la documentation de configuration.

Packages

Intlayer est composé de plusieurs packages, chacun ayant un rôle spécifique dans le processus de traduction. Voici une représentation graphique de la structure de ce package :

intlayer

Le package intlayer est utilisé dans les applications pour déclarer du contenu dans des fichiers de contenu.

react-intlayer

Le package react-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications React.

next-intlayer

Le package next-intlayer est utilisé comme une couche au-dessus de react-intlayer pour rendre les dictionnaires Intlayer utilisables dans les applications Next.js. Il intègre des fonctionnalités essentielles pour faire fonctionner Intlayer dans un environnement Next.js, telles que le middleware de traduction, le routage ou la configuration du fichier next.config.js.

vue-intlayer

Le package vue-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications Vue.

svelte-intlayer (WIP)

Le package svelte-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications Svelte.

solid-intlayer (WIP)

Le package solid-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications Solid.js.

preact-intlayer

Le package preact-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications Preact.

angular-intlayer (WIP)

Le package angular-intlayer est utilisé pour interpréter les dictionnaires Intlayer et les rendre utilisables dans les applications Angular.

express-intlayer

Le package express-intlayer est utilisé pour utiliser Intlayer sur un backend Express.js.

react-native-intlayer

Le package react-native-intlayer fournit des outils qui intègrent des plugins pour qu'Intlayer fonctionne avec le bundler Metro.

lynx-intlayer

Le package lynx-intlayer fournit des outils qui intègrent des plugins pour qu'Intlayer fonctionne avec le bundler Lynx.

vite-intlayer

Inclut le plugin Vite pour intégrer Intlayer avec le bundler Vite, ainsi que le middleware pour détecter la locale préférée de l'utilisateur, gérer les cookies et gérer la redirection des URL.

react-scripts-intlayer

intlayer-editor

Le package intlayer-editor est utilisé pour permettre l'utilisation de l'éditeur visuel. Ce package, optionnel, peut être installé dans les applications et sera utilisé par le package react-intlayer. Il se compose de deux parties : le serveur et le client.

Le client contient des éléments d'interface utilisateur qui seront utilisés par react-intlayer.

Le serveur, basé sur Express, est utilisé pour recevoir les requêtes de l'éditeur visuel et gérer ou modifier les fichiers de contenu.

intlayer-cli

Le package intlayer-cli peut être utilisé pour générer des dictionnaires en utilisant la commande npx intlayer dictionaries build. Si intlayer est déjà installé, le CLI est automatiquement installé et ce package n'est pas nécessaire.

@intlayer/core

Le package @intlayer/core est le package principal d'Intlayer. Il contient des fonctions de gestion de traduction et de dictionnaires. @intlayer/core est multiplateforme et est utilisé par d'autres packages pour effectuer l'interprétation des dictionnaires.

@intlayer/config

Le package @intlayer/config est utilisé pour configurer les paramètres d'Intlayer, tels que les langues disponibles, les paramètres du middleware Next.js ou les paramètres de l'éditeur intégré.

@intlayer/webpack

Le package @intlayer/webpack est utilisé pour fournir une configuration Webpack afin de faire fonctionner une application basée sur Webpack avec Intlayer. Le package fournit également un plugin à ajouter à une application Webpack existante.

@intlayer/cli

Le package @intlayer/cli est un package NPM utilisé pour déclarer les scripts liés aux interfaces en ligne de commande d'Intlayer. Il garantit l'uniformité de toutes les commandes CLI d'Intlayer. Ce package est notamment consommé par les packages intlayer-cli et intlayer.

@intlayer/dictionaries-entry & @intlayer/unmerged-dictionaries-entry & @intlayer/dynamic-dictionaries-entry

Les packages @intlayer/dictionaries-entry, @intlayer/unmerged-dictionaries-entry et @intlayer/dynamic-dictionaries-entry renvoient le chemin d'entrée des dictionnaires Intlayer. Comme il est impossible de rechercher dans le système de fichiers depuis le navigateur, l'utilisation de bundlers comme Webpack ou Rollup pour récupérer le chemin d'entrée des dictionnaires n'est pas possible. Ces packages sont conçus pour être aliasés, permettant une optimisation du bundling à travers divers bundlers tels que Vite, Webpack et Turbopack.

@intlayer/chokidar

Le package @intlayer/chokidar est utilisé pour surveiller les fichiers de contenu et régénérer le dictionnaire modifié à chaque modification.

@intlayer/editor

Le package @intlayer/editor fournit les utilitaires liés à l'éditeur de dictionnaires. Il inclut notamment l'API pour interfacer une application avec l'éditeur Intlayer, ainsi que des utilitaires pour manipuler les dictionnaires. Ce package est multiplateforme.

@intlayer/editor-react

Le package @intlayer/editor-react fournit des états, contextes, hooks et composants pour interfacer une application React avec l'éditeur Intlayer.

@intlayer/babel

Le package @intlayer/babel fournit des outils qui optimisent le bundling des dictionnaires pour les applications basées sur Vite et Webpack.

@intlayer/swc (WIP)

Le package @intlayer/swc fournit des outils qui optimisent le bundling des dictionnaires pour les applications Next.js.

@intlayer/api

Le package @intlayer/api est un SDK API pour interagir avec le backend.

@intlayer/design-system

Le package @intlayer/design-system est utilisé pour partager des éléments de design entre le CMS et l'éditeur visuel.

@intlayer/backend

Le package @intlayer/backend exporte des types backend et proposera éventuellement le backend en tant que package autonome à l'avenir.

Discutez avec notre documentation intelligente

• Posez vos questions à notre documentation intelligente