Node.js 如何優雅的封裝一個實用函式的 npm 包

蕭蕭fe發表於2019-04-27
Node.js封裝函式NPM

為什麼要封裝一個實用函式的 npm 包?

當你連續寫了多個 Node 應用, 都想要 console 漂亮一點, 你可能會像下面這樣封裝一個函式

import chalk from "chalk";

function noop(msg: string): string {
    return msg
}

function log(fn: Function): (msg: string) => void {
    return (msg: string): void => {
        console.log(fn(msg));
    };
}

export default {
    success: log(chalk.green),
    error: log(chalk.red),
    warn: log(chalk.yellow),
    info: log(chalk.cyan),
    log: log(noop)
};
複製程式碼

呼叫方式

import log from './log'
log.success("hello green message!")
log.error("hello red message!")
log.warn("hello yellow message!")
log.info("hello cyan message!")
log.log("hello normal message!")
複製程式碼

慢慢的發現每個專案都需要這麼一個 log 檔案, 是的! 我們此時可以考慮把這些常用的函式封裝集合到一個 npm 包裡面了!

images

需要注意的事項有哪些

單元測試

考慮到程式碼量的增加以及貢獻者的增加事先加入單元測試是很有必要的

  • 測試框架 - Mocha 是一個功能豐富的Javascript測試框架，它能執行在Node.js和瀏覽器中，支援BDD、TDD、QUnit、Exports式的測試
  • 斷言庫 - assert 是 Node 自帶的

持續整合

Node.js 如何優雅的封裝一個實用函式的 npm 包

Travis CI 提供的是持續整合服務（Continuous Integration，簡稱 CI）。它繫結 Github 上面的專案，只要有新的程式碼，就會自動抓取。然後，提供一個執行環境，執行測試，完成構建，還能部署到伺服器。

Node.js 如何優雅的封裝一個實用函式的 npm 包

程式碼層面

擴充套件開放, 修改關閉的設計原則

當 src 目錄新增一個實用函式檔案, index.ts 能夠自動抓取然後掛載在 module.export 上

通過 getter 巧妙的實現懶載入匯出的功能

Object.defineProperty(module.export, 'log', {
    configurable: false,
    enumerable: true,
    get: () => require('./log')
});
複製程式碼

專案地址

github.com/xiaoxiaojx/… 歡迎 ? Star ? 和 Pr 和 在專案中使用～

相關文章