生成自己的js工具包，包括打包webpack、測試mocha、生成文檔jsdoc、發布npm包的操作

Code4App 發布于2019-08-26 13:24 / 1632人閱讀

摘要：包說明包實際是一個存檔文件，即一個目錄直接打包為或格式的文件，安裝后解壓還原為目錄。完全符合規范的包目錄應該包含如下這些文件包描述文件。用于存放單元測試用例的代碼。

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包模塊的時候，就可以按照以上目錄結構，進行開發：

lib目錄下存放業務邏輯文件

test目錄下存放單元測試用例

.npmignore記錄哪些文件不需要被發布到npmjs.org

.travis.yml是持續集成服務travis的描述文件

index.js是入口文件

makefile方便我們用make test進行測試

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上包地址

云服務器 GPU云服務器接口文檔生成工具測試數據生成工具一鍵生成自己的小程序文檔生成

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/108758.html

JavaScript開發工具大全

摘要：發布于之后，采用了完全不同的方式，使用函數定義任務。它允許開發者使用它們的補丁和更新來修復這些安全漏洞。提供了工具用于掃描依賴來監測漏洞。是一個開源診斷工具，用于和應用。是和開發的一款新的包管理工具。與相比，它解決了安全性能以及一致性問題。譯者按: 最全的JavaScript開發工具列表，總有一款適合你！原文: THE ULTIMATE LIST OF JAVASCRIPT TOO...

nifhlheimr 2019-08-20 17:34 評論0 收藏0
你不知道的前端SDK開發技巧

摘要：一個帶提示的最后對于開發同學來說，就算不使用，也強烈建議使用提供注解，它會通過一些類型推導來檢查你的代碼的正確性，可以減少很多開發過程中的。相對于對象，它保證了輸入的類型你定義的對象可能某一天不再只有類型的，不再需要額外的類型判斷。作者：陳達孚香港中文大學研究生,《移動Web前端高效開發實戰》作者之一，《前端開發者指南2017》譯者之一，在中國前端開發者大會,中生代技術大會等技術...

jokester 2019-08-21 17:56 評論0 收藏0
2020年如何寫一個現代的JavaScript庫

摘要：我寫過一些開源項目，在開源方面有一些經驗，最近開到了阮老師的微博，深有感觸，現在一個開源項目涉及的東西確實挺多的，特別是對于新手來說非常不友好最近我寫了一個，旨在從多方面快速幫大家搭建一個標準的庫，本文將已為例，介紹寫一個開源庫的知識我寫過一些開源項目，在開源方面有一些經驗，最近開到了阮老師的微博，深有感觸，現在一個開源項目涉及的東西確實挺多的，特別是對于新手來說非常不友好 show...

joyqi 2019-08-23 12:14 評論0 收藏0
本命年一定要記得穿紅褲衩：2015年總結

摘要：年終總結結果到這個時間才寫，其實也是無奈。這一年最重要的事情就是順利從一只學生狗轉職為一只社畜。四月份畢業之后以前端工程師的職位入職天貓，到現在也差不多工作一年了。年終總結結果到這個時間才寫，其實也是無奈。本來計劃過年寫的，沒想到Steam竟然開了個農歷春節特惠，然后就被各種游戲打了，辣雞平臺，斂我錢財，頹我精神，耗我青春，害我單身以下全都是個人看法，如果有不認同的地方，請大吼一聲...

xi4oh4o 2019-08-01 15:06 評論0 收藏0
本命年一定要記得穿紅褲衩：2015年總結

摘要：年終總結結果到這個時間才寫，其實也是無奈。這一年最重要的事情就是順利從一只學生狗轉職為一只社畜。四月份畢業之后以前端工程師的職位入職天貓，到現在也差不多工作一年了。年終總結結果到這個時間才寫，其實也是無奈。本來計劃過年寫的，沒想到Steam竟然開了個農歷春節特惠，然后就被各種游戲打了，辣雞平臺，斂我錢財，頹我精神，耗我青春，害我單身以下全都是個人看法，如果有不認同的地方，請大吼一聲...

AlienZHOU 2019-08-19 17:38 評論0 收藏0