github上のnpm packageをインストールする時の作業メモ

自社のgithub公開したpackageをnpmコマンドでインストールする時に挫折した為、Macでその辺りの作業注意点をメモする。

github上に自社用パッケージを公開するメリット

1. 該当repoをチェックすることなく、toolsなどを簡単にnpm installで入力できて便利
2. バージョンアップする時も、同じくnpm updateすれば、最新版に更新される
3. 公開は社内に限定される

インストールする前の準備

• githubのアクセストークンを作成

  • https://github.com/settings/tokens
  • Select scopesで必要最低限の権限を付与
    • repoをチェックON
    • write:packagesのread:packagesをチェックON
  • Enable SSO

• 生成したトークンを何処かにコピー

• ターミナルからnpmでgithubをログイン

  • Usernameにgithubのユーザ名を入力
  • PasswordにCMD＋Vでトークンを貼り付けてEnterキー押下
  • Emailに個人のメールアドレスを入力
  • Logged in as userHoge to scope @hoge-company on https://npm.pkg.github.com/.が表示された成功

npm login --scope=@hoge-company --registry=https://npm.pkg.github.com

インストール

• 対象パッケージをグローバルにインストール

npm i -g @hoge-company/hoge-tool

• シェルに反映

exec $SHELL -l

• 確認

hoge-tool

.npmrcファイル

• npm loginで指定されたregistry情報がこのnpm設定ファイルに入る

@hoge-company:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=xxxxxxxxxxxxxxxxxxxx

• npm logoutでやると、上記内容が.npmrcから消える

npm logout --scope=@hoge-company --registry=https://npm.pkg.github.com