nodejs插件开发与发布

简介: 本文主要介绍如何快速创建nodejs插件并发布到npm上。npm是一个让JavaScript程序员分享和复用代码的工具,我们不仅可以install别人的插件,也可以publish自己的代码。

本文主要介绍如何快速创建nodejs插件并发布到npm上。npm是一个让JavaScript程序员分享和复用代码的工具,我们不仅可以install别人的插件,也可以publish自己的代码。

npm是什么?

npm 为你和你的团队打开了连接整个 JavaScript 天才世界的一扇大门。它是世界上最大的软件注册表,每星期大约有 30 亿次的下载量,包含超过 600000 个 包(package) (即,代码模块)。来自各大洲的开源软件开发者使用 npm 互相分享和借鉴。包的结构使您能够轻松跟踪依赖项和版本。

类似于Java中的MavenUbuntu中的apt-get, Ruby中的Gem, Pythonpypi等…

npm 由三个独立的部分组成:

  • 网站:是开发者查找包(package)、设置参数以及管理 npm 使用体验的主要途径。
  • 注册表(registry):一个巨大的数据库,保存了每个包(package)的信息。
  • 命令行工具 (CLI):通过命令行或终端运行。开发者通过 CLI 与 npm 打交道。

npm官方网站:www.npmjs.com/

网络异常,图片无法展示
|

npm能做什么?

将独立的模块构建成插件,在后期项目中可以像搭积木一样组装需要的模块,避免重复造轮子

创建一个包

初始化

创建插件目录dev-localstorage,进入目录,使用npm init --yes默认方式初始化nodejs插件,命令窗口命令如下:

mkdir dev-localstorage
cd dev-localstorage
npm init --yes

执行后将在插件目录下生成package.json文件,内容如下:

{
  "name": "dev-localstorage",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/QuintionTang/dev-localStorage.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/QuintionTang/dev-localStorage/issues"
  },
  "homepage": "https://github.com/QuintionTang/dev-localStorage#readme"
}

相关字段说明,更多属性参见官方文档

  • name:插件的名字
  • version:插件版本号
  • description:插件描述
  • author:作者名
  • main:入口文件路径,require(name)将根据这个路径来引入
  • keywords:关键词,使用数组形式,方便npm官网搜索
  • scripts:命令行,通过npm run执行
  • license:许可证书,一般开源是MIT
  • repository:github仓库项目地址

创建代码

在入口文件index.js创建要实现的代码:

const devLocalStorage = (valKey = "authorization") => {
    const MAIN_KEY = "devpoint.";
    const localKey = `${MAIN_KEY}${valKey}`;
    const save = (data) => {
        console.log(`调用方法save: ${localKey}`);
    };
    const get = () => {
        console.log(`调用方法get: ${localKey}`);
    };
    const clear = () => {
        console.log(`调用方法clear: ${localKey}`);
    };
    return {
        save,
        get,
        clear,
    };
};
module.exports = devLocalStorage();

使用module.exports导出对象,在nodejs环境下,通过以下方式调用:

const devLocalStorage = require("dev-localstorage");
devLocalStorage.save("Devpoint");
devLocalStorage.get();
devLocalStorage.clear();

发布

插件开发完了,要把它发布到npm官网上,才能在其他项目中引用。 首次发布,需要在npm官网上注册账号,下次直接npm login进行登录。

$ npm adduser //注册账号
Username: YOUR_USER_NAME
Password: YOUR_PASSWORD
Email: YOUR_EMAIL@domain.com
$ npm publish . //发布

如果登录报405错误,可以在项目目录下添加文件.npmrc,内容为: registry=https://registry.npmjs.org

现在,在npm官网上输入dev-localstoragewww.npmjs.com/package/dev…)便可以搜到发布的包,通过npm install dev-localsorage将插件安装到自己的项目。

如果发现插件有bug了,修改后想要重新发布,直接执行npm push .会报错,这是由于npm检查到发布的version版本已经存在,所以需要更新你的版本号才能重新发布,此时需要以下命令:

npm version patch

此时package.jsonversion字段由1.0.0提升至1.0.1,再执行npm publish,可以看到npm官网版本的更新。

以上是nodejs插件发布的简单流程,实际上nodejs插件开发还包含很多场景,一个大型的项目还需要考虑单元测试、代码压缩、集成测试等等。

大型nodejs插件目录结构

一个完整的nodejs插件目录结构一般如下:

.
├── bin                         #运行目录
├── lib                         #主代码目录
├── example                     #示例目录
├── test                        #测试目录,提供单元测试
├── .travis.yml                 #集成自动测试配置
├── .npmignore                  #npm发布时忽略的文件
├── CHANGELOG.md               #版本更新说明
├── LICENSE                     #许可证书
├── package.json                #npm配置
├── README.md                   #README


