yarn init

Créer ou mettre à jour un fichier package.json de manière interactive.

yarn init

Cette commande vous guide à travers une session interactive pour créer un fichier package.json. Des valeurs par défaut telles que la licence et la version initiale se trouvent dans les paramètres de configuration init-* de Yarn.

Voici un exemple d’exécution de la commande à l’intérieur d’un répertoire nommé testdir :

$ yarn init

question name (testdir): my-awesome-package
question version (1.0.0):
question description: The best package you will ever find.
question entry point (index.js):
question git repository: https://github.com/yarnpkg/example-yarn-package
question author: Yarn Contributor
question license (MIT):
question private:
success Saved package.json
✨  Done in 87.70s.

Il en résulte le package.json suivant :

Text for Translation
{
  "name": "mon-package-genial",
  "version": "1.0.0",
  "description": "Le meilleur package possible.",
  "main": "index.js",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "author": "Un contributeur de Yarn",
  "license": "MIT"
}

Par défaut, si la réponse à question private est transmise comme vide, la clé private ne s’ajoutera pas à package.json

Si vous avez déjà un fichier package.json existant, il utilisera alors les entrées du fichier comme valeurs par défaut.

Le package.json ci-dessous:

{
  "name": "my-existing-package",
  "version": "0.1",
  "description": "I exist therefore I am.",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "license": "BSD-2-Clause"
}

Conduira aux valeurs par défaut suivantes au cours de la session interactive :

$ yarn init

question name (my-existing-package):
question version (0.1):
question description (I exist therefore I am.):
question entry point (index.js):
question git repository (https://github.com/yarnpkg/example-yarn-package):
question author: Yarn Contributor
question license (BSD-2-Clause):
question private:
success Saved package.json
✨  Done in 121.53s.
Définition de valeurs par défaut pour yarn init

Les variables de config suivantes peuvent servir à personnaliser les paramètres par défaut de yarn init :

  • init-author-name
  • init-author-email
  • init-author-url
  • init-version
  • init-license
yarn init --yes/-y

Cette commande contourne la session interactive mentionnée ci-dessus et génère un package.json basé sur vos valeurs par défaut. Certains paramètres par défaut peuvent être modifiés en changeant les paramètres de configuration init-* comme mentionné ci-dessus. Par exemple, avec une nouvelle installation Yarn et à l’intérieur d’un répertoire nommé yarn-exemple :

$ yarn init --yes

warning The yes flag has been set. This will automatically answer yes to all questions which may have security implications.
success Saved package.json
✨  Done in 0.09s.

Ce qui produit le package.json suivant :

{
  "name": "yarn-example",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT"
}
yarn init --private/-p

ajoute automatiquement private: true au package.json

$ yarn init --private

Si l’indicateur private est défini, la clé private sera automatiquement définie avec la valeur true, puis vous compléterez toujours le reste du processus d’initialisation.

question name (testdir): my-awesome-package
question version (1.0.0):
question description: The best package you will ever find.
question entry point (index.js):
question git repository: https://github.com/yarnpkg/example-yarn-package
question author: Yarn Contributor
question license (MIT):
success Saved package.json
✨  Done in 87.70s.

{
  "name": "my-awesome-package",
  "version": "1.0.0",
  "description": "The best package you will ever find.",
  "main": "index.js",
  "repository": {
    "url": "https://github.com/yarnpkg/example-yarn-package",
    "type": "git"
  },
  "author": "Yarn Contributor",
  "license": "MIT",
  "private": true
}

Vous pouvez utiliser en même temps yes et l’indicateur private

Comme ça :

$ yarn init -yp

warning The yes flag has been set. This will automatically answer yes to all questions which may have security implications.
success Saved package.json
✨  Done in 0.05s.

Ce qui produit le package.json suivant :

{
  "name": "yarn-example",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "private": true
}
← yarn global yarn install →