百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

还没有开始用自己的npm包吗,简单几步就搞定了

liuian 2025-01-05 18:41 55 浏览

准备工作

npm是一个辅助前端开发的包管理工具。主要设计到两个概念package和module,可以这样理解,一个JavaScript软件,从本地发布到npm仓库时是package,从npm仓库下载到本地时就变成了module。如果要发布自己的包到npm,我们需要注册npm账户。在npm上注册一个账号是很简单的,需要填一下用户名密码邮箱,然后会收到一封邮件,进邮箱验证邮件的真实性。否则发布会报错。

创建包

创建package.json文件

新建一个wave-test文件夹,在文件夹中执行npm init,按照提示一步一步继续就可以了,最后在文件夹生成一个package.json文件,如果该文件夹是一个git仓库,它会提示一步步填上对应的repository相关的地址,这个将来发布到npm上的时候会在相应的页面上显示。

{
  "name": "wave-test",
  "version": "0.0.1",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
  },
  "keywords": [],
  "author": "wavesnow",
  "license": "MIT"
}

创建一个入口文件index.js

我们按照默认的创建一个index.js文件,写一个测试方法getRandomNumber。

(function () {
  'use strict';
    function getRandomNumber() {

        var random = Math.floor(Math.random() * 100);
        if (random >= 100)
            throw new Error("Error");
        return random;
    }
    exports.getRandomNumber = getRandomNumber;
  }());

创建README.md文件

这个文件将来也会将内容显示到发布的npm包所在的页面,用来帮助用户理解说明你发布的包。

发布包

不带命名空间的包

有了上面三个个文件,我们就可以发布npm包了。依次执行下面几个命令,登陆后还需要输入密码及发布用的邮箱,该邮箱会公开。

## 登陆
npm login

## 发布
npm publish

带命名空间的包

如果想发布带命名空间的包,有scope的,那首先应该先去npm网站创建一个组织,这个组织的名字就是一个scope,以发布open的scope为例,后面需要修改一下这个package.json文件,比如申请的scope是myscope,那上面的package文件需要将名字这块做一个修改,其他可以不用动。

{
  "name": "@myscope/wave-test",
  "version": "0.0.1",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
  },
  "keywords": [],
  "author": "wavesnow",
  "license": "MIT"
}

这种包发布的时候,需要加入一个参数--access public,发布私有scope的,访问限制私有的包npm需要收费。

npm publish --access public

使用

和其他包使用是一样的。现有一个测试工程。创建一个test-mypackage文件夹,安装我们的包

mkdir test-mypackage && cd test-mypackage
 
npm init -y

npm i wave-test

然后创建一个index.js文件,引入我们的包

let test = require('wave-test');
test.getRandomNumber();

运行index.js,

node index.js

更新

一个npm包发布之后,我们难免会修改一些bug,或者增改一些功能,这就涉及到对npm包的迭代。其中会涉及到到两个方面,内容的变更和版本的变更。npm采用语义化版本,共三位,以’.’隔开,从左至右依次代表:主版本(major)、次要版本(minor)、补丁版本(patch)。

## 变更版本号的命令
npm version <major | minor | patch>

比如我们执行命令:

npm version minor

package.json中的version变为0.1.1,然后执行发布命令就可以了。

项目中更新对这个包的引用,可以执行

npm up wave-test

废弃或删除

npm包发布后可以对包进行废弃或删除操作。废弃不会将包或版本从npm仓库删除,仍然可以继续下载安装,并在安装的时候会有警示。删除会将包从npm彻底删除,无法被下载安装。无论是废弃还是删除,都包含两个层面:

  • 版本的废弃/删除,鼓励用户更新最新版本
  • 包的废弃/删除,此包内容已经过时,没有了维护的价值

废弃

语法:npm deprecate <pkg>[@<version>] <message>,我们以wave-test为例:

## 废弃指定版本
npm deprecate wave-test@0.0.1 'deprecate reason'

## 废弃指定的包
npm deprecate wave-test 'deprecate reason'

执行后我们用npm view wave-test versions查看版本,记录的版本号并无变化。废弃的包除了安装时会有警示,并不影响使用。

删除

npm不鼓励任何形式的删除,主要因为我们发布的包可能已经被其他人引用,如果我们删除了此包,其他人在重新安装含有我们包的依赖的工程时,出现找不到包问题。

## 任意目录下删除包
npm unpublish wave-test --force

## 开发目录下删除当前版本
npm unpublish --force

相关推荐

MySQL慢查询优化:从explain到索引,DBA手把手教你提升10倍性能

