阅读 1311

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 自带的

持续集成

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 和 在项目中使用~

关注下面的标签,发现更多相似文章
评论