首页

如何使用 NPM 和 GitLab 管理安装私有前端公共库

如何使用 NPM 和 GitLab 管理安装私有前端公共库 - 八云酱

大部分公司都会私有部署 GitLab 来管理项目代码。这里简单记录一下如何创建一个私有公共库并将其安装到前端项目里去。

创建项目

现在我们创建一个 HelloWorld 公共库项目,然后在其中使用 npm init 初始化一个 package.json 文件,内容参考如下。

{
  "name": "HelloWorld",
  "version": "1.0.0",
  "private": true,
  "description": "HelloWorld",
  "main": "index.js",
  "repository": {
    "type": "git",
    "url": "git@git.example.com:bayunjiang/HelloWorld.git"
  },
  "author": "bayunjiang",
  "license": "ISC"
}

其中 private 字段需要自己增加,这个字段可以防止代码被公开发布。

我们新建一个 index.js 文件,在其中写一个示例函数,内容参考如下。

const HelloWorld = () => {
  console.log('Hello World')
}

export { HelloWorld }

保存并提交到远程分支之后我们基于当前代码打一个 1.0.0 标签。

安装依赖

运行如下代码在项目里引用上述公共库。

npm install -S git+ssh://git@git.example.com:bayunjiang/HelloWorld.git#1.0.0

项目地址请使用 SSH 地址,使用前需要先自行配置公钥。

安装完成之后我们可以在package.json 文件中看到如下内容。

"dependencies": {
    "@bayunjiang/HelloWorld": "git+ssh://git@git.example.com:bayunjiang/HelloWorld.git#1.0.0"
}

如何使用

实际开发中直接使用 HelloWorld 模块即可。

import { HelloWorld } from '@bayunjiang/HelloWorld'

HelloWolrd()