专栏首页前端真相如何发布自己的NPM包(模块)?
原创

如何发布自己的NPM包(模块)?

1.注册NPM 账号


注册地址:https://www.npmjs.com/

2.初始化自己要发布的项目


搭建本地环境:安装node.js,包含了npm命令。

新建目录,在该目录下,初始化项目:npm init。

按照提示填写初始化信息,我的模块名称为:finitxu-npm-test,初始版本号:v1.0.0

模块名称需遵循相关政策要求:https://www.npmjs.com/policies,不能够与已有NPM模块名冲突等等。

模块代码 index.js:

function npmDemo(argument) {
	var name = 'finit';
	var f1 =function f(arg){console.log(arg)}
	return {
		name:name,
		f1:f1
	}
	
}
module.exports=npmDemo();

3.登录npm,发布自己的npm包


npm login

根据提示输入之前注册的账号、密码。

发布npm包:

npm publish

此时在自己个人的npm账号主页可以看到该包。

4.使用自己发布的包(模块)的示例代码


安装之前发布的npm包:

npm install finitxu-npm-test

新建其它目录,初始化:npm init

使用已发布NPM包的示例代码test.js:

var test_npm = require('finitxu-npm-test');
console.log(test_npm)
console.log(test_npm.f1(11));
console.log(test_npm.name)

运行示例代码:node test.js

输出:

{ name: 'finit', f1: [Function: f] }
11
undefined
finit

5.更新自己的NPM包(模块)及readme.md


修改代码和readme.md后,执行命令:

npm version patch
npm publish

npm version后面参数说明:

patch:小变动,比如修复bug等,版本号变动 v1.0.0->v1.0.1

minor:增加新功能,不影响现有功能,版本号变动 v1.0.0->v1.1.0

major:破坏模块对向后的兼容性,版本号变动 v1.0.0->v2.0.0

6.使用更新后的NPM包


更新NPM包:

针对patch: npm install finitxu-npm-test
针对minor: npm install finitxu-npm-test
针对major: npm install finitxu-npm-test@2.0.0

其它内容与步骤4相同。


微信公众号(技术很有趣),了解一下~

这里写图片描述

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

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

我来说两句

0 条评论
登录 后参与评论

相关文章

  • NPM怎么玩?

    npm install -g cnpm --registry=https://registry.npm.taobao.org

    城市中的游牧民族
  • webpack、npm 相关错误汇总

    使用webstorm搭建vue项目,报如上错误。 本地node版本为10。 原因: 版本10 fs.promises的API是实验性的,webstorm不...

    城市中的游牧民族
  • webpack、npm 错误汇总

    原因: 版本10 fs.promises的API是实验性的,webstorm不允许使用。

    城市中的游牧民族
  • 将做好的前端组件制作成npm包发布

    这个问题是我们使用了淘宝镜像的问题,使用的是淘宝源cnpm,登陆到的是cnpm,我们把它切换成npm就好了。

    colezhou
  • npm init @vitejs/app的背后,仅是npm CLI的冰山一角

    我们每天都和npm打交道,但是不少人对npm的掌握程度还停留在一个比较浅的层面(当然这也包括我)。就比如说一个用 vite 创建 app 的命令npm init...

    Tusi
  • node常用命令汇总

    该命令写在package.json文件scripts的test字段中,可以自定义该命令来执行一些操作,如

    框架师
  • 译:npm 7已经可以使用了

    除了一些新特性和不兼容更改之外。与npm 6相比,我们对npm 7的性能方面产生了一些重要的影响,其中包括:

    flytam
  • npm - 组件发布

    name -- 包名 (格式:@XXX/包名, XXX为npm账号名,如果不加@XXX需要收费)

    长风过境
  • npm v7.0.0 发布 - 带来数个重大更新

    很难相信,11年前, JavaScript 社区还没有 npm 。快进到今天,npm 现在拥有数百万的开发人员和 130 万个软件包,每月下载 75B。

    ConardLi
  • 微信小程序使用npm

    1.初始化npm:在你所建项目的根目录下,执行npm init 2.微信开发者工具开启"使用npm模块"(右上角详情-本地设置-勾选使用npm模块) 3.在项目...

    似水的流年

扫码关注云+社区

领取腾讯云代金券