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

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

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

准备工作

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

相关推荐

Springboot 整合 Websocket 轻松实现IM及时通讯

一、方案实践集成分为三步:添加依赖、增加配置类和消息核心类、前端集成。1.1、添加依赖<dependency><groupId>org.springframework...

SpringBoot扩展——应用Web Socket!

应用WebSocket目前,网络上的即时通信App有很多,如QQ、微信和飞书等,按照以往的技术来说,即时功能通常会采用服务器轮询和Comet技术来解决。HTTP是非持久化、单向的网络协议,在建立连接...

【Spring Boot】WebSocket 的 6 种集成方式

介绍由于前段时间我实现了一个库【SpringCloud】一个配置注解实现WebSocket集群方案以至于我对WebSocket的各种集成方式做了一些研究目前我所了解到的就是下面这些了(就一个破w...

SpringBoot生产级WebSocket集群实践,支持10万连接!

1、问题背景智慧门诊系统旨在从一定程度上解决患者面临的三长一短(挂号、看病、取药时间长,医生问诊时间短)的问题。实现“诊前、诊中、诊后”实时智能一体化,整合完善医院工作流程。围绕门诊看病的各个环节,让...

Spring Boot3 中 WebSocket 实现数据实时通信全解析

各位互联网大厂的开发同仁们,在如今的互联网应用开发中,实时通信功能越来越重要。比如在线聊天、数据推送、实时通知等场景,都离不开高效的实时通信技术。而WebSocket作为一种高效的双向通信协议,在...

Java WebSocket 示例(java nio websocket)

一、环境准备1.依赖配置(Maven)在pom.xml中添加WebSocket依赖:xml<!--SpringBootWebSocket--><dependen...

Spring Boot整合WebSocket:开启实时通信之旅

SpringBoot整合WebSocket:开启实时通信之旅今天咱们来聊聊SpringBoot整合WebSocket这件大事儿。说到实时通信,你是不是第一时间想到QQ、微信这些聊天工具?没错,We...

Spring Boot3 竟能如此轻松整合 WebSocket 技术,你还不知道?

在当今互联网大厂的软件开发领域,实时通信的需求愈发迫切。无论是在线聊天应用、实时数据更新,还是协同办公系统,都离不开高效的实时通信技术支持。而WebSocket作为一种能够实现浏览器与服务器之间持...

Spring Boot集成WebSocket(springboot集成websocket)

一、基础配置依赖引入<dependency><groupId>org.springframework.boot</groupId><artifactId>...

Springboot下的WebSocket开发(springboot websocket server)

今天遇到一个需求,需要对接第三方扫码跳转。一种方案是前端页面轮询后端服务,但是这种空轮询会虚耗资源,实时性比较差而且也不优雅。所以决定使用另一种方案,websocket。以前就知道websocket,...

springboot websocket开发(java spring boot websocket)

maven依赖SpringBoot2.0对WebSocket的支持简直太棒了,直接就有包可以引入<dependency><groupId>org....

Python界面(GUI)编程PyQt5窗体小部件

一、简介在Qt(和大多数用户界面)中,“小部件”是用户可以与之交互的UI组件的名称。用户界面由布置在窗口内的多个小部件组成。Qt带有大量可用的小部件,也允许您创建自己的自定义和自定义小部件。二、小部件...

实战PyQt5: 014-下拉列表框控件QComboBox

QComboBox简介QComboBox下拉列表框,是一个集按钮和下拉列表选项于一体的部件。QComboBox提供了一种向用户呈现选项列表的方式,其占用最小量的屏幕空间。QComboBox中的常用方法...

Python小白逆袭!7天吃透PyQt6,独立开发超酷桌面应用

PythonGUI编程:PyQt6从入门到实战的全面指南在Python的庞大生态系统中,PyQt6作为一款强大的GUI(GraphicalUserInterface,图形用户界面)编程框架,为开...

如何用 PyQt6 打造一个功能完善的 SQLite 数据库管理工具

如何使用PyQt6和qt_material库,打造一个功能完善的SQLite数据库管理工具,轻松管理和查询SQLite数据库。一、目标数据库连接与表管理:支持连接SQLite数据库...