jslib-cli

English Document

作为搭建JavaScript第三方库的脚手架。

功能

• 支持ES6及以上版本语法
• 支持Tree Shaking
• 支持输出多种模块（IIFE、AMD、CMD、UMD、ESM）规范格式，development（.js）与production（.min.js）版本
• 支持自定义banner
• 支持eslint
• 支持可持续构建travis-ci
• 提供issue-template
• 支持单元测试
• 支持一键替换仓库名及其依赖
• 提供本地开发时编写示例及本地浏览器预览效果
• 提供文档模板

快速使用

• clone or fork 本仓库

git clone https://github.com/careteenL/jslib-cli.git yourLibName
cd yourLibName
npm install

• 修改根目录rename.js中newName字段为所需名，然后运行下面脚本，一键替换

npm run rename

• 修改package.json中author、repository、bugs信息

然后可以愉快地开始开发自己的JS库 :)

• 在doc/api.md中编写详细使用文档

• 在test/下编写测试用例，尽可能覆盖该库所有功能

• 本地开发时编写示例打开本地浏览器预览效果

npm run example

• 单元测试

npm run test

• 打包生成生产代码

npm run build

删除README.md的快速使用

修改package.json、README.md、CHANGELOG.md版本号和修改日志，打tag并发布新版到npm

npm run release

兼容性

IE9+

使用文档

• API
• 对该库的源码解析

issue模板

• Issue Template

贡献者及指南

clone仓库并引入依赖

git clone git@github.com:careteenL/jslib-cli.git
npm install

开始开发：）

...

编写详细使用文档介绍功能，可在本地查看http://127.0.0.1:8880

npm run doc

请编写单元测试覆盖所加功能

npm run test

启动本地服务器编写示例

npm run example

修改package.json README.md CHANGELOG.md版本号，再发布

npm run release

• Contributors

更新日志

• Changelog

计划

• Todo