目錄
- 常見包
- 包的規(guī)范
- package.json字段分析
- 自定義包的一般構(gòu)成
常見包
- fs:文件讀寫
- path:路徑操作
- http:請求
- querystring:提供用于解析和格式化 URL 查詢字符串
- body-parser:url請求參數(shù)解析
- art-template:模板
- express:web框架
- express-art-template:使express兼容art-template模板引擎
- mysql:數(shù)據(jù)庫相關(guān)署隘,下載-
npm install mysqljs/mysql
- json-sql:json轉(zhuǎn)sql語句(包括增刪改查...)
- es-checker:檢查對ES6的支持宠能,使用-
es-checker
- markdown-it:.md 文件語法轉(zhuǎn)換
- i5ting_toc:.md 文件轉(zhuǎn)成 頁面,使用-
i5ting_toc -f xxx.md -o
包的規(guī)范
- package.json必須在包的頂層目錄下
- 二進(jìn)制文件應(yīng)該在bin目錄下
- JavaScript代碼應(yīng)該在lib目錄下
- 文檔應(yīng)該在doc目錄下
- 單元測試應(yīng)該在test目錄下
package.json字段分析
- name:包的名稱磁餐,必須是唯一的违崇,由小寫英文字母、數(shù)字和下劃線組成崖媚,不能包含空格
- description:包的簡要說明
- version:符合語義化版本識別規(guī)范的版本字符串
- keywords:關(guān)鍵字?jǐn)?shù)組亦歉,通常用于搜索
- maintainers:維護(hù)者數(shù)組,每個元素要包含name畅哑、email(可選)肴楷、web(可選)字段
- contributors:貢獻(xiàn)者數(shù)組,格式與maintainers相同荠呐。包的作者應(yīng)該是貢獻(xiàn)者數(shù)組的第一個元素
- bugs:提交bug的地址赛蔫,可以是網(wǎng)站或者電子郵件地址
- licenses:許可證數(shù)組,每個元素要包含type(許可證名稱)和url(鏈接到許可證文本的- 地址)字段
- repositories:倉庫托管地址數(shù)組泥张,每個元素要包含type(倉庫類型呵恢,如git)、url(倉-庫的地址)和path(相對于倉庫的路徑媚创,可選)字段
- dependencies:生產(chǎn)環(huán)境包的依賴渗钉,一個關(guān)聯(lián)數(shù)組,由包的名稱和版本號組成
- devDependencies:開發(fā)環(huán)境包的依賴钞钙,一個關(guān)聯(lián)數(shù)組鳄橘,由包的名稱和版本號組成
自定義包的一般構(gòu)成
- mypac:基本組成(4個文件夾+2個文件)
- bin:二進(jìn)制文件
- lib:JavaScript文件
- doc:文檔
- test:單元測試
- index.js:與package.json中的main對應(yīng)
- package.json
- mypac+
- node_modules:其它包
- .html :頁面