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