yarn tag

パッケージのタグを追加、削除、もしくは一覧表示します。

タグとは?

ディストリビューションタグ(または dist-tag)は公開したパッケージのバージョンをラベル付けする手段です。パッケージのユーザーはバージョン番号の代わりに、このラベルを使用してインストールできます。

例えば、stable のリリースチャネルと canary のリリースチャネルがある場合、タグを使用すればユーザーは以下のように入力できます:

yarn add your-package-name@stable
yarn add your-package-name@canary

異なるタグは異なる意味合いを持ちます:

  • latest: パッケージの現在のバージョン
  • stable: パッケージの最新の安定版リリースで、長期サポート (LTS) が無い限り通常は latest と同じです。
  • beta: latest および/または stable となる前のリリースで、次のリリースで行われる変更を完了前に共有するために使用されます。
  • canary: 「ナイトリー」もしくはベータ以前のリリースで、プロジェクトが多くの開発者によって頻繁に更新される場合、これを使用することで早期からコードをシェアできます。
  • dev: 時に作業中のパッケージについて、レジストリを通じて単一の修正内容をテストしたいケースがあった際に有用です。

一部のプロジェクトでは、彼らが適切と考える独自のタグを追加したり、より標準的なものの1つと置き換えたりします。 beta と同様に使用される next などがあります。

これらは広く「標準的な」タグと見なされていますが、本当の意味があるのは latest だけで、バージョン指定がない場合にインストールするバージョンを決めるのに使用されます。

注意事項

ネームスペースを共有しているので、潜在的なバージョン番号と一致するタグは使用できません:

yarn add your-package-name@<version>
yarn add your-package-name@<tag>

セマンティックバージョニングの範囲を表すものとしても有効な全てのタグは拒否されます。例えば v2.3 というタグは、セマンティックバージョニングでは >=2.3.0 <2.4.0 という意味になるので使用できません。

一般的に、バージョンのように見えるタグの使用を避けることは、大抵それらが人々を混乱させてしまうからなのです。

コマンド

yarn tag add <package>@<version> <tag>

<tag> という名前のタグを <package> の指定した <version> に追加します。

yarn tag remove <package> <tag>

使用されていない <tag> という名前のタグを <package> から削除します。

注意: パッケージの他のバージョンに移行する前にタグを削除する必要はありません。それはしないことをお勧めします。

yarn tag list [<package>]

<package> にあるタグを全て一覧表示します。<package> が指定されない場合は、その時点で内部にいるパッケージがデフォルトで表示されます。