最終更新日 2020年08月10日(月)

すべての新しいプロジェクトを npm init で開始する

npm の init​ コマンドは、プロジェクトの有効な package.json を足場にして、作業用ディレクトリから共通のプロパティを推測します。

$ mkdir my-awesome-app
$ cd my-awesome-app
$ npm init --yes

省力化のため、--yes​ フラグを指定してこのコマンドを実行してから、package.json を開いて変更を加えます。 最初に行うのは、現在のバージョンの Node (node -v​) で ‘engines’ キーを指定することです。

"engines": {
  "node": "12.13.x"
}

スマートな .npmrc の使用

デフォルトでは、npm はインストールされている依存関係を package.json に保存しません (つまり、開発者が常に依存関係を追跡する必要があります)。

--save​ フラグを使用して package.json を自動更新する場合、npm は先頭にキャラット (^) の付いたパッケージをインストールしますが、これにはモジュールが別のバージョンに “ずれる” リスクが伴います。 これはモジュール開発には適していますが、すべての環境間で依存関係の一貫性を維持する必要があるアプリには適していません。

1 つの解決策は、次のようにしてパッケージをインストールすることです。

$ npm install foobar --save --save-exact

さらに良い方法として、~/.npmrc​ で次のオプションを設定してデフォルトを更新できます。

$ npm config set save=true
$ npm config set save-exact=true
$ cat ~/.npmrc

これで、npm install foobar​ が自動的に foobar​ を package.json に追加するようになり、インストール間で依存関係の “ずれ” が生じなくなります。

npm-shrinkwrap​ を使用して、依存関係をさらに固定できます。ただし、shrinkwrap ワークフローは直感的でないことがあり、npm の古いバージョンでは shrinkwrap に既知の問題がいくつかあることに注意してください。

ES6 への移行を恐れない

Node 4 以降の更新された V8 エンジン​は、 多くの有用な ES6 機能​を備えています。 複雑になる部分もありますが、怖がらないでください。使いながら学んでいくことができます。多くのシンプルな改善を体感すれば、すぐに満足するはずです。

let user = users.find(u => u.id === ID);

console.log(`Hello, ${ user.name }!`);

小文字の使用

一部の言語では、MyClass​ や ‘MyClass.js’ のように、クラス名に一致するファイル名を推奨しています。これは Node には当てはまりません。 代わりに、小文字のファイル名を使用してください。

let MyClass = require('my-class');

Node.js は、高度なクロスプラットフォームサポートを備えた Linux 中心のツールの希少な例です。OSX や Windows では ‘myclass.js’ と ‘MyClass.js’ は同等に扱われますが、Linux ではそうではありません。プラットフォーム間の移植性が高いコードを記述するには、大文字小文字の使い分けを含め​、require​ ステートメントと完全に一致する必要があります。

そのための簡単な方法は、あらゆる要素のファイル名に関して小文字の使用を徹底することです (例: my-class.js)。

アプリのクラスタリング

Node ランタイムには、CPU コアが 1 つ、メモリが約 1.5 GB という制限があるため、Node アプリをクラスタリングせずに大規模サーバーにデプロイするとリソースの莫大な浪費になります。

複数のコアと 1.5 GB を超えるメモリを利用するには、クラスターのサポート​を アプリに組み込みます。 今は小規模ハードウェアで単一プロセスを実行しているだけであっても、クラスターが提供する柔軟性によって将来の対応が容易になります。

アプリのクラスタリングプロセスの理想的な数を決定する最良の方法はテストですが、使用するプラットフォームで提示された妥当なデフォルト値​から始めることをお勧めします。 そのためには、次のような単純なフォールバックを使用します。

const CONCURRENCY = process.env.WEB_CONCURRENCY || 1;

クラスター抽象化​を選択して、 プロセス管理の基礎の再構築を避けます。 メインファイルとワーカーファイルを分けたい場合は、forky​ を試すことができます。 単一のエントリポイントファイルと関数を使用する場合は、throng​ を検討してください。

環境への配慮

プロジェクトで環境固有の設定ファイルを多用しないでください。 代わりに、環境変数​を利用します。

