hakobenikki#

■ node.jsのモジュールロードのルール 23:52

node.jsのモジュールロードのルールを知らないと、ちゃんとロードされてないのかモジュール自体がおかしいのかわからない！ので、調べてたら modules - Node.js Manual & Documentation にちゃんと書いてありました。基本的にはこれよんだ方がいいです。

一応このへんがわかってたらだいたいなんとかなるなーと思った部分をまとめときます。

var m = require('module');

としたとき、requireに渡した文字列によって以下のように処理される。

• ./ か ../ か / ではじまるとそのファイルを探してロードする
• そうでない文字列ならその文字列でcoreモジュールをさがす
• coreモジュールでもなければ node_modulesを見つけて、その直下にないか探す
  • node_modules はカレントディレクトリからはじめて親ディレクトリをたどってみつける

node_modules に関しては 本家ドキュメントから引用すると、'/home/ry/projects/foo.js' ファイル内でrequire('bar.js')すると

/home/ry/projects/node_modules/bar.js
/home/ry/node_modules/bar.js
/home/node_modules/bar.js
/node_modules/bar.js

を順番にロードしようとする。拡張子はつけなくても、勝手に.js/.nodeをつけてロードを試みてくれる。

加えて、node.jsには、ディレクトリをモジュールとして扱う機能がある。ディレクトリの直下に、以下のファイルがあるとディレクトリをモジュールとしてロードできる。

• package.json
• index.js
• index.node

package.jsonには、ロードすべきjsが書いてある。

// package.json
{ "name" : "some-library",
  "main" : "./lib/some-library.js" }

だいたいのライブラリはこの形になってるので、なんかおかしかったらディレクトリの中身を確認する必要がある。

おまけ

ちょっと関係ないですが、coffee scriptだとカレントディレクトリのnode_modulesを見てくれない(coffeeコマンドの場所が基点になってるから?)のでNODE_PATH環境を設定するとよいです。

ツイートする