https://www.yarnpkg.com/en/docs/yarn-workflow
将包管理器引入您的项目会引入围绕依赖项的新工作流。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以反映更改。
{
"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"
}
}
升级依赖
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用于安装项目的所有依赖项。从项目的package.json文件中检索依赖关系,并将其存储在yarn.lock文件中。开发软件包时,安装依赖项通常是在执行以下操作:
- 您刚刚签出了需要这些依赖项才能起作用的项目的代码。
- 该项目的另一位开发人员添加了一个新的依赖项,您需要对其进行选择。
安装选件
有许多安装依赖项的选项,包括:
安装所有依赖项:yarn或yarn install
安装软件包的一个且仅一个版本:yarn install --flat
强制重新下载所有软件包:yarn install --force
仅安装生产依赖项:yarn install --production
查看可以传递给yarn安装的标志的完整列表https://www.yarnpkg.com/en/docs/cli/install。
引入所需文件
为了使人们成功开发或使用您的软件包,您需要确保将所有必需的文件都签入源代码控制系统。
必须将以下文件检入源代码管理中,任何人都可以管理您的软件包:
- package.json:它具有您软件包的所有当前依赖项。
- yarn.lock:这将为您的软件包存储每个依赖项的确切版本。
- 提供软件包功能的实际源代码。
请查看Yarn示例包,以了解Yarn包所需的最低要求。
持续集成
yarn可以轻松地用于各种持续集成系统中。为了加快构建速度,可以在各个构建之间保存Yarn缓存目录。
AppVeyor CircleCI Codeship Travis Semaphore Solano GitLab Codefresh
待续。。。