ContainerJSをnpmに登録したメモ
ContainerJS をnpmに登録したので、手順をメモしておきます。
- ContainerJSは、JavaScript Webアプリケーション用のDependency Injection コンテナ です。機能は以下。
- チュートリアルはこちら → Knockout + ContainerJS でテスタブルにToDoリストを作るチュートリアル
- ※なお、AMDで書いてるので、普通に require して使ったりはできなかったり・・・。
- Webpackとかrequire.jsと組み合わせれば使えますが、node上で使う意味はあんまりないです。
- npmで簡単にインストールできるようにするのが公開の目的です。
公開の手順は、こちらを参考にしました。
1. npmのアカウントを作成する
まずは、npmにユーザーを作成します。以下のコマンドを実行して、ユーザー名やメールアドレスを入力すればOK
$ npm adduser
- 入力した内容は、 ~/.npmrc に保存されます。
- 「npm config ls」でも確認できます。
$ npm config ls ; cli configs user-agent = "npm/2.5.1 node/v0.12.0 linux x64" ; userconfig /home/xxxx/.npmrc //registry.npmjs.org/:always-auth = false //registry.npmjs.org/:email = "masaya.yamauchi@gmail.com" //registry.npmjs.org/:username = "unageanu"
2. package.json を用意する
次にモジュールの名前や説明を記入する package.json を用意します。
以下のコマンドで対話的に作成するのが簡単。もちろんテキストエディタで直接作っても大丈夫です(たぶん)。
$ npm init
各項目の詳しい設定内容は公式ドキュメントを参考。
3. 公開しないファイルを指定する
プロジェクト内に配信不要なファイル(テストケースなど)がある場合、プロジェクトのルートに「.npmignore」を用意して記載します。
- 「.gitignore」と同じ形式で、npmで配信しないファイルを指定できます。
- 使えるワイルドカードは.gitignoreのドキュメントを参考に。
4. npmページのTopに表示される説明を用意する
npmのモジュールのページ(例:ContainerJSのページ)には、 README.md の内容が表示されます。
プロジェクトルートに README.md を作成して使い方などを記入しておきます。
- ファイル名に注意
- npmでは、「README.*」 なファイルを探して使用するようで、最初「README.ja.md」「README.md」を用意していたら、「README.ja.md」が使われてしまいました。
- 「README_ja.md」にリネームすると解決しました。
5.パッケージを公開する
package.jsonができたら、package.jsonがあるディレクトリで「npm publish」すれば、公開できます。
$ npm publish
以下のURLにアクセスすれば、ページができているはず。
https://www.npmjs.com/package/<モジュール名>
6. パッケージをアップデートする
「npm version <更新タイプ>」でpackage.jsonのバージョンを上げてから、再度publishすればOK
$ npm version patch $ npm publish
- 更新タイプのところには、新しいバージョンか、アップしたいバージョンの種類(patch, minor, major ..etc..)を指定できます。
- 例えば、patch を指定すると、 1.0.0 → 1.0.1 に上がります。
- Git管理のプロジェクトで実行すると、Gitのタグ(v1.0.1)も同時に付与されます。
つぎは
npmでインストールして、Webpackと組み合わせて使うチュートリアルを書きます(たぶん)。