Gitlab搭建npm仓库

标签：npm notice gitlab frontend lib helper Gitlab 搭建

由于图片和格式解析问题，为了更好阅读体验可前往阅读原文

:::warning
使用gitlab的仓库注册表特性需要版本14.0+，如果你的版本比较低，请先根据自己的需求合理升级后再使用
:::

npm私有仓库的搭建方式有很多种，比如使用docker(阅读此篇)，这里讲述如何使用gitlab作为npm仓库方法，gitlab仓库有多种使用方法，这里都会讲解到。接下来就来学习下如何使用gitlab搭建npm仓库。

创建组与项目

为了方便演示这里从头讲起，分别创建组、项目

创建组
创建项目

初始化项目

本地创建一个简单的项目，推送到gitlab项目中

# 创建路径
mkdir gitlab-frontend-helper-lib && ccd gitlab-frontend-helper-lib

# 初始化 npm
npm init

package.json文件内容实例：

{
  "name": "helper",
  "version": "0.0.1",
  "description": "前端通用库",
  "main": "index.js",
  "keywords": [],
  "author": "",
  "license": "ISC"
}

创建index.js文件：

const add = (x, y) => x + y;
const minus = (x, y) => x - y;

module.exports = { add, minus };

推送项目到gitlab

git init

cat > .gitignore << EOF
node_modules
.DS_Store
EOF

git add .
git cm -m '初次提交(#0)'
git remote add origin http://192.168.10.10/frontend-lib/helper.git
git push --set-upstream origin main

项目作为依赖

你可以在某个项目中把刚刚上传的项目作为依赖安装，为了方便管理可以对上传的库打上tag，然后项目中可以下载指定tag

# gitlab-frontend-helper-lib 打tag
git tag 0.0.1
git push --tags

新建一个项目使用当前库：

mkdir gitlab-npm && cd gitlab-npm 

npm init -y

手动在package.json文件中添加待安装的依赖项目

{
  "name": "gitlab-npm",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    // 这里指定 helper依赖的地址为 git+http://192.168.10.10/frontend-lib/helper.git，并使用 tag 0.0.1版本
    "helper": "git+http://192.168.10.10/frontend-lib/helper.git#0.0.1"
  },
  "description": ""
}

安装当前项目依赖：

➜ npm i
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN use-gitlab-npm@1.0.0 No description
npm WARN use-gitlab-npm@1.0.0 No repository field.

added 1 package in 0.577s

验证helper包，创建js文件

// index.js
const helper = require("helper");
console.log(helper.add(1, 2));

执行打印

node index.js // 3

这种方式的使用比较简单，不过不够灵活，接下来使用gitlab官方的仓库注册表

Gitlab软件库

Gitlab支持包仓库注册了，也及时可以当做包仓库使用，需要版本14.0+，这里演示npm仓库注册表来管理npm包

注册表类型

gitlab支持两种的仓库注册表项目级别和示例级别(组级别)，两者对于包的上传没有什么影响，只是作用于包的安装，包的注册表名字是scope形式，也就是说包名是@scope/packageName这种形式

实例级别：你可以理解为group级别，必须提供一个范围的scope名字，当你需要在不同的组创建包时，可以使用@scope/packageName 引入，你可以为不同的组设置权限，公开使用
项目级别：注册表 URL仅针对该范围更新。在项目级别注册包时，您可以使用/附加您自己的唯一范围到您的包名称

发布准备

这里修改前面的仓库

// package.json
{
  // 包名
  "name": "@frontend-lib/helper",
  // 包版本
  "version": "0.0.1",
  "description": "前端通用库",
  "main": "index.js",
  "keywords": [],
  "author": "",
  "license": "ISC"
}

创建.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：你的scopename
#  - your_domain_name：你的gitlab域名或ip
#  - your_project_id：你的仓库id
#  - NPM_TOKEN：用户发布的用户token

# 示例
@frontend-lib:registry=http://192.168.10.10/api/v4/projects/4/packages/npm/
# 你可以直接将token写在这里
//192.168.10.10/api/v4/projects/4/packages/npm/:_authToken=HUzUdsos4WfnsgfUBi6j

记得忽略掉.npmrc追踪：

# .gitignore
.npmrc

发布npm包

发布npm包可以手动发布也可以自动构建发布，两种方式都演示下。本次演示项目上传至github了

手动发布

创建token

拿到token后将其写入.npmrc文件中

# 如果没有将token写入npmrc，可以用命令行传入
NPM_TOKEN=HUzUdsos4WfnsgfUBi6j npm publish

# 这里写入了npmrc，然后发布
➜ npm publish
npm notice 
npm notice 
标签：npm,notice,gitlab,frontend,lib,helper,Gitlab,搭建	

From： https://www.cnblogs.com/98kk/p/18672061