生成本身的js工具包，包括打包webpack、测试mocha、生成文档jsdoc、发布npm包的操做

keepsmiling说明

一些经常使用的函数集合，主要用到的技术以下：

• ES6的包处理方式；
• webpack打包方式；
• BDD测试用例，只写了部分；
• 使用jsdoc生成注释文档；
• 你用eslint优化代码格式；

主要在于学习相关的技术与在平时的开发中总结一些经常使用的技巧，固然不少的函数是借用前辈经验。

项目运行

下载及查看

node 须要 6.0 以上版本。

$ https://github.com/moonbreezee/keepsmiling.git

$ cd keepsmiling

$ npm i 或者 yarn

$ npm run dev

目录说明

keepsmiling
  |—— lib // 源文件目录
  |   |—— index.js // 入口文件
  |   |—— *.js // 其余相关文件
  |—— dist // 生成文件目录，modules引用文件
  |—— doc // 生成的jsdoc说明文档，点击index.html能够本地查看
  |—— scripts // 用到的脚本文件及相关配置
  |—— static // index.html本地调试page
  |—— test // 测试用例

经常使用命令

$ npm run dev 开发模式

$ npm run build 生成可用非压缩文件

$ npm run dep 生成可用压缩文件, 用于部署到npm

$ npm run test 测试函数

$ npm run eslint 测试代码规范

publish操做

须要发布npm上，须要以下操做:
修改package的version，说明CHANGELOG，而后登陆与发布，须要本地执行$ npm run beforePublish，提交以后执行。

$ npm login
npm publish

npm包说明

npm包实际是一个存档文件，即一个目录直接打包为.zip或tar.gz格式的文件，安装后解压还原为目录。
彻底符合CommonJS规范的包目录应该包含以下这些文件:

• package.json : 包描述文件。
• bin: 用于存放可执行二进制文件的目录。
• lib：用于存放javascript代码的目录。
• doc：用于存放文档的目录。
• test: 用于存放单元测试用例的代码。

开发npm包模块的时候，就能够按照以上目录结构，进行开发：

1. lib目录下存放业务逻辑文件
2. test目录下存放单元测试用例
3. .npmignore记录哪些文件不须要被发布到npmjs.org
4. .travis.yml是持续集成服务travis的描述文件
5. index.js是入口文件
6. makefile方便咱们用make test进行测试
7. README.md是此module的描述和使用方法

JSDoc生成文档的说明

• JSDoc官网文档
• 在线预览文档

eslint配置

全局安装eslint，而后初始化配置文件，目前使用版本^4.19，能够依据须要选择选择修改：
修改的部分规则

no-useless-escape 不容许在字符串和正则表达式中使用无心义的换行符
"no-useless-escape": "off",

单体测试（BDD测试，Behavior Driven Development）

测试脚手架：karam
测试框架：mocha
断言库：power-assert

后续说明

后续还要不断的完善

github地址
npm上包地址