了解了以上知識后,現(xiàn)在我們可以來完整地規(guī)劃一個工程目錄了。以編寫一個命令行程序為例,一般我們會同時提供命令行模式和 API 模式兩種使用方式,并且我們會借助三方包來編寫代碼。除了代碼外,一個完整的程序也應該有自己的文檔和測試用例。因此,一個標準的工程目錄都看起來像下邊這樣。
- /home/user/workspace/node-echo/ # 工程目錄
- bin/ # 存放命令行相關代碼
node-echo
+ doc/ # 存放文檔
- lib/ # 存放API相關代碼
echo.js
- node_modules/ # 存放三方包
+ argv/
+ tests/ # 存放測試用例
package.json # 元數(shù)據(jù)文件
README.md # 說明文件
其中部分文件內容如下:
/* bin/node-echo */
var argv = require('argv'),
echo = require('../lib/echo');
console.log(echo(argv.join(' ')));
/* lib/echo.js */
module.exports = function (message) {
return message;
};
/* package.json */
{
"name": "node-echo",
"main": "./lib/echo.js"
}
以上例子中分類存放了不同類型的文件,并通過 node_moudles 目錄直接使用三方包名加載模塊。此外,定義了package.json 之后,node-echo 目錄也可被當作一個包來使用。
更多建議: