从零开始，手把手教你开发并发布一个_npm_包（超详细新手版）

本教程适合零基础到初次发布 npm 包的开发者。每一步都有详细讲解和可直接使用的代码片段，跟着做，你也能发布属于自己的 npm 包！

文章目录

• 一、准备工作
• 二、创建项目并开发你的包
• 三、配置 package.json 文件
• 四、编写入口文件与导出功能
• 五、打包（可选步骤）
• 六、发布到 npm
• 七、验证发布是否成功
• 八、注意事项总结
• 结语

一、准备工作

1. 安装 Node.js 和 npm
   官网下载：Node.js 官网
   安装后，检查是否成功：

   node -v
   npm -v

2. 注册 npm 账号
   前往 npm官网 注册一个账号。

3. 登录 npm

   npm login

   按提示输入：

   • 用户名
   • 密码
   • 邮箱

✅ 看到 Logged in as your-username on https://registry.npmjs.org/ 就表示登录成功！

二、创建项目并开发你的包

1. 新建一个空目录

   mkdir my-first-npm-package
   cd my-first-npm-package

2. 初始化项目

   快速生成 package.json 文件：

   npm init -y

   生成默认的 package.json。

三、配置 package.json 文件

打开 package.json，适当修改，至少需要保证：

• name：包名（必须唯一，不能和 npm 上已有的重复！ ）
• version：版本号（首次发布为 1.0.0）
• main：入口文件名，比如 index.js
• description：一句话介绍你的包
• author：你的名字或组织
• license：一般填 MIT
• keywords：关键字数组（便于搜索）

示例：

{
  "name": "keysqiu",
  "version": "1.0.0",
  "description": "A collection of useful JavaScript utility functions.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No tests yet\""
  },
  "keywords": ["utils", "javascript", "npm-package"],
  "author": "YourName",
  "license": "MIT"
}

四、编写入口文件与导出功能

创建 index.js：

touch index.js

示例代码：

// index.js

function add(a, b) {
  return a + b;
}

function multiply(a, b) {
  return a * b;
}

module.exports = {
  add,
  multiply,
};

使用示例：

const { add, multiply } = require("keysqiu");

console.log(add(2, 3)); // 5
console.log(multiply(4, 5)); // 20

五、打包（可选步骤）

如果是简单 JS，可以跳过打包。但如果用到 ==ES6 Module== 或 ==TypeScript==，可以使用 rollup。

安装 rollup：

npm install rollup --save-dev

新建 rollup.config.js：

export default {
  input: "index.js",
  output: {
    file: "dist/bundle.js",
    format: "cjs",
  },
};

打包指令：

npx rollup -c

六、发布到 npm

1. 确认包名唯一

   npm search keysqiu

2. 检查版本号是否递增（每次发布版本号必须变化）

3. 发布指令

   npm publish

发布成功提示：

keysqiu@1.0.0

七、验证发布是否成功

安装使用：

npm install keysqiu

使用：

const { add, multiply } = require("keysqiu");

console.log(add(1, 2));
console.log(multiply(2, 5));

✅ 如果能正常输出，发布成功！

八、注意事项总结

• 包名必须唯一，不能和已有 npm 包冲突
• 每次发布必须递增版本号（语义化版本号）
• 主入口文件要正确设置 main
• 推荐添加 description、keywords 提高搜索度
• 测试安装使用，确认无误再发布

如果不希望发布，可以在 package.json 加上：

"private": true

这样 npm 会禁止发布。

结语

到这里，你已经完整掌握了开发、配置、打包、发布 npm 包的流程。
不断练习，未来可以发布更复杂、更专业的开源库，迈向更高级的前端工程师之路！