前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >手把手,带你发布你的第一个npm包

手把手,带你发布你的第一个npm包

原创
作者头像
zayyo
发布2023-11-15 20:35:26
1640
发布2023-11-15 20:35:26
举报
文章被收录于专栏:zayyo前端zayyo前端

我们在编写项目的时候,都会引入很多很好用的工具包,例如VueX、axios、Router、Element UId等。这些包很好用,安装引入也很方便。那如果我们也想发布一个我们自己的工具包,在以后编写项目时,直接引入我们自己的工具包要怎么发布呢?

今天我们就来手把手带你发布你的第一个npm包!!!

编写我们的npm包

首先我们要先创建我们的文件夹,用来存放我们的npm包。我这里就叫01demoz

然后我们要初始化我们的项目,使用npm init命令。输入命令后会在控制台要求我们填写我们的项目信息

代码语言:txt
复制
npm init
代码语言:javascript
复制
package name: (xxx-plugin)      // 我们的插件名(要求必须是唯一,在npm上无法搜索到的,否则无法上传)
version: (1.0.0)                // 插件版本
description:                    // 插件的作用描述
entry point: (index.js)         // 插件入口,如果我们不设置默认为根文件夹下的 index.js
test command:                   // 测试脚本
git repository:                 // 项目代码仓库(可以先不填)
keywords:                       // 关键词,利于包检索
author:                         // 作者
license: (ISC)                  // 许可证协议

编写我们的index.js文件

我们的index.js代码需要exports出来使用,方便我们在使用的时候引入。

  • 你可以编写一个函数插件,在不同项目中导入使用
代码语言:javascript
复制
exports.printMsg = function() {
  console.log("This is a message from the demo package");
}

写完就可以进行我们的发布npm包操作了。

注册一个npm账号

我们要发布npm包,肯定要先在我们的npm平台注册注册我们的账号,有了账号才能发布。

https://www.npmjs.com/

注意: 我们要记住我们的账号密码,在稍后的上传中还会用到。

发布我们的npm

  • 首先,使用npm adduser命令,添加我们的账户,输入完命令后,会要求我们填入账号,密码
代码语言:javascript
复制
npm adduser
  • 如果我们想要查看我们的账号是否添加成功,可以使用npm whoami查看当前账户。
  • 很多同学用的是淘宝镜像cnpm,所以是我们的原地址可能被修改成了淘宝镜像地址,这会导致我们的发布错误。所以我们可以使用npm config set registry= http://registry.npmjs.org/来更改回我们的原地址。
  • 最后我们可以使用我们的npm publish// 发布包到npm官方库

我正在参与2023腾讯技术创作特训营第三期有奖征文,组队打卡瓜分大奖!

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 编写我们的npm包
    • 编写我们的index.js文件
    • 注册一个npm账号
    • 发布我们的npm包
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
    http://www.vxiaotou.com