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 包裏面了!

須要注意的事項有哪些

單元測試

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

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

持續集成

Travis CI 提供的是持續集成服務（Continuous Integration，簡稱 CI）。它綁定 Github 上面的項目，只要有新的代碼，就會自動抓取。而後，提供一個運行環境，執行測試，完成構建，還能部署到服務器。

代碼層面

擴展開放, 修改關閉的設計原則

當 src 目錄新增一個實用函數文件, index.ts 可以自動抓取而後掛載在 module.export 上

經過 getter 巧妙的實現懶加載導出的功能

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

項目地址

github.com/xiaoxiaojx/… 歡迎 🌟 Star 🌟 和 Pr 和 在項目中使用～