Il s'agit d'un exemple de package qui peut être utilisé pour tester Yarn.
Il contient les champs par défaut communs dans son package.json , ainsi que les dépendances de production et de développement qui sont spécifiques au package que nous avons créé.
package.json yarn init produit un package.json par défaut similaire à :
{
"name": "example-yarn-package",
"version": "1.0.0",
"description": "An example package to demonstrate Yarn",
"main": "index.js",
"repository": {
"url": "github.com/yarnpkg/example-yarn-package",
"type": "git"
},
"author": "Yarn Contributors",
"license": "BSD-2-Clause",
}
Vous pouvez également ajouter des champs personnalisés à votre package.json . Dans notre cas, nous avons ajouté 4 champs personnalisés.
Le champ scripts est destiné à tous les scripts spéciaux que vous souhaitez utiliser lors de l'exécution yarn . Par exemple, nous ajoutons ici un script appelé test qui appelle le lanceur de tests Jest car nous avons ajouté des tests Jest à notre package Yarn.
"scripts": {
"test": "jest"
},
Le champ dependencies répertorie les autres packages dont dépend ce package. Notre exemple de package dépend de Lodash puisque nous utilisons sa fonction multiply .
"dependencies": {
"lodash": "^4.16.2"
},
Le champ devDependencies répertorie les autres packages dont ce package dépend pendant le développement . Notre exemple de package dépend de Jest puisque nous avons créé des tests compatibles Jest pour notre package.
"devDependencies": {
"jest-cli": "15.1.1"
},
Le champ jest est un champ personnalisé spécifique au package Jest que nous avons inclus en tant que dépendance de développement. Dans ce cas, nous testons dans un environnement de nœud en ligne de commande.
"jest": {
"testEnvironment": "node"
}
Il est important de noter que Lodash et Jest ne sont pas requis pour Yarn. Ce ne sont que des exemples de ce qui peut être utilisé lorsque vous créez le code de votre package Yarn.
$ yarn install
$ yarn run test
$ yarn install --production
