一、yarn的背景和介紹
一直以來(lái),我們?cè)诎惭b和管理依賴(lài)的時(shí)候基本上都會(huì)使用npm,npm是一個(gè)非常優(yōu)秀全面且廣受歡迎的包管理工具,它奠定了前端模塊化開(kāi)發(fā)的基石,為前端的發(fā)展做出了不可磨滅的貢獻(xiàn)。
yarn就是一個(gè)類(lèi)似于npm的包管理工具,它是由facebook推出并開(kāi)源。鑒于facebook在前端界的影響力,yarn一面世就很受矚目,受到了前端界的廣泛歡迎。
與npm相比,yarn有著眾多的優(yōu)勢(shì),主要的優(yōu)勢(shì)在于:速度快,離線(xiàn)模式,版本控制。
1、速度快。
npm會(huì)等一個(gè)包完全安裝完才跳到下一個(gè)包,但yarn會(huì)并行執(zhí)行包,因此速度會(huì)快很多。網(wǎng)上有不少比較npm和yarn安裝同樣多依賴(lài)的執(zhí)行速度,yarn在速度方面優(yōu)勢(shì)明顯。實(shí)際項(xiàng)目中體驗(yàn)一下真是飛一樣的速度,誰(shuí)有試過(guò)誰(shuí)知道~
2、離線(xiàn)模式,
離線(xiàn)的原理比較簡(jiǎn)單,安裝過(guò)的包會(huì)被保存進(jìn)緩存目錄,以后安裝就直接從緩存中復(fù)制過(guò)來(lái),這樣做的本質(zhì)還是會(huì)提高安裝下載的速度,避免不必要的網(wǎng)絡(luò)請(qǐng)求。
3、版本控制
npm用下來(lái)比較強(qiáng)的一個(gè)痛點(diǎn)就是:當(dāng)包 的依賴(lài)層次比較深時(shí),版本控制不夠精確。會(huì)出現(xiàn)相同package.json,但不同人的電腦上安裝出不同版本的依賴(lài)包,出現(xiàn)類(lèi)似 “我電腦上是好的,沒(méi)問(wèn)題呀”的bug很難查找。你可以使用npm-shrinkwrap來(lái)實(shí)現(xiàn)版本固化,版本信息會(huì)寫(xiě)入npm-shrinkwrap.json文件中,但它畢竟不是npm的標(biāo)準(zhǔn)配置。
而yarn天生就能實(shí)現(xiàn)版本固化。會(huì)生成一個(gè)類(lèi)似npm-shrinkwrap.json的yarn.lock文件,文件內(nèi)會(huì)描述包自身的版本號(hào),還會(huì)鎖定所有它依賴(lài)的包的版本號(hào):
yarn.lock存儲(chǔ)這你的每個(gè)包的確切依賴(lài)版本,能確保從本地開(kāi)發(fā)到生產(chǎn)環(huán)境,所有機(jī)器上都有精確相同的依賴(lài)版本。
二、yarn的安裝、用法和基本工作流
1、安裝(以mac為例)
Homebrew
你可以通過(guò) Homebrew 包管理工具安裝 Yarn。 如果你還未安裝 Node.js,Homebrew 會(huì)自動(dòng)為你安裝。
brew update
brew install yarn
設(shè)置路徑
你需要設(shè)置你終端的 PATH
環(huán)境變量,以便全局訪(fǎng)問(wèn) Yarn 的可執(zhí)行文件。
添加`export PATH="$PATH:`yarn global bin`"`
到你的 profile 文件(也可能是 .profile
、.bashrc
、.zshrc
等文件)。
2、用法
初始化一個(gè)新的項(xiàng)目
yarn init
添加一個(gè)依賴(lài)包
yarn add [package]
yarn add [package]@[version]
yarn add [package]@[tag]
更新一個(gè)依賴(lài)包
yarn upgrade [package]
yarn upgrade [package]@[version]
yarn upgrade [package]@[tag]
刪除一個(gè)依賴(lài)包
yarn remove [package]
安裝所有的依賴(lài)包
yarn
or
yarn install
3、工作流
對(duì)于依賴(lài)管理來(lái)說(shuō),在項(xiàng)目中使用一個(gè)新的包管理器就是使用了一個(gè)新的工作流。 Yarn 將盡其最大的努力不侵入你的工作方式,并且使其工作流中的每一步都能簡(jiǎn)單易懂。
您需要知道一些基本的工作流的知識(shí):
創(chuàng)建一個(gè)新的項(xiàng)目
添加/更新/刪除依賴(lài)包
安裝/重新安裝依賴(lài)包
使用版本管理工具(例如 git)
持續(xù)集成
(1)、創(chuàng)建一個(gè)新項(xiàng)目
不論是已經(jīng)有了現(xiàn)成的代碼倉(cāng)庫(kù)(目錄),還是正著手啟動(dòng)一個(gè)全新項(xiàng)目,你都可以使用同樣的方法引入Yarn。
在命令行終端里,跳轉(zhuǎn)到準(zhǔn)備引入Yarn的目錄(通常是一個(gè)項(xiàng)目的根目錄),執(zhí)行以下命令:
yarn init
這將打開(kāi)一個(gè)用于創(chuàng)建Yarn項(xiàng)目的交互式表單,其中包含以下問(wèn)題:
name (your-project):
version (1.0.0):
description:
entry point (index.js):
git repository:
author:
license (MIT):
你既可以回答這些問(wèn)題,也可以直接敲回車(chē)鍵(enter/return)使用默認(rèn)配置或者留空。
現(xiàn)在應(yīng)該創(chuàng)建了一個(gè)和下面文件內(nèi)容類(lèi)似的 package.json
:
{
"name": "my-new-project",
"version": "1.0.0",
"description": "My New Project description.",
"main": "index.js",
"repository": {
"url": "https://example.com/your-username/my-new-project",
"type": "git"
},
"author": "Your Name <you@example.com>",
"license": "MIT"
}
執(zhí)行yarn init
之后,除了以上文件被創(chuàng)建之外,沒(méi)有任何副作用。你可以隨意編輯此文件。
package.json
文件里存儲(chǔ)了項(xiàng)目的有關(guān)信息。 包括項(xiàng)目名稱(chēng)、維護(hù)者信息、代碼托管地址,以及最重要的:項(xiàng)目依賴(lài)。
(2)、管理依賴(lài)項(xiàng)
你需要了解幾若干個(gè)用于增加、更新、刪除依賴(lài)項(xiàng)的命令。
每個(gè)命令都會(huì)更新package.json
和yarn.lock
文件。
在使用一個(gè)包之前,你需要執(zhí)行以下命令將其加入依賴(lài)項(xiàng)列表:
yarn add [package]
[package]
會(huì)被加入到package.json
文件中的依賴(lài)列表,同時(shí)yarn.lock
也會(huì)被更新。
{
"name": "my-package",
"dependencies": {
+ "package-1": "^1.0.0"
}
}
你可以用以下參數(shù)添加其它類(lèi)型的依賴(lài):
-
yarn add --dev
添加到devDependencies
-
yarn add --peer
添加到peerDependencies
-
yarn add --optional
添加到optionalDependencies
通過(guò)指定依賴(lài)版本和標(biāo)簽,你可以安裝一個(gè)特定版本的包:
yarn add [package]@[version]
yarn add [package]@[tag]
[version]
或 [tag]
會(huì)被添加到 package.json
,并在安裝依賴(lài)時(shí)被解析。
例如:
yarn add package-1@1.2.3
yarn add package-2@^1.0.0
yarn add package-3@beta
{
"dependencies": {
"package-1": "1.2.3",
"package-2": "^1.0.0",
"package-3": "beta"
}
}
更新依賴(lài)包
yarn upgrade [package]
yarn upgrade [package]@[version]
yarn upgrade [package]@[tag]
這會(huì)更新package.json
和yarn.lock
文件。
{
"name": "my-package",
"dependencies": {
- "package-1": "^1.0.0"
+ "package-1": "^2.0.0"
}
}
刪除依賴(lài)包
yarn remove [package]
這會(huì)更新package.json
和yarn.lock
文件。
(3)、安裝依賴(lài)項(xiàng)
如果剛從版本控制系統(tǒng)里 checkout 一個(gè)包,則需要為其安裝依賴(lài)。
如果是為現(xiàn)有的包增加依賴(lài),那么這些新的依賴(lài)會(huì)自動(dòng)安裝。
yarn install
是用于安裝一個(gè)項(xiàng)目的所有依賴(lài)。 Yarn會(huì)從package.json
中讀取依賴(lài),并將依賴(lài)信息存儲(chǔ)到yarn.lock
中。
如果你正在開(kāi)發(fā)一個(gè)包,通常你會(huì)在以下情況之后進(jìn)行依賴(lài)安裝:
- 你剛檢出需要這些依賴(lài)項(xiàng)的項(xiàng)目代碼。
- 項(xiàng)目的另一個(gè)開(kāi)發(fā)者添加了新的依賴(lài),你需要用到。
安裝選項(xiàng)
有很多參數(shù)可以控制依賴(lài)安裝的過(guò)程,包括:
- 安裝所有依賴(lài):
yarn
或yarn install
- 安裝一個(gè)包的單一版本:
yarn install --flat
- 強(qiáng)制重新下載所有包:
yarn install --force
- 只安裝生產(chǎn)環(huán)境依賴(lài):
yarn install --production
您可以傳遞給 yarn install
的 完整參數(shù)列表。
(4)、配合版本控制
為了使其他人能夠使用你的包,或者能夠?qū)ζ溥M(jìn)行后續(xù)開(kāi)發(fā),你需要確保將所有必須的文件提交到你所使用的版本控制系統(tǒng)。
為了別人能使用你的包,以下文件必須被提交進(jìn)版本控制系統(tǒng):
-
package.json
:包含包的所有依賴(lài)信息; -
yarn.lock
:記錄每一個(gè)依賴(lài)項(xiàng)的確切版本信息; - 包實(shí)現(xiàn)功能的實(shí)際項(xiàng)目代碼。