Comment installer et utiliser le gestionnaire de paquets Yarn pour Node.js

Introduction

Yarn est un gestionnaire de paquets pour Node.js qui met l’accent sur la vitesse, la sécurité et la cohérence. Il a été initialement créé pour résoudre certains problèmes avec le populaire gestionnaire de paquets NPM. Bien que les deux gestionnaires de paquets aient depuis convergé en termes de performance et de fonctionnalités, Yarn reste populaire, surtout dans le monde du développement React.

Certaines des fonctionnalités uniques de Yarn sont :

• A per-project caching mechanism, that can greatly speed up subsequent installs and builds
• Des installations cohérentes et déterministes qui garantissent que la structure des bibliothèques installées est toujours la même
• Vérification de la somme de contrôle de tous les paquets pour vérifier leur intégrité
• « Espaces de travail », qui facilitent l’utilisation de Yarn dans un monorepo (projets multiples développés dans un seul référentiel de code source)

Dans ce tutoriel, vous installerez Yarn globalement, ajouterez Yarn à un projet spécifique et apprendrez quelques commandes de base de Yarn.

Installation et utilisation du gestionnaire de paquets Yarn pour Node.js

1. Installer Yarn globalement
2. Installer Yarn dans votre projet
3. Utiliser Yarn

Prérequis

Avant d’installer et d’utiliser le gestionnaire de paquets Yarn, vous devrez avoir Node.js installé. Pour vérifier si vous avez déjà Node.js installé, saisissez la commande suivante dans votre terminal de ligne de commande local :

node -v

Si vous voyez s’afficher un numéro de version, tel que v12.16.3, vous avez Node.js installé. Si vous obtenez une erreur command not found (ou une formulation similaire), veuillez installer Node.js avant de continuer.

Pour installer Node.js, suivez notre tutoriel pour Ubuntu, Debian, CentOS, ou macOS.

Une fois que vous avez installé Node.js, passez à l’étape 1 pour installer le gestionnaire de paquets Yarn.

Étape 1 — Installation de Yarn globalement

Yarn a une façon unique de s’installer et de s’exécuter dans vos projets JavaScript. Tout d’abord, vous installez la commande yarn globalement, puis vous utilisez la commande globale yarn pour installer une version locale spécifique de Yarn dans le répertoire de votre projet. Cela est nécessaire pour garantir que tout le monde travaillant sur un projet (et tous les outils de test et de déploiement automatisés du projet) exécute la même version de yarn, afin d’éviter des comportements et des résultats incohérents.Les mainteneurs de Yarn recommandent d’installer Yarn globalement en utilisant le gestionnaire de paquets NPM, qui est inclus par défaut dans toutes les installations de Node.js. Utilisez le drapeau -g avec npm install pour ce faire :

Les mainteneurs de Yarn recommandent d’installer Yarn globalement en utilisant le gestionnaire de paquets NPM, qui est inclus par défaut avec toutes les installations de Node.js. Utilisez l’indicateur -g avec npm install pour le faire :

sudo npm install -g yarn

Après l’installation du package, faites en sorte que la commande yarn imprime son propre numéro de version. Cela vous permettra de vérifier qu’il a été installé correctement :

yarn --version

Output
1.22.11

Maintenant que vous avez installé la commande yarn globalement, vous pouvez l’utiliser pour installer Yarn dans un projet JavaScript spécifique.

Étape 2 – Installation de Yarn dans votre projet

Vous pouvez ignorer cette étape si vous utilisez Yarn pour travailler sur un projet existant basé sur Yarn. Le projet devrait déjà être configuré avec une version locale de Yarn et tous les fichiers de configuration nécessaires pour l’utiliser.

Si vous configurez un nouveau projet, vous voudrez configurer une version spécifique au projet de Yarn maintenant.

Tout d’abord, naviguez jusqu’au répertoire de votre projet :

cd ~/my-project

Si vous n’avez pas de répertoire de projet, vous pouvez en créer un nouveau avec mkdir puis y entrer :

