プログラミング歴半年の素人が書いています。
間違いのないようご自身でも良く調べた上でお願いいたします。
以下の記事を参考にさせていただきました。
https://qiita.com/TsutomuNakamura/items/f943e0490d509f128ae2
npmにサインアップ
まずはnpmの公式サイトから、会員登録しましょう。
npm ユーザの作成
ターミナルからユーザー情報を登録します。
$ npm set init.author.name "Ai Uehara"
$ npm set init.author.email "ai-uehara@example.com"
$ npm set init.author.url "http://qiita.com/aiuehara"
$ npm adduser # 会員登録情報の入力
npmパッケージの作成
npm init
を実行するとpackage.json
ファイルが作成され、npmパッケージとしてディレクトリを管理することができるようになります。
$ npm init
npmパッケージに必要なプログラムを記述する
以下のようなファイル構成になります。
index.js
とpackage.json
が必須。
その他に必要なファイルがあればもちろん追加してOK。
作業ディレクトリ/
+-- index.js
+-- package.json
+-- test/
+-- test-index.js
ライブラリの追加
自分のnpmパッケージに必要なライブラリをインストールするときは、以下のコマンドを使用することで、自動的にpackage,json
に依存関係の記述が追加される。
$ npm i --save パッケージ名
開発環境のみで使用するライブラリの追加
テストなど開発環境のみで使用するパッケージは、以下のコマンドを使用する
$ npm i --save-dev パッケージ名
ライセンスファイルの作成
公開するnpmパッケージのライセンスについて、明記しておきます。
誰でも自由に使用できるライセンス(MIT)として公開することが一般的です。
LICENSE.txt
ファイルを作成し、The MIT Licenseから丸々コピーします。
Copyright <YEAR> <COPYRIGHT HOLDER>
の部分を、書き換えて保存します。
npmに公開
$ git add -A
$ git commit -m "first commit"
$ git tag -a v1.0.0 -m "My first version v1.0.0"
$ git push origin tags/v1.0.0
$ npm publish ./
バージョンアップするとき
一度npmに公開したパッケージをパージョンアップさせる時には、バージョン情報も合わせて更新する必要があります。
パッチ バージョンアップ
$ npm version patch # <- v1.0.0 からv1.0.1 にアップ
v1.0.1
$ git tag # <- git のtag も自動的に作成される
v1.0.0
v1.0.1
$ git push origin tags/v1.0.1 # <- ただし、git push まではやってくれないので、必要に応じて自分でgit push ...
$ npm publish ./ # <- npm で公開
マイナーバージョンアップ、メジャーバージョンアップ
$ npm version minor # v1.0.1 からv1.1.0 にアップ
v1.1.0
$ npm version major # v1.0.1 からv2.0.0 にアップ
v2.0.0