创建 npm 私有包

1. 下载脚手架工程

$ svn export https://192.168.1.118:1443/svn/KunLun/Client/npm-pkg-boilerplate

2. 工程目录

.
├── .babelrc        # Babel 配置
├── .npmignore      # 配置发布时忽略哪些文件
├── README.md       # 项目自述
├── index.js        # 入口
├── lib             # 编译结果目录,发布时只发布 lib 下文件
│   └── index.js    #
├── package.json    # 包配置
├── src             # 源码目录
│   └── index.js    #
└── yarn.lock       #

提示

lib 目录不应该提交到 svn

3. 修改包配置

修改 package.json 文件中 nameversioncontributors 等信息。

提示

publishConfig 配置了发布到哪个服务器。默认配置的是公司私有服务器,不要去修改。

4. 编写你的代码

// /src/index.js
export default class Example {

    add(x, y) {
        return x + y;
    }
};

5. 发布

// 编译,结果输出到 lib 目录下
$ yarn compile

// 发布
$ npm publish

发布完成后,可以在 http://172.30.3.107:8082/#browse/browse:npm_hosted 下查看。

6. 在其他项目中引用

6.1. 安装依赖

$ yarn add npm-pkg-boilerplate --registry http://172.30.3.107:8082/repository/npm_group/

安装成功后,你的包会以以下结构添加到 node_modules 中

.
├── ...
├── node_modules
│   └── npm-pkg-boilerplate
│       ├── README.md
│       ├── index.js
│       ├── lib
│       │   └── index.js
│       └── package.json
├── ...

6.2. 调用

import Example from 'npm-pkg-boilerplate';

const example = new Example();
const rs = example.add(1, 2);