Demo
minTpl——GitHubgithub.com本文从制作一个简易的JS模板引擎出发,从零开始介绍一个项目的开源基本步骤。
项目过于入门,还请各路开源大神出门右转~
正文开始
目录:
1. 开发项目
2. 测试样例
3. 将项目打包成NPM包
4. 安装Chai断言库与Mocha单元测试框架准备单元测试
5. 编写测试用例进行单元测试
6. 发布NPM包
7. 编写教程
1. 开发项目
构建目录:
demo:样例
——client-demo.html:浏览器环境样例
——node-demo.js:Node环境样例
lib:源码
——minTpl.js:入口文件
test:测试
——test.js:测试文件
核心代码:
将核心代码进行模块化封装:
这里贴一下上图中的源码方便有需要的人Copy:
(
2. 测试样例(先手动测试,后续引入单元测试)
测试浏览器环境:
<!
测试Node环境:
var
3. 将项目打包成NPM包
控制台运行:
npm init
entry point 配置项填写你的入口文件:
entry point: ./lib/minTpl.js
自动生成的package.json文件:
4. 安装Chai断言库与Mocha单元测试框架准备单元测试
Chai断言库:
npm install chai --save-dev
Mocha单元测试框架:
npm install mocha --save-dev
5. 编写测试用例进行单元测试
test文件下创建test.js文件,并写三组测试用例:
var
在package.json文件中添加如下代码:
"scripts"
在控制台运行命令进行单元测试:
npm test
6. 发布NPM包
注册账号:
npm adduser
登录:
npm login
发布:
npm publish
7. 编写教程
根目录下创建markdown文件README.md:
# minTpl
简易JavaScript模板引擎
## 安装
```bash
npm install mintpl
```
## Node环境使用
```javascript
var minTpl = require('mintpl');
var tpl = '你好,我的名字叫{{name}}。这是我家的狗狗,它今年{{dog.age}}岁了!';
var data = {
name: 'pany',
dog: {
age: 2
}
};
var str = minTpl(tpl, data);
console.log(str);
```
## 单元测试
```bash
npm test
```
上传到NPM或者GitHub的效果: