開発中のNPMパッケージをシンボリックリンクで参照する方法

ローカルにある開発中のNPMパッケージを、シンボリックリンクで参照する方法です。

リンクするには?

STEP1. パッケージのグローバルリンクを作成する

$ cd your-package
$ npm link

グローバルパッケージとして登録されたことを確認します。

$ npm ls -g

├── your-package@1.0.0 -> /path/to/your-package

STEP2. プロジェクトにパッケージをリンクする

$ cd your-project
$ npm link your-package

node_modulesフォルダにシンボリックリンクされたパッケージが表示されます。(VSCodeの場合はEXPLORERをリロードしないと反映されないことがある)

リンクを解除するには?

STEP1. プロジェクトからパッケージへのリンクを解除する

$ cd your-project
$ npm unlink your-package

node_modules フォルダからシンボリックリンクされたパッケージが無くなったことを確認します。(VSCodeの場合はEXPLORERをリロードしないと反映されないことがある)

STEP2. パッケージのグローバルリンクを削除する

$ npm unlink -g your-package

グローバルパッケージから削除されたことを確認します。

$ npm ls -g

(your-packageなし)

参考

npm-link | npm Docs: https://docs.npmjs.com/cli/v7/commands/npm-link