# NPM 发包过程文档

本文档将介绍如何发布一个包到 NPM（Node Package Manager）的过程。这里假设你已经拥有一个待发布的 Node.js 项目。以下是发布 NPM 包的详细步骤：

## 1. 准备工作

确保你的项目满足以下条件：

- 已经安装了 Node.js 和 NPM。如果还没有安装，请访问 [Node.js 官网](https://nodejs.org/) 下载并安装。
- 项目有一个 `package.json` 文件。如果没有，你可以通过运行 `npm init` 来创建一个。

## 2. 更新 package.json 文件

确保你的 `package.json` 文件包含以下信息：

- `name`：包名，确保是全局唯一的(小写的英文 + 短横线)， eg: @vue/use, @vue/core。
- `version`：当前包版本，遵循 [Semantic Versioning](https://semver.org/) 规范。
- `main`：包的入口文件。
- `scripts`：包中可执行的脚本。
- `dependencies` 和 `devDependencies`：包所依赖的其他包。

例如：

```
{
  "name": "your-package-name",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {},
  "devDependencies": {}
}
```

## 3. 创建 .npmignore 文件

创建一个 `.npmignore` 文件来排除发布时不需要的文件。这类似于 `.gitignore` 文件。例如：

```
node_modules
*.log
*.swp
*.bak
```

## 4. 登录 NPM 账户

在终端中运行 `npm login` 命令，并输入你的 NPM 账户名、密码和邮箱。如果还没有账户，可以通过运行 `npm adduser` 创建一个。

```
npm login
```

## 5. 发布包

运行以下命令发布你的包到 NPM：

```
npm publish
```

发布成功后，你会在终端看到类似的输出信息：

```
+ your-package-name@1.0.0
```

## 6. 确认发布

登录 [NPM 官网](https://www.npmjs.com/)，进入你的个人主页，查看已发布的包。

## 7. 更新和维护

当你的包需要更新时，确保按照 [Semantic Versioning](https://semver.org/) 规范更新 `package.json` 文件中的版本号。然后重新执行 `npm publish` 命令发布新版本。

完成以上步骤后，你的包就成功发布到了 NPM。现在其他开发者可以通过 `npm install your-package-name` 命令安装你的包。