Yarn 入门

Yarn 是快速、可靠、安全的 js 包管理器。

关键词： nodejs, 包管理, yarn

简介

Yarn 是快速、可靠、安全的 js 包管理器。

• 快速 - Yarn 会缓存它下载的每一个包，因此无需重复下载。它还能并行化操做以最大化资源利用率，安装速度之快史无前例。
• 安全 - Yarn 会在每一个安装包被执行前校验其完整性。
• 可靠 - Yarn 使用格式详尽而又简洁的 lockfile 文件和肯定性算法来安装依赖，可以保证在一个系统上的运行的安装过程也会以一样的方式运行在其余系统上。

安装

先决条件：已安装 Nodejs。

执行命令：npm i -g yarn

虽然还有其余安装方式，但并不推荐。

Yarn 工做流

Yarn 工做流：

1. 建立一个新项目
2. 增长／更新／删除依赖
3. 安装／重装你的依赖
4. 引入版本控制系统（例如 git）
5. 持续集成

Yarn 经常使用命令

每一个命令都会更新 package.json 和 yarn.lock 文件。

初始化新项目

yarn init

添加依赖包

在使用一个包以前，你须要执行如下命令将其加入依赖项列表：

yarn add [package]

[package]会被加入到package.json文件中的依赖列表，同时yarn.lock也会被更新。

{
    "name": "my-package",
    "dependencies": {
+     "package-1": "^1.0.0"
    }
  }

你能够用如下参数添加其它类型的依赖：

• 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"
  }
}

将依赖项添加到不一样依赖项类别

分别添加到 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]

这会更新package.json和yarn.lock 文件。

{
    "name": "my-package",
    "dependencies": {
-     "package-1": "^1.0.0"
+     "package-1": "^2.0.0"
    }
  }

删除依赖包

yarn remove [package]

这会更新package.json和yarn.lock 文件。

安装依赖项

yarn install 是用于安装一个项目的全部依赖。 Yarn 会从 package.json 中读取依赖，并将依赖信息存储到 yarn.lock 中。

若是你正在开发一个包，一般你会在如下状况以后进行依赖安装：

• 你刚检出须要这些依赖项的项目代码。
• 项目的另外一个开发者添加了新的依赖，你须要用到。

有不少参数能够控制依赖安装的过程，包括：

• 安装全部依赖 - yarn 或 yarn install
• 安装一个包的单一版本 - yarn install --flat
• 强制从新下载全部包 - yarn install --force
• 只安装生产环境依赖 - yarn install --production

参考：yarn install 的 完整参数列表。

建立一个新项目

不管是已经有了现成的代码仓库（目录），仍是正着手启动一个全新项目，你均可以使用一样的方法引入 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 - 包含包的全部依赖信息；
• yarn.lock - 记录每个依赖项的确切版本信息；
• 包实现功能的实际项目代码。

请参阅Yarn Example Package项目，查看一个可用的 Yarn 包所需的最少文件配置。

如今应该建立了一个和下面文件内容相似的 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文件里存储了项目的有关信息。 包括项目名称、维护者信息、代码托管地址，以及最重要的：项目依赖。

引用和引伸

👉 欢迎阅读 个人前端技术教程系列：frontend-tutorial

• Yarn Github
• Yarn 官方文档