关于yarn:如何发布Yarn包

55次阅读

共计 2292 个字符,预计需要花费 6 分钟才能阅读完成。

本节咱们来学习如何公布 Yarn 包,如果咱们心愿通过 Yarn 共享咱们创立好的包给全世界各地的其余开发者,能够将软件包托管到一个可信赖的网站上。

创立软件包

首先咱们须要创立一个软件包,能够通过下列几个命令来创立,如下所示:

> git init my_yarn
> cd my_yarn
> yarn init

看一下这几个命令的执行成果:

其中 git init my_yarn 命令将会初始化创立一个新本地仓库,它在工作目录下生成一个名为 .git 的暗藏文件夹。而后应用 cd my_yarn 命令跳转到指定目录中,通过 yarn init 初始化一个新的我的项目。在执行 yarn init 时会呈现一些问题,依据需要为每个问题输出答案,最终会在根目录下生成一个 package.json 文件。如果想要对所有的问题都应用默认值,能够间接运行 yarn init --yes 命令。

此时 package.json 文件的内容相似上面所示,当然依据输出答案的不同,内容也会有所不同:

<pre spellcheck=”false” class=”md-fences md-end-block contain-cm modeLoaded” lang=”json” contenteditable=”false” cid=”n18″ mdtype=”fences” style=”box-sizing: border-box; overflow: visible; font-family: Consolas, &quot;Liberation Mono&quot;, Courier, monospace; font-size: 0.9em; white-space: normal; display: block; break-inside: avoid; text-align: left; background-image: inherit; background-position: inherit; background-size: inherit; background-repeat: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: rgb(248, 248, 248); position: relative !important; border: 1px solid rgb(223, 226, 229); border-radius: 3px; padding: 8px 1em 6px; margin-bottom: 15px; margin-top: 15px; width: inherit; color: rgb(51, 51, 51); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;”>{
“name”: “my_yarn”,
“version”: “1.0.0”,
“main”: “index.js”,
“author”: “Your Name <you@example.com>”,
“license”: “MIT”
}</pre>

这个文件中一些字段,咱们后面讲 package.json 文件的时候有讲到,特地是 name 字段和 version 字段是不可或缺的。

前面如果咱们还须要在 package.json 文件中增加一些配置,能够手动批改这个文件。

Readme.md 文件

个别状况下,咱们会在公布软件包之前在根目录中编写一个 Readme.md 文件。这个文件用户介绍软件包并记录公共 API。在定义 Readme.md 文件时,须要为用户提供应用咱们软件包的所需全副常识。假如某个人第一个应用这个软件包,可能会遇到很多问题,所以咱们须要在文件中精确并尽可能具体地形容这个软件包,但也要尽量简短和易于浏览。

公布一个包

咱们能够将创立好的 Yarn 软件包公布到 npm 注册表,该注册表用于在寰球范畴内散发软件包。

首先咱们须要登录到 npm,如果还没有账号能够先注册一个账号,网址为:https://www.npmjs.com/。注册账号大家应该都会吧,这里就演示啦。

而后应用 yarn login 命令登录,命令执行成果如下图所示:


这里会提醒要咱们输出用户名和电子邮件,然而不会要求咱们输出明码,因为 Yarn 不会保留明码或任何会话。然而当咱们须要在 npm 上公布或批改某些内容时,就须要用到明码了。

将筹备工作实现后,就能够正式公布软件包啦,公布软件包的命令如下所示:

yarn publish

此时会要求咱们输出要公布的新版本,如下图:

而后有可能呈现报错,通知咱们软件包的名称反复啦,此时咱们须要到 package.json 文件中批改软件包的名称,例如批改为 my_yarn_xkd,而后再次公布,始终到不重名为止:

这样一个软件包就公布胜利啦,咱们能够到官网上去通过软件包名称查找公布后的软件包。

如果咱们在本地对软件包进行了批改,想要在 npm 上更新软件包,则须要先批改 package.json 文件中的版本号,而后再次执行 yarn publish 命令即可。

正文完
 0