Yarn是一个流行的JavaScript包管理工具,它提供了许多常用的操作命令来管理项目的依赖、运行脚本等。以下是一些Yarn的常用操作命令及其解释:
一、项目初始化与依赖管理
-
yarn init
- 初始化一个新的Yarn项目,生成
package.json文件。 - 可以通过添加
--yes或-y标志来跳过会话,使用默认值生成package.json。
- 初始化一个新的Yarn项目,生成
-
yarn install
- 安装项目所需的所有依赖包,根据
package.json文件中的依赖列表进行安装。 - 可以使用
--force标志来强制重新安装所有包。
- 安装项目所需的所有依赖包,根据
-
yarn add
- 安装指定的依赖包,并将其添加到
package.json和yarn.lock文件中。 - 可以通过添加版本号(如
@1.2.3)来安装特定版本的包。 - 可以使用
--dev或-D标志来安装开发依赖,这些依赖通常只在开发时使用。
- 安装指定的依赖包,并将其添加到
-
yarn remove
- 移除指定的依赖包,并从
package.json和yarn.lock文件中删除它。
- 移除指定的依赖包,并从
-
yarn upgrade
- 更新项目依赖包的版本,根据
package.json中指定的版本范围进行更新。 - 可以使用
<package>来指定更新某个特定的包。 - 可以使用
--latest标志来忽略版本规则,将依赖包升至最新版。
- 更新项目依赖包的版本,根据
-
yarn outdated
- 检查项目中是否有过时的依赖包,并列出可以升级的版本。
二、脚本运行与项目构建
-
yarn start
- 启动项目,通常运行
package.json中定义的start脚本。
- 启动项目,通常运行
-
yarn build
- 构建项目,通常运行
package.json中定义的build脚本。
- 构建项目,通常运行
-
yarn test
- 运行项目中定义的测试脚本,通常运行
package.json中定义的test脚本。
- 运行项目中定义的测试脚本,通常运行
-
yarn run
- 运行
package.json的scripts字段中定义的自定义脚本。
- 运行
三、包发布与全局安装
-
yarn publish
- 发布一个包到npm上,需要先在npm上注册账号并登录。
-
yarn global add
- 全局安装一个依赖包,使其可以在命令行中全局访问。
-
yarn global remove
- 全局卸载一个依赖包。
-
yarn global list
- 列出所有全局安装的包。
四、配置与缓存管理
-
yarn config set
- 设置Yarn配置选项,如设置镜像源等。
- 可以使用
--global或-g标志来设置全局配置。
-
yarn config get
- 获取Yarn配置选项的值。
-
yarn config delete
- 删除Yarn配置选项。
-
yarn config list
- 显示当前Yarn配置。
-
yarn cache list
- 列出已缓存的每个包。
-
yarn cache dir
- 返回全局缓存位置。
-
yarn cache clean
- 清除Yarn缓存。
五、其他常用命令
-
yarn info
- 显示某个包的信息,如最新版本、依赖关系等。
- 可以使用
--json标志来以JSON格式输出信息。
-
yarn list
- 列出项目的所有依赖,包括直接依赖和间接依赖。
- 可以使用
--depth=0等标志来限制依赖的深度。
-
yarn link
- 在本地创建一个全局链接,使得其他项目可以使用当前项目中的包(通常用于开发阶段)。
-
yarn why
- 查找某个包为什么被安装到项目中,显示其依赖路径。
-
yarn version
- 显示Yarn的版本信息,或者用于更新项目的版本号(需要配合其他命令或参数使用)。
这些命令涵盖了Yarn的大部分常用操作,通过熟练使用这些命令,可以高效地管理项目的依赖、运行脚本、发布包等。