生成本身的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上包地址