npm
Pocket

自分で作ったライブラリをnpmで公開してみたので、その手順メモ。

難しいのかなと思ってましたが、意外と簡単でした。

公開するとダウンロード数取ってくれます。

目次
  1. 公開前に注意すること
  2. npmにアカウントを作る
  3. package.jsonの作成
  4. 公開
  5. アップデート

公開前に注意すること

公開前にここ気をつけといたほうがいいなと思ったところを何点か

1. パッケージ名は固有のものに

npmでインストールするときは以下のようにすると思います。

npm install packege_name

なので、npm内でパッケージ名が被っていると公開できません。

後悔しないように、npmのサイトで名前が使われてないかあらかじめ調べておきましょう。

npm

2. バージョンアップしないと更新できない

公開した直後、ちょっとした誤字や修正忘れを見つけた場合でも、バージョンを上げないと更新できません。

バージョンあげれば済むことですが、そのためだけにバージョンあげるのはちょっと嫌ですよね。。。
しっかりと確認してから公開しましょう。

3. 大文字が使えない

GitHubのリポジトリでは大文字を使えますが、npmでは使えません。

GitHubで公開→npmという流れを踏んだ場合、躓く可能性あります。

大文字・小文字の差ですが、気になる人は気になると思うので注意しておいたほうがいいです。

とりあえず、公開するなら上記のことを気にしておけば大丈夫と思います。

npmアカウントを作る

npmでアカウントを作る

まず以下ページからnpmアカウントを作ります。

create an account

この後、ユーザー名・パスワード・メールアドレスを使うので覚えておきましょう。

ユーザー登録

ターミナルを開き以下コマンドを打ちます。

npm adduser

すると以下を順に聞かれるので、アカウント作成時に入力したものをそれぞれ入力していきます

Username: ユーザーネーム
Password: パスワード(ターミナル上は非表示)
Email: emailアドレス

特にエラーが出なければ完了です。

package.jsonの作成

プロジェクトフォルダ内にpackage.jsonを作成し以下を書きます。

{
  "name": "モジュール名",
  "version": "1.0",
  "description": "モジュール概要",
  "keywords": [
    "検索キーワード",
    "検索キーワード",
    "検索キーワード"
  ],
  "homepage": "モジュールホームページ",
  "license": "ライセンス",
  "main": "最初に読み込むスクリプト",
  "author": "作者名"
}

他にも、gitリポジトリについて書いたり、いろいろありますので、
気になったら調べたり、他の方のpackage.jsonを見てみるといいと思います。

公開

package.jsonを作成したら、ターミナルでプロジェクトフォルダへ移動し、以下コマンドを打ちます。

npm publish

特にエラーも出ず、package.jsonに書いたバージョンが表示されれば公開完了です。

npmのアカウントページで公開されてるか確認しましょう。

そして、コマンドを打って実際にインストールできるか試してみましょう。

npm install packege_name

アップデート

アップデートは簡単です。

package.jsonのバージョンを変更し、また公開時のコマンドを打つだけです。

npm publish
Pocket

Category : Tag :