天生本身的js工具包，包含打包webpack、测试mocha、天生文档jsdoc、宣布npm包的操纵

2019年8月20日 201次阅读 来源: moonbreezee

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天生文档的申明

eslint设置

全局装置eslint，然后初始化设置文件，现在运用版本^4.19，能够根据须要挑选挑选修正：
修正的部份划定规矩

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

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

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

后续申明

后续还要不停的完美

github地点
npm上包地点

    原文作者：moonbreezee
    原文地址: https://segmentfault.com/a/1190000017084741
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