js模板引擎_做一个开源JS项目的基本步骤?

eaf9ac4dbf291c06eb034c9cbe4df78d.png

Demo

minTpl——GitHub​github.com
56764d94cd164be2bbb6729952641b66.png
mintpl——npm​www.npmjs.com
4e6696280fc99dd4fedb8cc51c3fe94f.png

本文从制作一个简易的JS模板引擎出发,从零开始介绍一个项目的开源基本步骤。

项目过于入门,还请各路开源大神出门右转~

正文开始

目录:
1. 开发项目
2. 测试样例
3. 将项目打包成NPM包
4. 安装Chai断言库与Mocha单元测试框架准备单元测试
5. 编写测试用例进行单元测试
6. 发布NPM包
7. 编写教程

1. 开发项目

构建目录:

d654c0fcde422afbcbc84932006aab35.png
demo:样例
——client-demo.html:浏览器环境样例
——node-demo.js:Node环境样例
lib:源码
——minTpl.js:入口文件
test:测试
——test.js:测试文件

核心代码:

4dec03cdd5dad826ff527efefa4f695e.png

将核心代码进行模块化封装:

4c3d13276504ef145e2e8fb92427af13.png

这里贴一下上图中的源码方便有需要的人Copy:

(

2. 测试样例(先手动测试,后续引入单元测试)

测试浏览器环境:

<!

测试Node环境:

var 

3. 将项目打包成NPM包

控制台运行:

npm init

entry point 配置项填写你的入口文件:

entry point: ./lib/minTpl.js

自动生成的package.json文件:

70dfcd741832076b91b682aba5ca1058.png

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的效果:

a047ab282653320f7c84d4e43fafc97f.png

End.

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值