打造简易的 NPM 私有仓库

我们通常通过 npm 来安装和使用开源的模块。但是，通常我们有些私有的模块，不想通过npm发布，但是又想在一些项目中共享使用，而且我们不想将公共模块是复制到各个项目中来使用。而且一旦公有模块更新，我们也不能及时更新。当然，如果不嫌麻烦，可以用相对目录，不过这种在开发代码时，引用时，写法上就要将相对目录写上。但是我们现在探讨的是另一种方式——利用现有的git，既不用搭建私有的npm私有仓库(npm private repository)，又能满足上面的需求，它做为一个快速解决方案, 后期是可以慢慢过渡升级到使用完整 npm 私有仓库的解决方案的.

打造一个完整的 npm 私有仓库, 需要服务器, 需要安装环境。后面会有文章单独介绍。

新建 npm 私有模块

下面以一个实例来说明如何在 GitLab 中新建一个 npm 私有模块, 假设我们要新建的私有模块名为: wave-test

在 GitLab 上新建一个 project, 名字为: `wave-test`

对于公共模块, 最好是放在同一个 group 下, 例如放在 wavesnows 这个 group 下. 那么以后所有公共模块的 git 地址就可以统一为:

  http://git.your-inc.com/{group}/{project}.git

将项目 clone 下来

git clone http://git.your-inc.com/wavesnows/wave-test.git

添加 `package.json` 配置, 注意限定 `@scope`

 npm init --scope=wavesnows

然后提交 push 上去

到这里私有模块就已经发布好了, 如果有项目要使用, 就配置下项目的 dependencies 即可.

使用私有模块

添加私有模块的依赖

在项目的 package.json 中添加依赖, 例如: 依赖 @wavesnows/wave-test 这个私有模块

 "@wavesnows/wave-test": "git+http://git.your-inc.com/wavesnows/wave-test.git"

如果想固定依赖某个分支，可以加上分支的名字，比如分支branch1，

 "@wavesnows/wave-test": "git+http://git.your-inc.com/wavesnows/wave-test.git#branch1"

安装私有模块

跟安装开源的模块一样, 使用 npm install 安装依赖即可. 私有模块会安装在 @scope 的子文件夹中, 例如:

node_modules/@wavesnows/wave-test

代码中使用私有模块

跟使用开源的模块一样, 我们只要写对应的包名即可. 私有模块的包名只是带有 @scope 而已.

var wave = require('@wavesnows/wave-test');

// 另外一种引用方式
import WT from '@wavesnows/wave-test'

如果在使用webpack的项目中使用，我们还可以通过配置alias来简化代码中的写法

alias: {
  'wave-test': '@wavesnows/wave-test'
}

在代码中就可以和引用其他module一样了

var wave = require('wave-test');

// 或者
import WT from 'wave-test'

如果alias中配置了
 '@': resolve('src')
我们在使用带有scope的模块的时候，如果不配置alias，@可能会造成冲突，这个和webpack的>ModuleAliasPlugin的实现有关。
'@': resolve('src'),
'wave-test': resolve('node_modules/@waevsnows/wave-test'),
// 或者
'wave-test': '@wavesnows/wave-test',

更新私有模块

如果私有模块的版本更新了, 我们使用 npm update 是无法更新私有模块的, 只能通过

npm install @wavesnows/wave-test

这样的方式来重新安装一次私有模块, 才能获取到最新版本的私有模块.

私有模块的规范

package.json#name 必须限定 @scope

@scope 一般为 GitLab group 的名字, 例如 @companyfe, 那么 name 为: @wavesnows/wave-test

package.json#private 设置为 true

防止你一不小心将私有模块发布上去

{
  "name": "@wavesnow/wave-test",
  "version": "0.0.1",
  "description": "Wave Tools",
  "main": "index.js",
  "private": "true",
  "repository": {
    "type": "git",
    "url": "http://git.your-inc.com/wavesnow/wave-test.git"
  },
  "keywords": [
    "wave",
    "git",
    "tool",
    "javescript"
  ],
  "author": "wavesnow",
  "license": "MIT"
}

参考

can you host a private repository for your organization to use with npm?

you can specify private git repositories urls as a dependency in your package.json files.

Private npm modules

Working with private modules

All private packages are scoped. If a package's name begins with @, then it is a scoped package. The scope is everything in between the @ and the slash.

npm-scope Scoped packages

When used in package names, scopes are preceded by an @ symbol and followed by a slash. Scopes are a way of grouping related packages together.

打造简易的 NPM 私有仓库