数据库性能是应用系统的生命线,而慢查询就像隐藏在系统中的定时炸弹。某电商平台曾因一条未优化的SQL导致订单系统响应时间从200ms飙升至8秒,最终引发用户投诉和订单流失。今天我们就来系统学习MySQL...

一文读懂SQL五大操作类别(DDL/DML/DQL/DCL/TCL)的基础语法

在SQL中,DDL、DML、DQL、DCL、TCL是按操作类型划分的五大核心语言类别,缩写及简介如下:DDL(DataDefinitionLanguage,数据定义语言):用于定义和管理数据库结构...

闲来无事,学学Mysql增、删,改,查

Mysql增、删,改,查1“增”——添加数据1.1为表中所有字段添加数据1.1.1INSERT语句中指定所有字段名语法:INSERTINTO表名(字段名1,字段名2,…)VALUES(值1...

数据库:MySQL 高性能优化规范建议

数据库命令规范所有数据库对象名称必须使用小写字母并用下划线分割所有数据库对象名称禁止使用MySQL保留关键字(如果表名中包含关键字查询时,需要将其用单引号括起来)数据库对象的命名要能做到见名识意,...

下载工具合集_下载工具手机版

迅雷,在国内的下载地位还是很难撼动的,所需要用到的地方还挺多。缺点就是不开会员,软件会限速。EagleGet,全能下载管理器,支持HTTP(S)FTPMMSRTSP协议,也可以使用浏览器扩展检测...

mediamtx v1.15.2 更新详解:功能优化与问题修复

mediamtxv1.15.2已于2025年10月14日发布,本次更新在功能、性能优化以及问题修复方面带来了多项改进,同时也更新了部分依赖库并提升了安全性。以下为本次更新的详细内容:...

声学成像仪:泄露监测 “雷达” 方案开启精准防控

声学成像仪背景将声像图与阵列上配装的摄像实所拍的视频图像以透明的方式叠合在一起,就形成了可直观分析被测物产生状态。这种利用声学、电子学和信息处理等技术,变换成人眼可见的图像的技术可以帮助人们直观地认识...

最稳存储方案:两种方法将摄像头接入威联通Qu405,录像不再丢失

今年我家至少被4位邻居敲门,就是为了查监控!!!原因是小区内部监控很早就停止维护了,半夜老有小黄毛掰车门偷东西,还有闲的没事划车的,车主损失不小,我家很早就配备监控了,人来亮灯有一定威慑力,不过监控设...

离岗检测算法_离岗检查内容

一、研发背景如今社会许多岗位是严禁随意脱离岗位的,如塔台、保安室、监狱狱警监控室等等,因为此类行为可能会引起重大事故,而此类岗位监督管理又有一定困难,因此促生了智能视频识别系统的出现。二、产品概述及工...

消防安全通道占用检测报警系统_消防安全通道占用检测报警系统的作用

一、产品概述科缔欧消防安全通道占用检测报警系统,是创新行业智能监督管理方式、完善监管部门动态监控及预警预报体系的信息化手段,是实现平台远程监控由“人为监控”向“智能监控”转变的必要手段。产品致力于设...

外出住酒店、民宿如何使用手机检测隐藏的监控摄像头

最近,一个家庭在他们的民宿收到了一个大惊喜:客厅里有一个伪装成烟雾探测器的隐藏摄像头,监视着他们的一举一动。隐藏摄像头的存在如果您住在酒店或民宿,隐藏摄像头不应再是您的担忧。对于民宿,房东应报告所有可...

基于Tilera众核平台的流媒体流量发生系统的设计

曾帅,高宗彬,赵国锋(重庆邮电大学通信与信息工程学院,重庆400065)摘要:设计了一种基于Tilera众核平台高强度的流媒体流量发生系统架构,其主要包括:系统界面管理模块、服务承载模块和流媒体...

使用ffmpeg将rtsp流转流实现h5端播放

1.主要实现rtsp转tcp协议视频流播放ffmpeg下载安装(公认业界视频处理大佬)a、官网地址:www.ffmpeg.org/b、gitHub:github.com/FFmpeg/FFmp…c、推...

将摄像头视频流从Rtsp协议转为websocket协议

写在前面很多通过摄像头拿到的视频流格式都是Rtsp协议的,比如:海康威视摄像头。在现代的浏览器中,已经不支持直接播放Rtsp视频流,而且,海康威视提供的本身的webSdk3.3.0视频插件有很多...

华芸科技推出安全监控中心2.1 Beta测试版

全球独家支持hdmi在线实时监看摄像机画面,具单一、循环或同时监看四频道视频影像,可透过华芸专用红外线遥控器、airemote或是键盘鼠标进行操作,提供摄像机频道增购服务,满足用户弹性扩增频道需...