## 前言 在nodejs大環境下，npm作為包管理工具風靡一時，作為前端開發者需要知道npm可以實現哪些操作，核心的機制是如何的。 ## 快速入手 ### 基本了解 * [npm官網地址](https://www.npmjs.com/) * npm的運行環境是nodejs,默認nodejs安裝之后就可以執行npm命令,nodejs的安裝教程可以站內搜索或者百度搜索。 ``` bash $ npm -v 3.10.3 #全局安裝 ,建議全局安裝一次（npm install --global=npm i -g） $ npm i -g #依賴安裝,根據項目里的模塊依賴情況(安裝到依賴 --save 安裝到開發依賴 --save-dev) $ npm i --save-dev ``` * 模塊版本說明 ^1.0.0 此主版本 1.x.x>=1.0.0 ~1.0.0 主版本對，并且包括分支小版本 1.1.0>1.0.x>=1.0.0 \>1.0.0 安裝大于某個版本，默認等于版本的。 <1.0.0 安裝小于某個版本 * [npm指令速記表](https://docs.npmjs.com/misc/config#shorthands-and-other-cli-niceties) ### npm安裝某模塊 * npm也支持檢索，但是npm模塊太多，建議根據準確的模塊名稱直接安裝。 ``` bash #全局安裝某模塊 $ npm i packname -g #全局安裝某模塊特定版本 $ npm i packname@1.0.0 -g #依賴安裝某模塊 $ npm i packname --save-dev #查看依賴的模塊 $ npm less ``` ### npm卸載模塊 ``` bash #卸載某模塊uninstall=un $ npm un packname ``` ### 發布與刪除模塊 * npm增加用戶,也可以官網注冊 ``` bash # 增加用戶 $ npm adduser # 用戶登錄 $ npm login ``` * 模塊要想發布到npm倉庫，必須有package.json的包說明文件，其他不做具體要求，可根據自己的需要靈活開發私屬模塊。建議通過npm init來實現模塊包文件初始化,通過npm init -y ,npm init -f 回到初始化狀態。 ``` bash # 模塊初始化 $ npm init # 發布模塊 $ npm publish [name] # 刪除模塊 $ npm unpublish [name] ## 回到初始化 $ npm init -y $ npm init -f ``` * 查看以及更新模塊 ``` bash #查看模塊詳情 $ npm info [name] #更新模塊 $ npm update [name] ``` * 測試模塊 ``` bash #項目測試 test=t $ npm test $ npm t ``` * 枚舉可用腳本 ``` bash # 打開package.json文件并檢查scripts部分 cat package.json # 運行npm run得到一個的所有可用的腳本的列表。 npm run # 安裝ntl (npm i -g ntl)，然后運行ntl在項目文件夾中。它也可以運行腳本，也很方面。 npm i -g ntl ``` ### 新建模塊簡易教程 * 模塊示例,發布模塊要符合cmd模塊規范。可以按照以下 步驟制定js模塊。 0. 代碼托管地址新建倉庫(建立這個的原因主要是方便維護各個修改狀態，因為我們一般不會針對每個修改都發布版本) 1. 新建模塊文件夾，或者檢出倉庫地址，文件夾內寫主要入口文件index.js 2. 初始化包描述文件，填寫基本模塊信息 3. 添加許可證，說明文件等次要信息，必要時可以添加說明文檔，測試用例等 4. 模塊主js文件參考 ``` javascript //當前模塊依賴的模塊 var re=require("m1"); // 模塊私有變量 var ab=""; // 模塊私有方法 function parse(){ #code here }; //確定對外接口的變量 or方法 module.exports.ab=ab; module.exports.parse=parse; ``` 5.　模塊的輸出定義與使用(不能混淆使用)，會報錯：`Cannot assign to read only property 'exports' of object '#<Object>'`，參考如下匹配規則。 ``` javascript //定義module.exports module.exports={ } import xxx from 'xxx' // 定義export default export default { booklist, comp1 } require('xxx') ``` ## 其他問題 ### 如何發布帶前綴的私有模塊 npm 私有的包如何進行發布 加組織名 npm publish --access=public 添加發布渠道為公共即可 ### ## 參考資料 * [npm安裝機制-阮一峰](http://www.ruanyifeng.com/blog/2016/01/npm-install.html) -