ローカル開発環境を提供するには、.gitignore を付けた .env​ ファイルを作成します。このファイルは heroku local​ によって読み込まれます。

DATABASE_URL='postgres://localhost/foobar'
HTTP_TIMEOUT=10000

これ以降、heroku local​ でアプリを起動すると、これらの環境変数が process.env.DATABASE_URL​ および process.env.HTTP_TIMEOUT​ の配下で自動的にアプリに読み込まれます。また、プロジェクトをデプロイすると、プロジェクトはその新しいホスト上の変数に自動的に適応​します。

これは ‘config/abby-dev.js'、'config/brian-dev.js'、'config/qa1.js'、'config/qa2.js'、'config/prod.js’ などよりもシンプルで柔軟性があります。

ガーベジの回避

Node (V8) では、低速で強力なガーベジコレクターを使用します。 そのデフォルトの制限は約 1.5 GB のため、必要になるまで待機してからでないと未使用のメモリを再利用しない場合があります。 メモリ使用量が増加している場合、これはリークではなく、Node の通常の低速な動作​です。

アプリのガーベジコレクターの制御を強化するために、Procfile​ で V8 にフラグを指定できます。

web: node --optimize_for_size --max_old_space_size=920 --gc_interval=100 server.js

これは、使用可能なメモリが 1.5 GB に満たない環境でアプリを実行している場合に特に重要です。 たとえば、Node を 512 MB のコンテナーに合わせたい場合は、次を試してみてください。

web: node --optimize_for_size --max_old_space_size=460 --gc_interval=100 server.js

フックの利用

npm のライフサイクルスクリプト​は、自動化のための優れたフックです。 Heroku では、依存関係をインストールする前または後にカスタムコマンドを実行するためのカスタムフック​を提供しています。アプリをビルドする前に何かを実行する必要がある場合、heroku-prebuild​ スクリプトを使用できます。grunt、gulp、browserify、または webpack でアセットをビルドする必要がある場合は、build​ スクリプトで行います。

package.json で、次のように記述します。

"scripts": {
  "build": "bower install && grunt build",
  "start": "nf start"
}

環境変数を使用してこれらのスクリプトを制御することもできます。

"build": "if [ $BUILD_ASSETS ]; then npm run build-assets; fi",
"build-assets": "bower install && grunt build"

スクリプトの制御が難しくなり始めたら、スクリプトをファイルに移動します。

"build": "scripts/build.sh"

package.json のスクリプトでは、./node_modules/.bin​ がスクリプトの PATH​ に自動的に追加されるため、bower​ や webpack​ などのバイナリを直接実行できます。

重要なものだけを Git で管理する

ほとんどのアプリは、必要なファイルと生成されたファイルの両方で構成されています。 Git などのソース管理システムを使用するときは、生成されたものを何でも追跡することは避けてください。

たとえば、Node アプリにはおそらく依存関係用の node_modules​ ディレクトリがありますが、これを Git での管理に含めないでください。

個々の依存関係が package.json で定義されている限り、npm install​ を実行することによって、誰でもアプリ (node_modules​ を含む) の作業用ローカルコピーを作成できます。

生成されたファイルを追跡すると、Git の履歴に不必要なノイズが混ざったり、履歴が肥大化したりする場合があります。 さらに悪いことに、一部の依存関係はネイティブであり、コンパイルする必要があるため、それらをチェックインすると、単一アーキテクチャの、また場合によっては正しくないアーキテクチャのビルドが提供されることになり、アプリの移植性が低下します。

同じ理由で、bower_components​ や、grunt ビルドからコンパイルしたアセットをチェックインしないでください。

以前に誤って node_modules​ をチェックインした場合、それは問題ありません。 次のようにして削除できます。

$ echo 'node_modules' >> .gitignore
$ git rm -r --cached node_modules
$ git commit -am 'ignore node_modules'

また、コードが乱雑にならないよう、npm のログを無視します。

$ echo 'npm-debug.log' >> .gitignore
$ git commit -am 'ignore npm-debug'

これらの不必要なファイルを無視すると、リポジトリが小さくなり、コミットがより簡単になり、生成されたディレクトリでのマージの競合が回避されます。