本文章没有找到对应的语言版本

介绍

什么是npm包？

npm 包（Node Package Manager Package），是Node.js 生态系统中，用于封装、复用和分发 JavaScript 代码的标准化模块单元。简单说，它就是一个打包好的代码工具库，可以被直接下载、引用到项目中使用。

在本篇文章中，我们创建了一个npm包——ai-zhipu-free-sdk，主要目的就是封装智谱免费模型的API调用，方便我们其他项目快捷、方便地使用！

准备

我们首先就要将可复用的代码整理到一个项目中，并提供友好的对外调用接口。

在ai-zhipu-free-sdk项目中，我们封装了智谱免费模型的API调用，提供了简单的调用接口。

项目结构

为了项目的可维护性和可扩展性，一般的，npm包的项目结构如下：

ai-zhipu-free-sdk
├── src
│   ├── index.ts
├── .env
├── package.json
├── tsconfig.json
├── README.md
├── LICENSE

从package.json可以知道入口文件的名称是index.ts，所以你只需要看index.ts文件即可。

index.ts主要用来export项目中的函数、类等，方便其他开发者调用。

所以如果你想知道一个包可以使用哪些方法，一般只需要看index.ts文件即可。

发布

当项目开发完成后，我们就要发布到npm仓库中了。

  • 首先发布到GitHub，这个不教了，应该都清楚。
  • 登录npm仓库 npm
    • 除了在官网登录之外，还需要在cmd中登录npm login。
    • 登录后，你可以在cmd中使用npm publish命令发布到npm仓库中。
  • 启用2FA，目前（2026-03-29）不启用这个，发布时会报错。
  • 使用 changesets 进行版本管理，每次发布时都要更新版本号。
    • 先安装npm i -g changesets。
    • 然后执行npm run changesets命令，创建变更记录。
    • 更新版本号npm run version。
    • 最后发布到npm仓库中npm run release。

Note

请注意，上面所使用的npm run xxx，均为package.json中定义的脚本。

{
    "scripts": {
        "changeset": "changeset",
        "version": "changeset version",
        "release": "npm run build && changeset publish"
    }
}

感谢

说些什么吧！

waline