CommonJS

CommonJS是一個專案，其目標是為JavaScript在網頁瀏覽器之外建立模組約定。建立這個專案的主要原因是當時缺乏普遍可接受形式的JavaScript指令碼模組單元，模組在與執行JavaScript指令碼的常規網頁瀏覽器所提供的不同的環境下可以重複使用。

歷史

這個專案由Mozilla工程師Kevin Dangoor於2009年1月發起，最初名為ServerJS^[1]。在2009年8月，這個專案被改名為「CommonJS」來展示其API的廣泛的應用性^[2]。有關規定在一個開放行程中被建立和認可，一個規定只有在已經被多個實現完成之後才被認為是最終的^[3]。 CommonJS不隸屬於致力於ECMAScript的Ecma國際的工作群組 TC39，但是TC39的一些成員參與了這個專案^[4]。

在2013年5月，Node.js套件管理器(npm)的作者Isaac Z. Schlueter，宣佈Node.js已經廢棄了CommonJS，Node.js核心開發者應避免使用它^[5]。

規定

規定列表包括^[6]：

當前

• Modules/1.0 (被Modules/1.1取代)
• Modules/1.1
• Modules/1.1.1
• Packages/1.0
• System/1.0

提議

• Binary/B
• Binary/F
• Console
• Encodings/A
• Filesystem/A
• Filesystem/A/0
• Modules/Async/A
• Modules/Transport/B
• Packages/1.1
• Packages/Mappings
• Unit Testing/1.0

模組

require是一個函數，require函數接受一個模組識別碼，require返回外部模組的匯出的API。如果要求的模組不能被返回則require必須throw一個錯誤。在模組內，有一個自由變量require，它滿足上述定義。在模組內，有一個自由變量叫做exports，它是一個對象，模組在執行時可以向其增加模組的API。模組必須使用exports對象作為唯一的匯出方式。^[7]

在模組中，必須有一個自由變量module，它是一個對象。module對象必須有一個id屬性，它是這個模組的頂層id。id屬性必須是這樣的：require(module.id)會從源出module.id的那個模組返回exports對象。（就是說module.id可以被傳遞到另一個模組，而且在要求它時必須返回最初的模組）。^[8]

樣例代碼

math.js

exports.add = function() {
    var sum = 0, i = 0, args = arguments, l = args.length;
    while (i < l) {
        sum += args[i++];
    }
    return sum;
};

increment.js

var add = require('math').add;
exports.increment = function(val) {
    return add(val, 1);
};

program.js

var inc = require('increment').increment;
var a = 1;
inc(a); // 2

module.id == "program";

實現

• Akshell^[9]
• Common Node^[10]
• CommonJS Compiler - 命令列工具使Common JS模組適用於瀏覽器內使用^[11]
• CommonJS for PHP - 針對PHP 5.3+的輕量級CommonJS實現^[12]
• CouchDB^[13]
• Flusspferd^[14]
• GPSEE^[15]
• Jetpack
• Joyent 智能平台^[16]
• JSBuild^[17]
• MongoDB^[18]
• Narwhal (JavaScript平台)^[19]
• Node.js^[20]
• Persevere^[21]
• PINF JavaScript裝載器^[22]
• RingoJS^[23]
• SilkJS^[24]
• SproutCore（英語：SproutCore）^[25]
• TeaJS^[26]
• Wakanda（英語：Wakanda (software)）^[27]
• XULJet（英語：XULJet）^[28]
• QUnit（英語：QUnit）

參見

• 伺服器端JavaScript實現列表（英語：List of server-side JavaScript implementations）
• 文件物件模型（DOM），網頁瀏覽器客戶端應用程式介面（API），通常以JavaScript獲得
• JSGI（英語：JSGI）