公司级前端组件共享协作方式 - NPM私有源-verdaccio搭建

96
kyle背背要转运
0.9 2018.11.12 13:38* 字数 1046

为什么要共享组件? 都2019年了...还ctrl+c > ctrl+v,多处维护吗?
为什么要搭私有源? 公司代码扔到github/npm官方源上不好吧...有的小伙伴cnpm,有的小伙伴npm ,安装有的能安装上有的安装不上吧...打包机/docker 每次npm install 慢不慢?

怎么才能优雅的开发、使用、共享 前端组件、前端代码

场景: A-git仓库里面有个 日历组件,可以给B-git仓库使用
git子仓库 : 没有版本,更新麻烦,要加配置
github + npm公有源: 公司代码扔到外网去,有暴露敏感信息的风险,且npm一旦发布就只能通过 邮件方式撤销
gitlab+ npm私有源:gitlab是内网自己的,还有个能发布的私有源,对于持续集成方面,还有更棒的优势,对比一下,就立判高下了

为什么要用私有源

  1. 加速公有npm包安装速度
  2. 避免本地 npm install 指向源 还要翻墙处理,避免cnpm等其他源拉取npm包不及时的问题
  3. 私有源会把已经使用的npm包缓存下来,提升个人本地/打包环境npm包的安装速度
  4. 会先从官方源 获取再缓存在私有源服务器上,私有源始终走私有源储存
  5. 私有源包含一些 自主开发的公共包,可以在多个 git仓库 项目中 通过npm的方式使用
  6. 把公共代码上传到 私有源,而不是上传到github,避免公司代码及敏感信息的暴露,如果有开源需求,再走开源流程
  7. A仓库 封装了一个 video组件,想给B仓库使用。那就可以制作一个 video组件仓库,然后发布到 私有源上。A和B仓库使用的时候就 npm install 组件库,let api = require('组件库') 啦~ 这个步骤和 发公有npm包是一模一样的,只是发的位置不一样而已。

准备工作

  1. https://verdaccio.org/docs/zh-CN/authentification按照这个一步一步来就行
  2. 如果是本地电脑 不需要改 verdaccio的 config.yaml配置文件,如果是服务器部署,那你需要改 config.yaml的配置
  3. 我们这里按服务器部署为例子
  4. 你需要先安装上 node npm pm2
  5. npm install -g verdaccio
  6. 创建一个 非root的账户
  7. 在此账户下 执行verdaccio,且找到 config.yaml文件,
  8. vim 修改 config.yaml,新增一行,保存
listen:
  0.0.0.0:4873              # listen on all addresses (INADDR_ANY)
  1. verdaccio 跑一下,显示一下内容就正常了
齐活~

日常使用 -- 切换npm源

  1. 打开命令行工具
  2. 安装npm切换源的快捷工具 npm/nrm: npm install -g nrm
  3. 输入命令: nrm ls
  4. 输入命令: nrm add 源名字 源地址
  5. 输入命令: nrm use 源名字
  6. 输入命令: nrm ls
  7. 当时源指向哪里,前面就有个小星星
nrm切换私有源

日常使用 -- 添加私有源用户

  1. 确保你的npm源指向为 你的私有源

  2. 输入命令: npm adduser

  3. 输入username: 邮箱前缀

  4. 输入password: 自定义密码

  5. 输入Email:邮箱

  6. 添加私有源用户
  7. 注册好账号,才能上传 npm包

  8. 对于开发者,除了注册账号是根据 私有源创建的,和官方源账号不同,其余操作都是相同的比如:在你项目的根目录,输入 npm publish ,提示发布成功/失败等

  9. 对于使用者,使用的时候,npm源 指向 私有源 npm install 包名 即可 ,和正常使用无任何差异

结束

至此 就都搞定啦。
无论团队的开发者/使用者来说,只要把 nrm的源指向为 自己的私有源就OK了。
verdaccio通过代理的形式,把你的私有包 和 官方包 切分开。


verdaccio的代理模式

如果有发布了包到私有源,你的私有源web页 就是这样的~


私有源web页

私有源详情页
前端程序猿的日记本
Web note ad 1