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 ファイルが存在していれば、クリーンアップ処理が実行されます。ファイルが存在しない場合は何もしません。

デフォルト:

yarn autoclean --init コマンドを使って .yarnclean ファイルを生成した場合、デフォルトで削除対象のファイルセットが書き込まれます。 デフォルトのリストは、通常必要ないと考えられるものになっています。 現在から将来にわたるすべての NPM パッケージで本当に不要なディレクトリとファイルを正確に予測することは不可能です。そのため、デフォルトのリストのままでは、もしかするとパッケージが壊れてしまう可能性があります。

そのため、.yarnclean のデフォルトのエントリーを確認し、自分の環境に合わせてカスタマイズすることを**強く推奨します **。

autoclean のプロセスでパッケージが正常に動作するために必要なファイルが削除されてしまうことが分かったら、対応するエントリーを .yarnclean ファイルから削除する必要があります。

例:

たとえば、node_modules 内のすべての依存関係中の YAML と Markdown ファイルが安全に削除できることが分かった場合、.yarnclean ファイルを次のように書けます。

*.yaml
*.md

その後、yarn install または yarn autoclean --force を実行すると、 クリーンアップのプロセスで、node_modules/ 配下の全ての *.yaml*.md ファイルが (ネストされた一時的な依存関係を含めて) 再帰的に削除されます。