example yarn package

これは Yarn のテストに使用できるサンプル パッケージです。

package.jsonには共通のデフォルト フィールドがあり、作成したパッケージに固有の運用および開発の依存関係も含まれています。

package.json

デフォルトのパッケージフィールド

yarn init次のようなデフォルトのpackage.jsonを生成します。

 {
  "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",
}

カスタムパッケージフィールド

package.jsonにカスタム フィールドを追加することもできます。この例では、4 つのカスタム フィールドを追加しました。

scriptsフィールドは、 yarnの実行時に使用する特別なスクリプト用です。たとえば、ここでは Jest テストを Yarn パッケージに追加したため、Jest テスト ランナーを呼び出すtestというスクリプトを追加します。

 "scripts": {
  "test": "jest"
},

dependenciesフィールドには、このパッケージが依存している他のパッケージがリストされます。このサンプル パッケージは、 multiply関数を使用するため、Lodash に依存しています。

 "dependencies": {
  "lodash": "^4.16.2"
},

devDependenciesフィールドには、このパッケージが開発中に依存する他のパッケージがリストされます。パッケージ用に Jest 対応のテストをいくつか作成したため、サンプル パッケージは Jest に依存しています。

 "devDependencies": {
  "jest-cli": "15.1.1"
},

jestフィールドは、開発依存関係として含めた Jest パッケージに固有のカスタム フィールドです。この場合、コマンドラインでノード環境でテストしています。

 "jest": {
  "testEnvironment": "node"
}

Lodash と Jest は Yarn には必要ないことに注意することが重要です。これらは、Yarn パッケージのコードを作成するときに使用できるものの例にすぎません。

発達

 $ yarn install
$ yarn run test

生産

 $ yarn install --production