Node私库Verdaccio使用记录,包的构建,推送和拉取

时间:2024-05-04 07:10:47

Node私库Verdaccio使用记录,包的构建,推送和拉取

Verdaccio是一个轻量级的私有npm代理注册中心,它可以帮助你在本地搭建一个npm仓库,非常适合企业内部使用。通过使用Verdaccio,你可以控制和缓存依赖包,提高安装效率,并保证项目依赖的安全性和可靠性。下面我们将详细介绍如何使用Verdaccio进行包的构建、推送和拉取。

安装和配置Verdaccio

具体可以参考文章:ubuntu搭建node私库Verdaccio

创建Vue 3项目作为示例

首先,你需要安装最新版本的Node.js和npm。安装好之后,我们可以使用Vue CLI来创建一个新的Vue 3项目。以下是创建新项目的步骤:

  1. 安装Vue CLI:

    npm install -g @vue/cli
    
  2. 创建一个新的Vue 3项目:

    npm create vue@latest
    
  3. 进入项目文件夹,修改或添加必要的文件以准备将其发布为npm包。你可能需要更新package.json文件,添加如main字段指定入口文件,version字段定义包版本等。

推送包到Verdaccio

要将包推送到本地的Verdaccio服务器,你需要确保你已经正确设置了npm的发布配置。这通常包括以下几步:

  1. 配置npm以使用Verdaccio:

    npm set registry http://localhost:4873
    

    确保Verdaccio服务正在运行并且可以访问。

  2. 登录到你的Verdaccio服务:

    npm login --registry http://localhost:4873
    

    输入你的用户名、密码和邮箱地址。

  3. 发布包:

    npm publish
    

确保你的package.json中的版本号是新的,否则你需要更新版本号才能再次发布。

推送成功后,可以在Verdaccio WEB页面看到刚刚推送的包

在这里插入图片描述

从Verdaccio拉取包

配置npm或yarn以从你的Verdaccio服务器拉取包非常简单。你需要修改npm或yarn的配置,使其指向你的Verdaccio仓库:

  1. 为npm或yarn设置registry:
    npm config set registry http://localhost:4873
    

或者,你可以在项目的package.json中添加或修改publishConfig字段:

"publishConfig": {
  "registry": "http://localhost:4873"
}

这样,当你使用npm或yarn安装依赖时,它将首先尝试从你的私有仓库中拉取依赖。

npm install命令指定私库拉取包

在特定项目中,如果你只想从Verdaccio拉取特定的包而不是所有包,你可以在安装命令中指定registry参数。这可以用于在项目中测试或使用特定版本的包,而不影响全局npm配置。以下是如何进行设置的示例:

npm install <package-name> --registry http://localhost:4873

使用这个命令,npm将仅对指定的包使用你的Verdaccio服务器,其他包将使用默认或全局配置的registry。这种方法对于在不同源之间切换特定包非常有用,特别是在开发和测试新版本的包时。

这样,你可以灵活地管理你的依赖源,确保开发环境的稳定性和项目的灵活性。

在这里插入图片描述

package-name在包详情的installation中可以看到。

常见问题及解决方案

推送包到Verdaccio时报错

报错内容如下:

npm notice Publishing to http://localhost:4873/ with tag latest and default access
npm ERR! code EPUBLISHCONFLICT
npm ERR! publish fail Cannot publish over existing version.
npm ERR! publish fail Update the 'version' field in package.json and try again.
npm ERR! publish fail
npm ERR! publish fail To automatically increment version numbers, see:
npm ERR! publish fail     npm help version

npm ERR! A complete log of this run can be found in:
npm ERR!     

遇到的错误提示是 EPUBLISHCONFLICT,这意味着试图发布的npm包的版本号已经存在于私有库中,因此无法再次使用相同的版本号进行发布。这是为了防止覆盖已经发布的版本造成潜在的问题。要解决这个问题,可以按照以下步骤操作:

1. 更新版本号

在你的package.json文件中,找到version字段,并更新它。常见的版本号遵循语义化版本控制规则,格式通常为主版本号.次版本号.修订号(例如,1.0.0)。

  • 主版本号:当你做了不兼容的 API 修改,
  • 次版本号:当你做了向下兼容的功能性新增,
  • 修订号:当你做了向下兼容的问题修正。

你可以根据你的更改适当地增加这些数字。例如,如果你修复了一个小bug,可以增加修订号:

"version": "1.0.1"

2. 自动更新版本号

如果你希望自动更新版本号,可以使用npm的version命令,这会根据需要自动增加版本号,并修改package.json文件,同时还会创建一个版本提交(如果你的项目是一个git仓库):

npm version patch  # 小修小改,如修复bug
npm version minor  # 新功能但不影响老功能
npm version major  # 大改,可能影响现有功能

选择patchminormajor取决于你的更新内容。

3. 重新发布

更新版本号后,你可以尝试重新发布你的包:

npm publish

参考链接

  • Verdaccio官网:https://verdaccio.org/
  • npm官方文档:https://docs.npmjs.com/
  • yarn官方文档:https://classic.yarnpkg.com/en/docs

在这里插入图片描述