npm插件的开发详细流程

飞扬rdh
0 阅读2分钟

1注册npm账号

[在这里注册一个npm账号](npm | Home)

2.生成自己的token

25年11月改版后， 需要添加token验证， 来绕过双因素认证， 否则在发布的时候会提示权限不足

  • 点击账号， 选择Access Toekens
  • 在这个页面点击 Generate New Token
  • 在生成token页面， 需要注意，一定要勾选“Bypass two-factor authentication (2FA)”
  • Packages and scopes部分按照自己的业务规划 添加就可以了
  • 在项目添加.npmrc或者全局设置.npmrc的authToken

流程图如下：

    • image.png
  2. image.png
  3. image.png

开发前端插件

  • npm插件开发完成后， 执行npm login 登录账号
  • 会提示输入账号和密码，以及一次性验证码，一次输入即可
  • 如果不确定是否已经登录 可以执行npm whoami 返回账号信息 即是已登录状态
  • 设置packages.json内的version插件的版本号
  • 执行npm publish即可
  • 在个人的npm的packages内可以看到已经发布的npm插件

本地调试npm插件

  1. 进入到本地npm包对应的文件内，执行
npm link

执行成功会有提示， 一般会返回对应包的名字 或者 返回将全局的node_modules指向了本地开发的npm插件地址

  1. 进入到业务系统
npm link "开发的插件名"
  1. 关闭断开 在包的目录下执行：
npm unlink

版本更新

  1. 完成功能的开发，bug修复， 提交代码
git add . 
git commit -m "feat: 更新了什么？"
  1. 质量与构建校验
npm run lint 
npm run test 
npm run build # 生成 dist 等产物

检查 package.json：private 设为 false，main/module 入口正确，files 字段指定要发布的文件。 3.版本号规则

  • patch（修订号） ：Bug 修复、不影响功能的小改动 → 1.0.0 → 1.0.1

  • minor（次版本号） ：新增功能、向后兼容 → 1.0.0 → 1.1.0

  • major（主版本号） ：不兼容的重大变更 → 1.0.0 → 2.0.0

  1. 更新版本号
  • 方式1： 使用 npm version 命令自动修改 package.json 并创建 Git Tag：
# 修订版
npm version patch 
# 次版本 
npm version minor 
# 主版本
npm version major

执行后会自动更新package.json与package-lock.json的version

  • 手动更新： 直接编辑package.json 修改versiob字段， 在手动打tag
# 编辑 package.json → "version": "1.0.1" 
git add package.json package-lock.json 
git commit -m "chore: bump version to 1.0.1" 
git tag v1.0.1
  1. 发布到npm
# 常规发布 
npm publish 
# 发布预发布版本（beta/alpha） 
npm publish --tag beta 
npm publish --tag alpha
# 查看已发布版本 
npm view <包名> versions
  1. 推送git变更与标签
git push origin main # 推送到主分支 
git push --tags # 推送版本标签
avatar
文章
阅读
粉丝