准备工作
在开始之前你可能需要了解: node、npm、等相关知识,并安装相关开发环境。
这里默认你对开发环境,以及node都有了基础的理解。
正式开始:开发node包
在你自己的工程目录下执行命令:
npm init
这是执行命令的结果,会在目录下生成package.json
文件。接下来创建工程目录结构
执行如下命令:
mkdir tests lib && touch index.js README.md
结果如下:
开始开发工作
对于node包来说基本代码都是一些公用js文件。
详细开发过程可以查看另一篇文章:node包开发过程。
注意点:- index.js中要 export 包对象,也就是暴露接口给外部;
- index.js内部可以依赖其他js文件,可以放置在lib中,也可以依赖其他包;
功能开发基本完毕
此时我们并不知道我们实现的功能是否可行、可用,我们需要进行单元测试。如何写单元测试?
先剧透一下,我们的单测框架使用的是 Mocha
这里有阮一峰老师的一个例子,可以先了解一下单元测试原则
- 对全新的代码或修改过的代码进行单元测试
- 单元测试根据单元测试计划和方案进行,排除测试的随意性
- 必须保证单元测试计划、单元测试方案、单元测试用例等经过评审
- 当测试用例的测试结果与预期结果不一致时,单元测试的执行人员需如实记录实际的测试结果
- 只有当测试计划中的结束标准达到时,单元测试才能结束
- 对被测试单元需达到的一定的代码覆盖率要求 对于编写单元测试,将独立章节详细讲解。
代码开发完成,如何发布?
- npm adduser(用户名、密码、邮箱)-- 注册帐号
- npm whoami(查看当前帐号)
- sudo npm publish(发布到npmjs.org)-- 注意:sudo权限
发布之后的包如何使用呢?
npm install 你的包名,就可以向我们平时使用其他模块的包一样使用了。
总结
这就是node包的开发以及发布流程,总结一下:
- 配置node环境
- 使用npm初始化命令生成package.json(npm init)
- 创建工程环境:目录,入口文件等
- 编辑package添加第三方依赖包(如果需要)
- 根据package安装依赖包(npm install)
- 编写index.js开始实现功能...
- 完成功能之后测试没有问题发包(npm publish)
以上就是大体的流程,有些步骤可根据自己需要删减,看那个人需求。最后祝大家能在代码的世界中找到自己。