Workflow

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

開発環境の構築

開発環境を構築します。

• 必要なソフトウェアをインストールします

• WebModule をローカルにクローンします。
  チュートリアル環境を参照してください

  $ mkdir ~/workspace
  $ cd ~/workspace
  $ git clone git@github.com:uupaa/WebModule.git

• モジュールを格納するリポジトリを作成し、ローカルにクローンします

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

• 必要なファイルをコピーします

  • MyExample.js に必要なファイルを ~/workspace/WebModule からコピーします
  • node ../WebModule/run/setup コマンドを実行します

• 開発環境を整えます

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

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

package.json を編集

package.json を編集します

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

実装とテスト

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

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

カバレッジ

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

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

README の修正

モジュールの作成と品質の確認が終わったら、MyExample.js の README.md を修正します。

検索キーワードの追加

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

公開

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

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

$ npm run patch                 <-- 初回は省略できます

$ git add .

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

$ npm publish

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

Spec を書きます

公開が終わったらSpecを書きます。
(むしろ最初に Spec を書いてから Code を書いても良いでしょう)

Congratulations

お疲れ様でした! 😆 🍻