mkdir my-project
cd my-project

Maintenant, utilisez la commande yarn set pour définir la version sur berry :

yarn set version berry

Cela téléchargera la version actuellement développée de Yarn – berry – la sauvegardera dans un répertoire .yarn/releases/ dans votre projet et configurera également un fichier de configuration .yarnrc.yml :

Output
Resolving berry to a url...
Downloading https://github.com/yarnpkg/berry/raw/master/packages/berry-cli/bin/berry.js...
Saving it into /home/sammy/my-project/.yarn/releases/yarn-berry.cjs...
Updating /home/sammy/my-project/.yarnrc.yml...
Done!

Maintenant, essayez à nouveau la commande yarn --version :

yarn --version

Output
3.0.0

Vous verrez que la version est 3.0.0 ou supérieure. C’est la dernière version de Yarn.

Votre projet est désormais configuré avec une version spécifique au projet de Yarn. Ensuite, nous examinerons quelques commandes yarn couramment utilisées pour démarrer.

Utilisation de Yarn

Yarn possède de nombreuses sous-commandes, mais vous n’en avez besoin que de quelques-unes pour démarrer. Examinons les premières sous-commandes que vous voudrez utiliser.

Obtenir de l’aide

Lorsque vous commencez avec n’importe quel nouvel outil, il est utile de savoir comment accéder à son aide en ligne. Dans Yarn, l’indicateur --help peut être ajouté à n’importe quelle commande pour obtenir plus d’informations :

yarn --help

Cela affichera l’aide globale pour la commande yarn. Pour obtenir des informations plus spécifiques sur un sous-commande, ajoutez --help après le sous-commande :

yarn install --help

Cela afficherait des détails sur la façon d’utiliser la commande yarn install.

Démarrage d’un Nouveau Projet Yarn

Si vous démarrez un projet à partir de zéro, utilisez le sous-commande init pour créer les fichiers spécifiques à Yarn dont vous aurez besoin :

yarn init

Cela ajoutera un fichier de configuration package.json et un fichier yarn.lock à votre répertoire. Le fichier package.json contient la configuration et votre liste de dépendances de modules. Le fichier yarn.lock verrouille ces dépendances à des versions spécifiques, garantissant que l’arbre des dépendances est toujours cohérent.

Installation de toutes les Dépendances d’un Projet

Pour télécharger et installer toutes les dépendances dans un projet basé sur Yarn existant, utilisez le sous-commande install :

yarn install

Cela téléchargera et installera les modules dont vous avez besoin pour commencer.

Ajout d’une nouvelle dépendance à un projet

Utilisez la sous-commande add pour ajouter de nouvelles dépendances à un projet:

yarn add package-name

Cela téléchargera le module, l’installera et mettra à jour vos fichiers package.json et yarn.lock.

Mise à jour de votre fichier .gitignore pour Yarn

Yarn stocke les fichiers dans un dossier .yarn à l’intérieur de votre répertoire de projet. Certains de ces fichiers doivent être contrôlés par contrôle de version et d’autres doivent être ignorés. La configuration de base de .gitignore pour Yarn suit:

.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

Cela ignore l’ensemble du répertoire .yarn puis ajoute des exceptions pour certains dossiers importants, y compris le répertoire releases qui contient la version spécifique de votre projet de Yarn.

Pour plus de détails sur la façon de configurer Git et Yarn, veuillez vous référer à la documentation officielle de Yarn sur .gitignore.

Conclusion

Dans ce tutoriel, vous avez installé Yarn et appris à connaître quelques sous-commandes yarn. Pour plus d’informations sur l’utilisation de Yarn, consultez la documentation officielle de la CLI Yarn.

Pour obtenir de l’aide plus générale sur Node.js et JavaScript, veuillez visiter nos pages d’étiquette Node.js et JavaScript, où vous trouverez des tutoriels pertinents, des conférences techniques et des Q&A de la communauté.