把yarn常见使用方法列在这,方便自己查阅,大家也可以直接到官网查看,这些内容在官网上都有,我转录在这里,只是为了加强记忆。
先看官网的介绍,清晰明了,对我来说就是,将会是Yarn比npm好用,可以用yarn来替代npm,两者之间用法相似,但最好不要混合使用:
Yarn 对你的代码来说是一个包管理器, 你可以通过它使用全世界开发者的代码,或者分享自己的代码。 Yarn 做这些快捷、安全、可靠,所以你不用担心什么。
通过Yarn你可以使用其他开发者针对不同问题的解决方案,使自己的开发过程更简单。 使用过程中遇到问题,你可以将其上报或者贡献解决方案。一旦问题被修复,Yarn会更新保持同步。
代码通过包(package)(或者称为模块(module))的方式来共享。 一个包里包含所有需要共享的代码,以及描述包信息的文件,称为package.json.
安装
在常见的 Linux 系统上,比如说 Debian、Ubuntu 和 CentOS,推荐通过我们的包来安装 Yarn,没必要记忆,安装的时候直接官网走起。
$curl -o- -L https://yarnpkg.com/install.sh | bash
或者
通过 npm 安装:
$npm install --global yarn
运行命令来测试 Yarn 是否安装:
$yarn --version
1.15.2
入门使用
- 初始化新项目
$yarn init
- 添加依赖包
$yarn add [package]
$yarn add [package]@[version]
$yarn add [package]@[tag]
- 将依赖项添加到不同依赖项类别
分别添加到 devDependencies、peerDependencies 和 optionalDependencies:
$yarn add [package] --dev
$yarn add [package] --peer
$yarn add [package] --optional
- 升级依赖包
$yarn upgrade [package]
$yarn upgrade [package]@[version]
$yarn upgrade [package]@[tag]
5.移除依赖包
$yarn remove [package]
- 安装项目的全部依赖
$yarn
或者
$yarn install
Yarn 工作流
你的项目在引入了包管理器的同时,也引入了一套新的围绕着依赖项开发的工作流程。Yarn尽力不改变你的工作流程,并使流程中的每一步都简单明了.
关于基本工作流你应该知道几个简单的事:
- 创建一个新项目
- 增加/更新/删除依赖
- 安装/重装你的依赖
- 引入版本控制系统(例如 git)
- 持续集成
创建一个项目:
不论是已经有了现成的代码仓库(目录),还是正着手启动一个全新项目,你都可以使用同样的方法引入Yarn。
在命令行终端里,跳转到准备引入Yarn的目录(通常是一个项目的根目录),执行以下命令:
$yarn init
这将打开一个用于创建Yarn项目的交互式表单,其中包含以下问题:
name (your-project):
version (1.0.0):
description:
entry point (index.js):
git repository:
author:
license (MIT):
你既可以回答这些问题,也可以直接敲回车键(enter/return)使用默认配置或者留空。
package.json
现在应该创建了一个和下面文件内容类似的 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"
}
执行yarn init之后,除了以上文件被创建之外,没有任何副作用。你可以随意编辑此文件。
管理依赖项
package.json文件里存储了项目的有关信息。 包括项目名称、维护者信息、代码托管地址,以及最重要的:项目依赖。
你需要了解几若干个用于增加、更新、删除依赖项的命令。
每个命令都会更新package.json和yarn.lock 文件。
- 添加依赖包
在使用一个包之前,你需要执行以下命令将其加入依赖项列表:
yarn add [package]
[package]会被加入到package.json文件中的依赖列表,同时yarn.lock也会被更新。
你可以用以下参数添加其它类型的依赖:
-
yarn add --dev
添加到devDependencies
-
yarn add --peer
添加到peerDependencies
-
yarn add --optional
添加到optionalDependencies
yarn add [package]@[version]
yarn add [package]@[tag]
[version]
或 [tag]
会被添加到 package.json
,并在安装依赖时被解析。
例如:
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"
}
}
2.更新依赖包
yarn upgrade [package]
yarn upgrade [package]@[version]
yarn upgrade [package]@[tag]
这会更新package.json和yarn.lock 文件。
{
"name": "my-package",
"dependencies": {
- "package-1": "^1.0.0"
+ "package-1": "^2.0.0"
}
}
3.删除依赖包
yarn remove [package]
这会更新package.json
和yarn.lock
文件。
如果刚从版本控制系统里 checkout 一个包,则需要为其安装依赖。
如果是为现有的包增加依赖,那么这些新的依赖会自动安装。
安装依赖项
yarn install
是用于安装一个项目的所有依赖。 Yarn会从package.json
中读取依赖,并将依赖信息存储到yarn.lock
中。
如果你正在开发一个包,通常你会在以下情况之后进行依赖安装:
- 你刚检出需要这些依赖项的项目代码。
- 项目的另一个开发者添加了新的依赖,你需要用到。
-
安装选项
有很多参数可以控制依赖安装的过程,包括: -
安装所有依赖:
yarn
或yarn install
-
安装一个包的单一版本:
yarn install --flat
-
强制重新下载所有包:
yarn install --force
-
只安装生产环境依赖:
yarn install --production
查看您可以传递给 yarn install
的 完整参数列表。
配合版本控制
为了使其他人能够使用你的包,或者能够对其进行后续开发,你需要确保将所有必须的文件提交到你所使用的版本控制系统。
所需的文件
为了别人能使用你的包,以下文件必须被提交进版本控制系统:
-
package.json
:包含包的所有依赖信息; -
yarn.lock
:记录每一个依赖项的确切版本信息; - 包实现功能的实际项目代码。
请参阅Yarn Example Package项目,查看一个可用的Yarn包所需的最少文件配置。
网友评论