yarn autoclean

パッケージの依存関係から不要なファイルをクリーンアップして削除します。

yarn autoclean [-I/--init] [-F/--force]

autoclean コマンドは不要なファイルとフォルダを依存関係から削除することで、容量スペースを開放します。 プロジェクトの node_modules フォルダから多数のファイルを削除するので、バージョン管理に直接パッケージをチェックインする環境で便利です。

注意: このコマンドは応用的なユースケースのみに向けたものと見なされています。 node_modules の一部としてインストールされているファイルの量に問題がある場合を除き、このコマンドを使用することはお勧めできません。 node_modules 内のファイルを永久に削除してしまうので、パッケージが動作しなくなる可能性があります。

デフォルトでは autoclean 機能は無効になっています。 有効にするには、手動で .yarnclean を作成するか、yarn autoclean --init を実行してデフォルトのエントリが入ったファイルを作成してください。 .yarnclean ファイルはバージョン管理に追加されるべきものです。

パッケージに .yarnclean ファイルが存在する場合は、autoclean 機能は有効化されます。クリーンアップは以下のタイミングで実行されます:

  • install の後
  • add の後
  • yarn autoclean --force が実行された場合

クリーンアップは .yarnclean の各行を読んで実施され、削除するファイルをglobパターンを使用して表します。

オプション:

-I/--init.yarnclean ファイルが存在しない場合に作成し、デフォルトのエントリを追加します。 このファイルを確認して、どのファイルがクリーンアップされるかを指定するために編集する必要があります。 すでに存在している場合は上書きされません。

-F/--force.yarnclean ファイルが存在していれば、クリーンアップ処理が実行されます。ファイルが存在しない場合は何もしません。

Defaults:

When the yarn autoclean --init command is used to create a .yarnclean file, it will be pre-populated with a set of default items for deletion. This default list is a guess at what is likely not needed. It is impossible to predict all directories and files that are actually unnecessary for all existing and future NPM packages, so this default list may cause a package to no longer work.

It is highly recommended that you manually review the default entries in .yarnclean and customize them to fit your needs.

If you discover the autoclean process is deleting files that are needed for a package to work properly, then you should remove the corresponding entry from the .yarnclean file.

例:

You decide all YAML and Markdown files in all your dependencies installed in node_modules can be safely deleted. You make a .yarnclean file containing:

*.yaml
*.md

You then run yarn install or yarn autoclean --force. The clean process will delete all *.yaml and *.md files within node_modules/ recursively (including nested transitive dependencies).