NodeJS 工程目錄

工程目錄

了解了以上知識(shí)后，現(xiàn)在我們可以來(lái)完整地規(guī)劃一個(gè)工程目錄了。以編寫(xiě)一個(gè)命令行程序?yàn)槔?，一般我們?huì)同時(shí)提供命令行模式和 API 模式兩種使用方式，并且我們會(huì)借助三方包來(lái)編寫(xiě)代碼。除了代碼外，一個(gè)完整的程序也應(yīng)該有自己的文檔和測(cè)試用例。因此，一個(gè)標(biāo)準(zhǔn)的工程目錄都看起來(lái)像下邊這樣。

- /home/user/workspace/node-echo/   # 工程目錄
    - bin/                          # 存放命令行相關(guān)代碼
        node-echo
    + doc/                          # 存放文檔
    - lib/                          # 存放API相關(guān)代碼
        echo.js
    - node_modules/                 # 存放三方包
        + argv/
    + tests/                        # 存放測(cè)試用例
    package.json                    # 元數(shù)據(jù)文件
    README.md                       # 說(shuō)明文件

其中部分文件內(nèi)容如下：

/* 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"
}

以上例子中分類存放了不同類型的文件，并通過(guò) node_moudles 目錄直接使用三方包名加載模塊。此外，定義了package.json 之后，node-echo 目錄也可被當(dāng)作一個(gè)包來(lái)使用。