yarn add

Installe un package ainsi que tous les packages dont il dépend.

Ajout des dépendances

En général, un package est simplement un dossier avec du code et un fichier package.json qui décrit le contenu. Lorsque vous souhaitez utiliser un autre package, vous devez d’abord l’ajouter à vos dépendances. Cela signifie l’exécution de yarn add [package-name] pour l’installer dans votre projet.

Cela mettra également à jour votre package.json et votre yarn.lock afin que les autres développeurs qui travaillent sur le projet puissent avoir les mêmes dépendances que vous lorsqu’ils exécutent yarn ou yarn install.

La plupart des packages seront installés dans le registre npm et dénommés simplement par leur nom de package. Par exemple, yarn add react installera le package de react du registre npm.

Vous pouvez spécifier les versions en utilisant une des commandes ci-dessous:

  1. yarn add package-name installe la « dernière » version du package.
  2. yarn add package-name@1.2.3 installe une version particulière d’un package depuis le registre.
  3. yarn add package-name@tag installe un « tag » spécifique (beta, next ou latest).

Vous pouvez également spécifier des packages de différents endroits :

  1. yarn add package-name installe le package depuis le registre npm à moins que vous en ayez spécifié un autre dans votre package.json.
  2. yarn add file:/path/to/local/folder installe un package qui est sur votre système de fichiers local. Ceci est utile pour tester vos autres packages qui n’ont pas été publiés au registre.
  3. yarn add file:/path/to/local/tarball.tgz installe un package d’une archive tar qui pourrait être utilisée pour partager un package avant de le publier.
  4. yarn add <git remote url> installe un package depuis un dépôt git.
  5. yarn add <git remote url>#<branch/commit/tag> installe un package depuis un dépôt git distant à une branche git, un commit git ou un tag git spécifique .
  6. yarn add https://my-project.org/package.tgz installe un package depuis une archive tar gzippée distante.

Mises en garde

Si vous avez utilisé précédemment un gestionnaire de packages comme npm, vous cherchez peut-être a savoir comment ajouter des dépendances globales.

Pour la grande majorité des packages, il est considéré comme une mauvaise pratique d’avoir des dépendances globales parce qu’elles sont implicites. Il est préférable d’ajouter toutes vos dépendances localement afin qu’elles soient explicites et que n’importe qui d’autre qui utilise votre projet obtiennent le même ensemble de dépendances.

Si vous essayez d’utiliser un outil CLI qui a un bin vous pouvez accéder à ces derniers dans votre répertoire ./node_modules/.bin. Vous pouvez également utiliser la commande global :

yarn global add <package...>

Commandes

yarn add <package...>

Ceci installera un ou plusieurs packages dans vos dépendances.

yarn add <package...> [--dev/-D]

L’utilisation de --dev ou -D installera un ou plusieurs packages dans vos devDependencies.

yarn add <package...> [--peer/-P]

L’utilisation de --peer ou -P installera un ou plusieurs packages dans vos peerDependencies.

yarn add <package...> [--optional/-O]

L’utilisation de --optional ou -O installera un ou plusieurs packages dans vos optionalDependencies.

yarn add <package...> [--exact/-E]

L’utilisation de --exact ou -E installera un ou plusieurs packages à des versions précises. Par défaut la version la plus récente avec la même version majeure est installée. Par exemple, yarn add foo@1.2.3 acceptera la version 1.9.1, mais yarn add foo@1.2.3 --exact n’accepte que la version 1.2.3.

yarn add <package...> [--tilde/-T]

L’utilisation de --tilde ou -T installera la version la plus récente du package avec la même version mineure. Par défaut la version la plus récente avec la même version majeure est installée. Par exemple, yarn add foo@1.2.3 --tilde acceptera 1.2.9 mais pas 1.3.0.