如何开发npm依赖包，并发布到npm

I、安装node环境

按照官方介绍，安装完成之后，可以通过node -v 和 npm -v 来确认node和npm是否安装成功。

II、普通版本开发

一、初始化项目

1、新建项目文件夹，作为包的根目录

mkdir xxx  // 创建xxx文件夹，文件夹名可更改
cd xxx   // 进入xxx文件夹目录

2、执行npm init 初始化项目

npm init   // 初始化项目

3、对文件中的package的信息进行编写

package name   项目名称
version   项目版本号
description   项目的描述信息
entry point   项目的入口文件
test command   项目启动时脚本命令
git repository   如果有git地址，可以将这个项目放到git仓库里
keywords   关键词
author   作者名
license   项目要发行的时候需要的证书

3.1、ES5写法

需要在package.json中添加以下代码才可以使用require引入（若没有type配置则默认是ES5）

"type": "commonjs"

var xxx = require('xxx')
 
xxx.fun1()

3.2、 ES6写法

需要在package.json中添加以下代码才可以使用import引入

"type": "module"

import { fun1 } from 'xxx' 
 
fun1()

4、编写包的入口文件（index.js）

// 这是包的入口文件
// 到时候导入就是导入这个包
// 向外暴露需要使用的成员,在外部就可以使用
const fun1 = require('./src/fun1');
const fun2 = require('./src/fun2');
 
module.exports = {
    // 把对象展开，展开运算符
    ...fun1,
    ...fun2
}

5、编写具体的函数方法

// 函数方法1
function fun1() {
    // ...
}
 
module.exports = {
    fun1
}

// 函数方法2
function fun2() {
    // ...
}
 
module.exports = {
    fun2
}

6、编写README.md （包的说明文档）

基本上每一个npm包都会有相关的介绍，来告诉使用者这个文件的信息以及如何安装使用

新建一个README.md文件，编写项目相关信息。

# xxx项目
 
 
[!npm version]
(https://img.shields.io/badge/npm-1.0.0-brightgreen)
 
 
 
项目说明文档
 
## install
 
```
npm install xxx
```

 

二、本地调试

1、在项目根目录下执行命令

npm link

2、在另一个测试项目的根目录下执行

其中xxx就是xxx依赖的名称，即package.json中的name字段