Yarn 命令
前言:親愛的同學們又見面了!在上一篇文章里,我給大家簡單介紹了Yarn的功能和基本使用流程。我們知道 Yarn 是 Facebook 發(fā)布,用來完善 npm 的新版依賴管理工具,所以關于 Yarn,我們還有很多值得探索的地方,接下來本文,我給大家詳細的列舉及解釋一下 Yarn 在日常開發(fā)中的常用命令。
1. Yarn 的命令匯總
命令 | 慕課釋義 |
---|---|
yarn add | 添加依賴 |
yarn audit | 對已安裝的軟件包執(zhí)行漏洞審核 |
yarn autoclean | 從程序包依賴項中清除并刪除不必要的文件 |
yarn bin | 顯示依賴bin文件夾的位置 |
yarn cache | 管理用戶目錄中的依賴緩存 |
yarn check | 驗證當前項目中程序包依賴項 |
yarn config | 管理依賴配置文件 |
yarn create | 創(chuàng)建Yarn工程 |
yarn dedupe | 刪除重復的依賴 |
yarn generate-lock-entry | 生成Yarn鎖文件 |
yarn global | 在全局安裝依賴 |
yarn help | 顯示Yarn的幫助信息 |
yarn import | 遷移當前依賴的項目package-lock.json |
yarn info | 顯示有關依賴的信息 |
yarn init | 初始化工程并創(chuàng)建package.json文件 |
yarn install | 用于安裝項目的所有依賴項 |
yarn licenses | 列出已安裝依賴的許可證及源碼url |
yarn link | 鏈接依賴文件夾 |
yarn list | 列出已安裝的依賴 |
yarn login | 存儲您在 registry 上的用戶名和 email |
yarn logout | 清除你在 registry 上用戶名和 email |
yarn outdated | 列出所有依賴項的版本信息 |
yarn owner | 展示依賴作者 |
yarn pack | 創(chuàng)建依賴項的壓縮gzip |
yarn policies | 規(guī)定整個項目中執(zhí)行Yarn的版本 |
yarn publish | 將依賴發(fā)布到npm注冊表 |
yarn remove | 刪除依賴 |
yarn run | 運行定義的程序腳本命令 |
yarn tag | 在依賴上添加,刪除或列出標簽 |
yarn team | 管理組織中的團隊,并更改團隊成員身份 |
yarn test | 運行程序的test命令 |
yarn upgrade | 將指定依賴升級為最新版本 |
yarn upgrade-interactive | 更新過期依賴的簡便方法 |
yarn version | 展示依賴版本信息 |
yarn versions | 展示所有依賴項版本信息 |
yarn why | 顯示有關為什么安裝依賴的信息 |
yarn workspace | Yarn的工作區(qū)信息 |
yarn workspaces | Yarn的所有工作區(qū)信息 |
通過以上整理可得,雖然 yarn 并沒有實現(xiàn) Npm 所有的命令功能,但是目前已經可以滿足絕大多數開發(fā)場景,接下來,我們挑選出實際開發(fā)中常用的一些命令,向大家解釋并示例使用技巧。
2. 命令詳解
2.1 yarn version
解釋:用來查看 yarn 的版本信息
使用場景:查看當前安裝 yarn 的版本
具體使用:
使用 yarn -v
或者 yarn -version
運行結果如下:
經驗:
當安裝完 yarn,不知道是否安裝成功時,可以使用此命令,如果顯示了版本號,說明安裝成功。
2.2 yarn init
解釋:初始化項目或者文件夾
使用場景:當你想初始化一個項目,或者文件夾,并生成 package.json
文件時,使用此命令。
具體使用:
我們初始化一個示例項目,執(zhí)行:
yarn init
默認配置項我們直接 enter 默認,運行結果如下:
此時,我們就使用 yarn,初始化了一個項目
2.3 yarn add
解釋:添加一個或者多個依賴
使用場景:此命令為 yarn 使用頻率最高的幾個命令之一,用來添加依賴。
具體使用:
依賴添加的具體命令為:
yarn add <package> //如需選擇對應版本號,請在依賴后加 @0.x.x
比如我們想添加 gulp-less
這個依賴,效果如圖:
安裝多個依賴后,這個時候 package.json 里面會展示你安裝的所有依賴信息:
經驗:
同樣是安裝依賴,npm 使用 npm install
命令后面接很多參數,如版本號 “~”、"^"等代表的含義都不一樣,而yarn add
就十分簡潔,且控制臺輸出風格更人性化。
2.4 yarn upgrade
解釋:更新依賴
使用場景:使用此命令可以更新已經安裝的依賴。
具體使用:
更新某個依賴的具體命令為:
yarn upgrade <package>
2.5 yarn remove
解釋:刪除依賴
使用場景:使用此命令可以刪除已經安裝的依賴。
具體使用:
刪除某個依賴的具體命令為:
yarn remove <package>
2.6 yarn cache
解釋:用來管理用戶緩存的依賴
使用場景:當你想查看本地緩存了哪些 Yarn 的依賴,以及具體各個依賴項的詳細信息,可以使用該命令
具體使用:
- yarn cache dir
運行這個命令會顯示出當前緩存目錄,默認為 C 盤。例如我的電腦路徑是:
C:\Users\**\AppData\Local\Yarn\Cache\v6
- yarn cache list
展示所有已緩存的依賴項信息:
- yarn cache clean
對本地緩存的依賴進行強制清除
經驗:
本地有很多項目時,有時會發(fā)現(xiàn)用來存放依賴的磁盤空間越來越小,這也許是因為緩存了太多無用的依賴?;蛘甙惭b依賴時用了很多辦法都解決不了的,如依賴版本錯誤,可以考慮查看并清除本地的依賴緩存。
2.7 yarn config
解釋:和 npm 的 config 命令類似,用來管理依賴的配置信息
使用場景:用來查看和設置依賴的一些配置信息,如資源路徑等
具體使用:
- yarn config list
這個命令不僅能展示 yarn 的資源路徑信息,還能展示 npm 的路徑信息:
- yarn cache set
設置配置信息,如設置淘寶鏡像地址:
yarn config set registry https://registry.npm.taobao.org
經驗:
對于許多國內開發(fā)者來說,有些依賴下載速度慢,再或者直接被墻,這時候我們可以使用本命令來更改資源路徑,如改為淘寶鏡像,這樣就能大大提高開發(fā)效率。
2.8 yarn info
解釋:查看具體某一個依賴的信息,不一定是本地已經安裝過的,遠程的也可以
使用場景:查看具體的依賴信息
具體使用:
- yarn info
例如我們想查看 vue 的具體信息,可以輸入命令
yarn info vue
這里查看到了所有 vue 這個包的信息,例如作者、版本信息等:
2.9 yarn global
解釋:在 npm 里有 npm install <package> -g
的命令,用來全局安裝某個依賴,同樣yarn也有相對應的全局安裝方案 yarn global
使用場景:使用yarn全局安裝某個依賴,或者可以配合yarn bin
、yarn remove
等命令使用
具體使用:
- yarn global add
例如我們想全局安裝 webpack,使用命令:
yarn global add webpack
經驗:
yarn 并不推薦把依賴安裝到全局環(huán)境下,原因是 yarn 的思想是想讓每一個項目有對應的本地依賴,防止不同的開發(fā)環(huán)境因為全局的依賴項,導致運行的結果不同。
2.10 yarn why
解釋:幫助你尋找本項目的依賴
使用場景:想尋找本項目中的某一依賴信息,可以使用該命令。
具體使用:
使用命令:
yarn why <package>
該命令可以計算依賴大小,及展示該依賴項對應的其他依賴等。
2.11 yarn run
解釋:使用 yarn 的yarn run
命令, 來啟動項目相對應的功能。
使用場景:在項目里已經定義好相對應的一些命令后,使用 yarn run 命令,來啟動項目相對應的功能,本處演示使用 vue cli 初始化得命令。
具體使用:
- yarn run <項目定義命令>
例如:我們使用package.json
文件中定義的啟動命令 serve ,如果用npm 我們可以使用npm serve
或者npm run serve
,在 yarn 命令中,我們使用yarn run serve
或者yarn serve
啟動項目。
yarn run serve
運行命令后效果如下圖,此時,我們就啟動了這個vue-cli默認的項目:
項目默認頁面展示如下圖:
然后我們再嘗試下默認的打包命令:
yarn run build
此時文件夾中的 dist
目錄便是打包出來的文件。
經驗:
yarn run 命令,和 npm run 命令,運行的實際效果是一致的,不過我們更推薦使用yarn命令,是因為yarn命令的運行提示更加簡潔易懂,比npm更加友好。
2.12 yarn publish
解釋:發(fā)布一個包到 npm 注冊表
使用場景:如果你想發(fā)布一個自己的 npm 包,就可以使用yarn publish
命令
具體使用:
1.創(chuàng)建 npm 賬號,并驗證。
首先,登錄 npm
官方注冊地址 (https://www.npmjs.com/signup) ,根據自己真實信息和郵箱注冊一個賬號。
注冊完,進入首頁可以看到如下頁面:
2.準備待發(fā)布的文件
初始化一個文件夾,cd 到文件夾目錄下 執(zhí)行 npm init
,效果如下圖:
在文件夾根目錄創(chuàng)建 index.js
文件夾,并且寫一個入口函數。
3.如果是第一次發(fā)布運行 npm adduser
填寫用戶名,密碼,郵箱,運行命令如下圖:
注意:
- npm adduser成功的時候默認你已經登陸了,所以可跳過第四步
- as 后面是用戶名。on 后是源地址,如果不是https://registry.npmjs.org/,比如是淘寶源(如上圖),請使用下面命令切換。
npm config set registry https://registry.npmjs.org/
4 .如果不是第一次發(fā)布,使用 npm login
命令,輸入賬號密碼郵箱,登錄。
5 .使用 yarn publish
發(fā)布包,成功提示如下。
6 .可以在 npm
首頁查詢發(fā)布過的包,如下示例:
經驗: 首先要注冊 npm 的賬號,并且驗證郵箱,如果發(fā)布失敗,會有 yarn-error.log 文件,此時請檢查是否有 npm 賬號驗證等問題。
4. 小結
本章主要向大家總結了在日常開發(fā)中常用的 yarn 命令,希望大家在平時的開發(fā)中多多運用,多多實踐。關于 yarn 的其他知識點,請關注后續(xù)的 yarn 系列課程。