踏出 node.js 包构建第一步：封装你的首个 npm 包

2023-12-11 02:58:49


<html>
<head>
</head>
<body>





npm 是一个 Node.js 包管理器，用于管理 Node.js 的公共模块（插件）或包。本文将从一个简单的例子入手，逐步带你完成 npm 包的封装、发布、更新、扩展和使用，最终得到一个相对完整的 npm 包。

## 1. 封装

### 1.1 创建项目

首先，创建一个新的 Node.js 项目。

mkdir my-npm-package
cd my-npm-package
npm init -y


### 1.2 编写代码

在 `src` 目录下创建一个 `index.js` 文件，并编写以下代码：

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}

module.exports = greet;

1.3 测试代码

运行以下命令来测试代码：

node src/index.js John

如果输出 Hello, John!，则说明代码运行正常。

2. 发布

2.1 创建 package.json 文件

在项目根目录下创建一个 package.json 文件，并填写以下内容：

{
  "name": "my-npm-package",
  "version": "1.0.0",
  "description": "A simple npm package that greets people.",
  "main": "src/index.js",
  "scripts": {
    "test": "node src/index.js John"
  },
  "keywords": ["npm", "node package", "node.js package manager"],
  "author": "Your Name",
  "license": "MIT"
}

2.2 发布包

运行以下命令来发布包：

npm publish

如果一切顺利，你应该可以在 npm 上找到你的包了。

3. 更新

3.1 更新代码

在 src/index.js 中，将 Hello, ${name}! 改为 Hello, ${name}, how are you?。

3.2 更新版本号

在 package.json 中，将版本号从 1.0.0 改为 1.0.1。

3.3 发布更新

运行以下命令来发布更新：

npm publish

4. 扩展

4.1 添加新功能

在 src/index.js 中，添加一个新的函数 sayGoodbye()：

function sayGoodbye(name) {
  return `Goodbye, ${name}!`;
}

4.2 更新 package.json 文件

在 package.json 中，添加 sayGoodbye 函数到 exports 对象：

{
  "exports": {
    ".": {
      "import": "./src/index.js",
      "require": "./src/index.js",
      "default": "./src/index.js"
    },
    "./sayGoodbye": {
      "import": "./src/index.js",
      "require": "./src/index.js",
      "default": "./src/index.js"
    }
  }
}

4.3 发布扩展

运行以下命令来发布扩展：

npm publish

5. 使用

5.1 安装包

在你的项目中，运行以下命令来安装包：

npm install my-npm-package

5.2 使用包

在你的代码中，使用以下代码来引入包：

const greet = require("my-npm-package");
const sayGoodbye = require("my-npm-package/sayGoodbye");

console.log(greet("John")); // Hello, John, how are you?
console.log(sayGoodbye("John")); // Goodbye, John!