相关文章
|
Web App开发 JavaScript 前端开发
Node.js 是一种基于 Chrome V8 引擎的后端开发技术,以其高效、灵活著称。本文将介绍 Node.js 的基础概念
Node.js 是一种基于 Chrome V8 引擎的后端开发技术,以其高效、灵活著称。本文将介绍 Node.js 的基础概念,包括事件驱动、单线程模型和模块系统;探讨其安装配置、核心模块使用、实战应用如搭建 Web 服务器、文件操作及实时通信;分析项目结构与开发流程,讨论其优势与挑战,并通过案例展示 Node.js 在实际项目中的应用,旨在帮助开发者更好地掌握这一强大工具。
381 1
|
6月前
|
人工智能 监控 JavaScript
HarmonyOS5云服务技术分享--ArkTS开发Node环境
本文详细讲解了在HarmonyOS(ArkTS API 9及以上)中使用云函数的开发技巧,结合Node.js和HTTP触发器,从零开始手把手教学。内容涵盖核心能力、开发流程(配置到部署)、高阶优化及常见问题解决,并提供实际应用场景示例。助你快速掌握Serverless开发,提升效率,探索跨端协作与AI集成等未来方向。
|
9月前
|
JavaScript 前端开发 数据可视化
【01】Cocos游戏开发引擎从0开发一款游戏-cocos环境搭建以及配置-Cocos Creator软件系统下载安装-node环境-优雅草卓伊凡
【01】Cocos游戏开发引擎从0开发一款游戏-cocos环境搭建以及配置-Cocos Creator软件系统下载安装-node环境-优雅草卓伊凡
559 2
【01】Cocos游戏开发引擎从0开发一款游戏-cocos环境搭建以及配置-Cocos Creator软件系统下载安装-node环境-优雅草卓伊凡
|
10月前
|
JavaScript 前端开发 jenkins
抛弃node和vscode,如何用记事本开发出一个完整的vue前端项目
本文探讨了在不依赖Node和VSCode的情况下,仅使用记事本和浏览器开发一个完整的Vue3前端项目的方法。通过CDN引入Vue、Vue Router、Element-UI等库,直接编写HTML文件实现页面功能,展示了前端开发的本质是生成HTML。虽然日常开发离不开现代工具,但掌握这种基础方法有助于快速实现想法或应对特殊环境限制。文章还介绍了如何用Node简单部署HTML文件到服务器,提供了一种高效、轻量的开发思路。
250 10
|
11月前
|
Web App开发 JavaScript 前端开发
Node.js开发
Node.js开发
242 13
|
存储 JavaScript 前端开发
深入浅出Node.js后端开发
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将以Node.js为例,深入探讨其背后的哲学思想、核心特性以及在实际项目中的应用,旨在为读者揭示Node.js如何优雅地处理高并发请求,并通过实践案例加深理解。无论你是初学者还是有一定经验的开发者,这篇文章都将为你提供新的视角和思考。
|
Web App开发 开发框架 JavaScript
深入浅出Node.js后端开发
在这篇文章中,我们将一起探索Node.js的奇妙世界。无论你是刚接触后端开发的新手,还是希望深化理解的老手,这篇文章都适合你。我们将从基础概念开始,逐步深入到实际应用,最后通过一个代码示例来巩固所学知识。让我们一起开启这段旅程吧!
|
12月前
|
Web App开发 开发框架 JavaScript
深入浅出Node.js后端开发
本文将带你领略Node.js的魅力,从基础概念到实践应用,一步步深入理解并掌握Node.js在后端开发中的运用。我们将通过实例学习如何搭建一个基本的Web服务,探讨Node.js的事件驱动和非阻塞I/O模型,以及如何利用其强大的生态系统进行高效的后端开发。无论你是前端开发者还是后端新手,这篇文章都会为你打开一扇通往全栈开发的大门。
|
JavaScript 前端开发 API
深入理解Node.js事件循环及其在后端开发中的应用
本文旨在揭示Node.js的核心特性之一——事件循环,并探讨其对后端开发实践的深远影响。通过剖析事件循环的工作原理和关键组件,我们不仅能够更好地理解Node.js的非阻塞I/O模型,还能学会如何优化我们的后端应用以提高性能和响应能力。文章将结合实例分析事件循环在处理大量并发请求时的优势,以及如何避免常见的编程陷阱,从而为读者提供从理论到实践的全面指导。
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
本文将带你走进Node.js的世界,从基础到进阶,逐步解析Node.js在后端开发中的应用。我们将通过实例来理解Node.js的异步特性、事件驱动模型以及如何利用它处理高并发请求。此外,文章还会介绍如何搭建一个基本的Node.js服务器,并探讨如何利用现代前端框架与Node.js进行交互,实现全栈式开发。无论你是初学者还是有一定经验的开发者,这篇文章都将为你提供新的视角和深入的理解。
423 4