Yarn 配置的操作方法

发布时间：2023-04-26 13:13:32 所属栏目：教程来源：

导读：使用Yarn中需要了解Yarn 配置的操作方法。

接下来通过讲解Yarn 配置中会用到的文件：package.json、envvars、.yarnrc、yarn.lock，一一进行详细的解答。

配置你的包
Yarn 使用 package.json 文件来标识每个包

使用Yarn中需要了解Yarn 配置的操作方法。

接下来通过讲解Yarn 配置中会用到的文件：package.json、envvars、.yarnrc、yarn.lock，一一进行详细的解答。

配置你的包
Yarn 使用 package.json 文件来标识每个包，并配置 yarn 在那个包里的运行方式。

pet-kitten 包的配置可以在 pet-kitten/package.json 找到：

{
"name": "pet-kitten",
"version": "0.1.0",
"main": "pet.js",
"dependencies": {
"hand": "1.0.0"
}
}
使用 yarn.lock 文件来固化依赖
除了 package.json 文件，yarn 也使用 <0>yarn.lock</0> 文件来确保依赖解析又快又稳。你无需编辑这个文件，yarn自己搞定。

为了保证你应用的行为保持一致，你应该把 yarn.lock 文件提交到代码仓库。

package.json
name 和 version 是 package.json 文件里最重要的两个字段，没有它们你的包无法被安装。 name 和 version 字段一起用来创建一个唯一 id。

name
{
"name": "my-awesome-package"
}
这是你的包的名字。它在 URL 中、作为命令行参数、作为 node_modules 里的目录名使用。

yarn add [name]
node_modules/[name]

https://registry.npmjs.org/[name]/-/[name]-[version].tgz
规则
必须少于或等于 214 个字符（对于限定域的包来说包括 @scope/）。

不能以句点 (.) 或者下划线 (_) 开头。

名字里不能有大写字母。

必须只使用 URL 安全的字符。

Tips
不要使用和 Node.js 核心模块相同的名字。

不要在名字里包含 js 或者 node 单词。

短小精悍，让人看到名字就大概了解包的功能，记住它也会被用在 require() 调用里。

保证名字在 registry 里是唯一的。

version
{
"version": "1.0.0"
}
包的当前版本号。

信息类字段
description
{
"description": "我的包的简短描述"
}
Description 是帮助使用者了解包的功能的字符串，包管理器也会把这个字符串作为搜索关键词。

keywords
{
"keywords": ["short", "relevant", "keywords", "for", "searching"]
}
关键字是一个字符串数组，当在包管理器里搜索包时很有用。

license
{
"license": "MIT",
"license": "(MIT or GPL-3.0)",
"license": "SEE LICENSE IN LICENSE_FILENAME.txt",
"license": "UNLICENSED"
}
所有包都应该指定许可证，以便让用户了解他们是在什么授权下使用此包，以及此包还有哪些附加限制。

鼓励使用开源 (OSI-approved) 许可证，除非你有特别的原因不用它。如果你开发的包是你工作的一部分，最好和公司讨论后再做决定。

license字段必须是以下之一：

如果你使用标准的许可证，需要一个有效地 SPDX 许可证标识。

如果你用多种标准许可证，需要有效的 SPDX 许可证表达式2.0语法表达式。

如果你使用非标准的许可证，一个 SEE LICENSE IN <文件名> 字符串指向你的包里顶级目录的一个 <文件名>。

如果你不想在任何条款下授权其他人使用你的私有或未公开的包，一个 UNLICENSED 字符串。

链接类字段
各种指向项目文档、issues 上报，以及代码托管网站的链接字段。

homepage
{
"homepage": "https://your-package.org"
}
homepage 是包的项目主页或者文档首页。

bugs
{
"bugs": "https://github.com/user/repo/issues"
}
问题反馈系统的 URL，或者是 email 地址之类的链接。用户通过该途径向你反馈问题。

repository
{
"repository": { "type": "git", "url": "https://github.com/user/repo.git" },
"repository": "github:user/repo",
"repository": "gitlab:user/repo",
"repository": "bitbucket:user/repo",
"repository": "gist:a1b2c3d4e5f"
}
repository 是代码托管的位置。

（编辑：汽车网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!