Intlayer CLI

    Installer le Paquet

    Installez les paquets nécessaires avec npm :

    npm install intlayer-cli
    yarn add intlayer-cli
    pnpm add intlayer-cli

    Remarque : si le paquet intlayer est déjà installé, le CLI est automatiquement installé. Vous pouvez passer cette étape.

    Paquet intlayer-cli

    Le paquet intlayer-cli a pour objectif de transcrire vos déclarations intlayer en dictionnaires.

    Ce paquet transcrira tous les fichiers intlayer, tels que src/**/*.content.{ts|js|mjs|cjs|json}. Voir comment déclarer vos fichiers de déclaration Intlayer.

    Pour interpréter les dictionnaires intlayer, vous pouvez utiliser des interpréteurs, tels que react-intlayer ou next-intlayer.

    Support des Fichiers de Configuration

    Intlayer accepte plusieurs formats de fichiers de configuration :

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

    Pour savoir comment configurer les langues disponibles ou d'autres paramètres, consultez la documentation de configuration ici.

    Exécuter les Commandes Intlayer

    Générer des dictionnaires

    Pour générer vos dictionnaires, vous pouvez exécuter les commandes suivantes :

    npx intlayer build

    ou en mode surveillance

    npx intlayer build --watch

    Cette commande trouvera vos fichiers de contenu de déclaration par défaut dans ./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx} et générera les dictionnaires dans le répertoire .intlayer.

    Envoyer des dictionnaires

    npx intlayer push

    Si l'éditeur intlayer est installé, vous pouvez également envoyer des dictionnaires à l'éditeur. Cette commande rendra les dictionnaires disponibles dans l'éditeur à https://intlayer.org/dashboard/content. De cette manière, vous pouvez partager vos dictionnaires avec votre équipe et éditer votre contenu sans modifier le code de votre application.

    Arguments :
    • -d, --dictionaries : IDs des dictionnaires à envoyer. Si non spécifié, tous les dictionnaires seront envoyés. > Exemple : npx intlayer push -d mon-dictionnaire-id mon-autre-dictionnaire-id
    • -r, --deleteLocaleDictionary : Ignore la question demandant de supprimer les répertoires de langues locales une fois les dictionnaires envoyés, et les supprime. Par défaut, si le dictionnaire est défini localement, il écrasera le contenu des dictionnaires distants. > Exemple : npx intlayer push -r
    • -k, --keepLocaleDictionary : Ignore la question demandant de supprimer les répertoires de langues locales une fois les dictionnaires envoyés, et les conserve. Par défaut, si le dictionnaire est défini localement, il écrasera le contenu des dictionnaires distants. > Exemple : npx intlayer push -k

    Télécharger des dictionnaires distants

    npx intlayer pull

    Si l'éditeur intlayer est installé, vous pouvez également télécharger des dictionnaires depuis l'éditeur. De cette manière, vous pouvez écraser le contenu de vos dictionnaires selon les besoins de votre application.

    Arguments :
    • -d, --dictionaries : IDs des dictionnaires à télécharger. Si non spécifié, tous les dictionnaires seront téléchargés. > Exemple : npx intlayer pull -d mon-dictionnaire-id mon-autre-dictionnaire-id
    • --newDictionariesPath : Chemin du répertoire où les nouveaux dictionnaires seront sauvegardés. Si non spécifié, les nouveaux dictionnaires seront sauvegardés dans le répertoire ./intlayer-dictionaries du projet. Si un champ filePath est spécifié dans le contenu de votre dictionnaire, les dictionnaires ignoreront cet argument et seront sauvegardés dans le répertoire spécifié dans filePath. > Exemple : npx intlayer pull --newDictionariesPath ./my-dictionaries

    Utiliser les commandes intlayer dans votre package.json :

    "scripts": { "intlayer:build": "npx intlayer build", "intlayer:watch": "npx intlayer build --watch", "intlayer:push": "npx intlayer push", "intlayer:pull": "npx intlayer pull" }

    Dans cette page