Dies ist ein Beispielpaket, das zum Testen von Yarn verwendet werden kann.
Es enthält die allgemeinen Standardfelder in package.json
sowie Produktions- und Entwicklungsabhängigkeiten, die für das von uns erstellte Paket spezifisch sind.
package.json
yarn init
erzeugt ein package.json
ähnlich wie:
{
"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",
}
Sie können Ihrer package.json
auch benutzerdefinierte Felder hinzufügen. In unserem Fall haben wir 4 benutzerdefinierte Felder hinzugefügt.
Das Feld scripts
ist für alle speziellen Skripte vorgesehen, die Sie beim Ausführen yarn
verwenden möchten. Hier fügen wir beispielsweise ein Skript namens test
hinzu, das den Jest-Testläufer aufruft, da wir Jest-Tests zu unserem Yarn-Paket hinzugefügt haben.
"scripts": {
"test": "jest"
},
Das Feld dependencies
listet die anderen Pakete auf, von denen dieses Paket abhängig ist. Unser Beispielpaket ist von Lodash abhängig, da wir dessen multiply
verwenden.
"dependencies": {
"lodash": "^4.16.2"
},
Das Feld devDependencies
listet die anderen Pakete auf, von denen dieses Paket während der Entwicklung abhängig ist. Unser Beispielpaket ist von Jest abhängig, da wir einige Jest-fähige Tests für unser Paket erstellt haben.
"devDependencies": {
"jest-cli": "15.1.1"
},
Das jest
-Feld ist ein benutzerdefiniertes Feld, das speziell für das Jest-Paket gilt, das wir als Entwicklungsabhängigkeit hinzugefügt haben. In diesem Fall testen wir in einer Knotenumgebung über die Befehlszeile.
"jest": {
"testEnvironment": "node"
}
Es ist wichtig zu beachten, dass Lodash und Jest für Yarn nicht erforderlich sind. Dies sind nur Beispiele dafür, was Sie beim Erstellen des Codes für Ihr Yarn-Paket verwenden können.
$ yarn install
$ yarn run test
$ yarn install --production