技术分享
创建一个属于自己的npm包
00 分钟
2021-11-5
2025-1-16
type
status
date
slug
summary
tags
category
icon
password

一、关于 NPM

notion image
NPM(Node Package Manager)最初是 Node.js 的包管理工具,但随着 JavaScript 的快速发展,它已成为几乎所有与 JavaScript 相关的工具和软件包的管理工具。现在,安装最新版的 Node.js 时,NPM 会自动随之安装。

二、NPM 常用命令

以下命令分为全局和局部命令,全局命令需加上 -g
  • 查看 NPM 版本
    • 初始化 NPM 信息
      • 创建 Node 项目目录,引导用户生成 package.json 文件:
    • 安装模块
      • 卸载模块
        • 列出已安装的模块
          • 更新/升级模块
            • 查看模块详情

              三、编写 NPM 包

              NPM 平台上包的数量庞大,发布自己编写的 NPM 包可以让更多人使用。以下是我的开发过程记录。

              3.1、添加 NPM 用户信息

              根据提示输入 NPM 账号信息(如用户名、密码、邮箱)。确保 NPM 的 registry 地址为官方地址:

              3.2、NPM 目录结构及编写

              我们将开发一个名为 rsvalidator 的模块,用于验证字符串的合法性。
              目录结构:
              index.js 文件:
              lib/index.js 文件:

              3.3、编写测试用例

              我们选择 Mocha 作为测试框架。
              • 安装 Mocha
                • 编写测试用例
                • 运行测试

                  3.4、NPM 包版本管理和 Changelog

                  在每次发布前,确保更新 package.json 中的版本号,可以使用以下命令:

                  3.4.1、使用工具生成 Changelog

                  • 安装 auto-changelog
                    • 生成 Changelog
                      • 使用 standard-version
                        • package.json 中添加脚本命令:
                          运行命令以更新版本号和生成 Changelog:

                      3.5、提交 NPM 包

                      最后,确保模块名称唯一后,使用以下命令提交 NPM 包:

                      通过以上步骤,你可以创建并管理自己的 NPM 包,提升项目的可维护性和用户体验。确保每次发布前更新版本号和 Changelog,以便用户了解版本变化。