如果你只是在 HTML 裡塞幾行 JavaScript 改善一下使用者體驗,那麼 Package.js 對你毫無用處。但如果你正在做一個中大型 Web App,手上有數十甚至上千個 JS 檔、CSS 檔與 HTML 模板,為了管理模組間的相依關係而苦惱,為了上 production 時要把檔案合併打包而寫 Makefile 寫到頭昏——那麼它就是為你準備的。
define 與 import 模組,語法參照 CommonJS/AMD,取其中最簡單的形式再作擴充。Test ├── dom │ └── Style.js # 模組 Test.dom.Style ├── init.js # 根命名空間初始化 ├── _nsconf_.js # Package.js 讀取的設定檔 ├── ui │ ├── Button │ │ ├── img/bg.png │ │ ├── init.js # 模組 Test.ui.Button │ │ ├── style.css # UI 元件的 CSS │ │ └── tpl.html # UI 元件的 HTML 模板 │ └── Form │ ├── init.js │ ├── style.css │ └── tpl.html ├── util │ └── Cookie.js # 模組 Test.util.Cookie └── _xproxy_.html -> ../Package/_xproxy_.html # 跨域載入模板用
資料夾路徑直接對應命名空間,這一點讓「這個檔案屬於哪個模組」變成不用思考的事。
這是和 CommonJS AMD 規範最大的差異。一個 JS 模組除了相依其他 JS 套件,還可以宣告相依 CSS 檔與 HTML 模板,並在執行期透過 this.assets 取得這些檔案的內容。
Package.define("NS.ui.Button", ["MT.ui.Component"],
{
tpl: "tpl.html",
_style: "style.css"
},
function (Component) {
var bgImgUrl = this.path + "img/bg.png",
tpl = this.assets.tpl; // 直接拿到模板字串
function Button(opt){
// 也可以透過 _pkgMeta_ 屬性取得 assets
this.tpl = String2Dom(opt.tpl || Button._pkgMeta_.assets.tpl);
}
return Button;
});
底線前綴的 _style 表示樣式會被自動注入頁面;而 _pkgMeta_ 讓模組在執行期知道自己的 URL,這解決了「元件裡的圖片該用相對路徑還是絕對路徑」的老問題。
Package.imports(["Root.ui.Button"], function (Button) {
var btn = new Button();
btn.renderTo(document.body);
});
這一行背後 Package.js 幫你做了兩件事:載入所有相依的 JS 模組,以及載入相依的 HTML 與 CSS。
// build-config.json
{
"staticUrls": { "defaults": "https://statics.example.com/jslibs/" },
"nsconfs": ["https://www.example.com/statics/jslibs/XLib/_nsconf_.js"],
"includes": ["XLib.apps.MainApp", "XLib.ui.*"],
"compress": true // 使用 UglifyJS 與 UglifyCSS 壓縮
}
# 執行 build.js build-config.json js all.min.js build.js build-config.json css all.min.css
build.js 還順手做了一件小事:把 CSS 中 background:url() 的相對路徑自動轉成絕對 URL。開發時 CSS 裡永遠只寫相對路徑,佈署時才轉換;甚至如果你用了 IE6 的 Png AlphaImageLoader 濾鏡,打包時連 src 都會一併處理。三種匯出模式 includes/deps/all 則讓你可以選擇只輸出入口模組、輸出全部相依,或全部輸出。
_xproxy_.html 跨域載入,免架 proxy;用 _nsconf_.js 設定,免手寫 paths。值得回顧的是它想解決的問題:在 bundler 還不存在的年代,前端要模組化就必須自己發明一套「相依聲明 + 資源打包」的機制。今天 webpack、Vite、Rollup 搭配 ES module 已成為標準答案,CSS 與模板也能作為 import 的對象。Package.js 的價值在於它示範了這個問題的完整形狀——而理解問題,永遠比記住某一個工具的使用方式來得重要。