Workflow

このエントリでは、開発環境の構築と、お試しモジュール(MyExample.js)を作成し、モジュールを npm に公開する方法について説明します。

環境構築

開発環境を構築します。

• 必要なソフトウェアをインストールします
• ~/workspace 以下に開発環境を構築します

モジュールを格納するリポジトリを作成する

リポジトリを作成しクローンします。

• MyExample.js リポジトリを GitHub で作成します
• 作成したリポジトリを ~/workspace にクローンします

必要なファイルをコピーする

MyExample.js に必要なファイルを ~/workspace/WebModule からコピーします

• npm run setup コマンドを実行します

開発環境を整える

開発環境を整えます

• npm run sync コマンドを実行します

開発環境を整えた後は、このようなディレクトリ構成になります。

package.json を編集

package.json を編集します

• 必要なモジュールを追加します
• ビルドターゲットの設定とモジュールを構成するソースコードを指定します

実装とテスト

lib/MyExample.js をエディタで開き実装を開始します。

• 実装を始める前に実装ポリシー を一読ください
• npm run lint コマンドで lib/*.js の Syntax を検査できます
• 関数を1〜2つ追加するごとに、test/testcase.js にテストコードを記述しユニットテストを実施してください

カバレッジ

十分にテストができたらコードの品質を測定します。

• npm run score コマンドを実行します

README の修正

モジュールの作成と品質の確認が終わったら、MyExample.js の README.md を修正します。
サンプルコードや API spec などより詳細なドキュメントを書きたい場合は README.md ではなく wiki に記述し README からリンクします。

検索キーワードの追加

検索用のキーワード を package.json に埋め込みます。

公開

npm t, npm run lint や npm run score で十分に品質を確保できたら、いよいよ世界に向けて公開です。

公開は簡単です、いつもの git push コマンドと npm publish を実行するだけです。

$ npm run patch                     <-- 初めて publish する場合はこのコマンドは省略できます

$ git add .

$ git commit -m "first commit"      <-- メッセージの内容はお好みで
$ git push

$ npm publish

2回目以降は忘れずに npm run patch コマンドを実行し、package.json の patch version を +1 するようにしてください。
(これを忘れると npm publish でエラーになります)

ドキュメントを書きましょう

公開が終わったらドキュメントを書きましょう。
(むしろ最初にドキュメントを書いてからコードを書いても良いでしょう)

Congratulations

お疲れ様でした! 😆 🍻