发布npm包到GitLab教程

之前在研究如何搭建UI组件库(内部使用),其中重要的一步就是发布npm包到GitLab。中间踩了很多坑,在这里记录一下整个流程方便大家快速上手。不足之处欢迎指出🙏

1. 获取Token

在gitlab中打开access tokens申请页面,新增一个至少拥有read_registry,write_registry权限的Token,建议全部勾选,申请后保存下来。


2.新建项目

新建一个文件夹npm-demo,目录结构如下:

执行命令npm init创建一个package.json文件,按照提示填写相关内容(一般默认即可,后面还可以改)。

json 复制代码
// package.json
{
  "name": "@scope/npm-demo", // scope 换成自己的项目组
  "version": "1.0.1",   // 版本号,每次发布要修改,不能重复
  "description": "publish the npm package to gitlab",
  "main": "index.js",   // 入口文件
  "type": "module",  // 使用 ES 模块规范(index.js中用到了export)
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "npm",
    "gitlab"
  ],
  "author": "joshuali",
  "license": "ISC"
}

新建一个js文件,写一个sum函数

js 复制代码
// index.js
export function sum(a, b) {
  return a + b;
}

新建一个npm配置文件.npmrc,内容如下

plaintext 复制代码
# .npmrc
@scope:registry=https://your_domain_name/api/v4/projects/your_project_id/packages/npm/
//your_domain_name/api/v4/projects/your_project_id/packages/npm/:_authToken="${NPM_TOKEN}"

@scope替换为要发布包的项目组名。

your_domain_name替换为你们公司gitlab的域名。注意前面是https还是http

your_project_id替换为项目 ID,可在项目概述页面上找到。

"${NPM_TOKEN}"与您稍后在流程中创建的令牌相关联。

3.推送包

  • 在git bash窗口:
    NPM_TOKEN=your_token npm publish
  • 在powershell窗口:
    $env:NPM_TOKEN="your_token"
    npm publish

打开gitlab可以看到刚刚推送成功的包。

4.下载包

当前目录没有.npmrc文件:

npm config set -- //your_domain_name/:_authToken=your_token

npm config set -- //your_domain_name/api/v4/projects/your_project_id/packages/npm/:_authToken=your_token

npm install @scope/包名称

当前目录有.npmrc文件:

  • 在git bash窗口:
    NPM_TOKEN=your_token npm install @scope/包名称
  • 在powershell窗口:
    $env:NPM_TOKEN="your_token"
    npm install @scope/包名称

5.使用

参考资料:包注册表中的 npm 包 |GitLab的

相关推荐
veneno4 小时前
大量异步并发请求控制并发解决方案
前端
i***t9195 小时前
Spring Boot项目接收前端参数的11种方式
前端·spring boot·后端
oden5 小时前
2025博客框架选择指南:Hugo、Astro、Hexo该选哪个?
前端·html
小光学长5 小时前
基于ssm的宠物交易系统的设计与实现850mb48h(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。
java·前端·数据库
云中飞鸿5 小时前
函数:委托
javascript
小小前端要继续努力5 小时前
渐进增强、优雅降级及现代Web开发技术详解
前端
老前端的功夫6 小时前
前端技术选型的理性之道:构建可量化的ROI评估模型
前端·javascript·人工智能·ubuntu·前端框架
狮子座的男孩6 小时前
js函数高级:04、详解执行上下文与执行上下文栈(变量提升与函数提升、执行上下文、执行上下文栈)及相关面试题
前端·javascript·经验分享·变量提升与函数提升·执行上下文·执行上下文栈·相关面试题
爱学习的程序媛7 小时前
《JavaScript权威指南》核心知识点梳理
开发语言·前端·javascript·ecmascript
乐观主义现代人7 小时前
go 面试
java·前端·javascript