npm 开源模块,如何配置属于本模块的命令集,全局、局部安装可以使用该命令

本文主要是介绍npm 开源模块,如何配置属于本模块的命令集,全局、局部安装可以使用该命令,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

其实要配置属于本模块专属命令并不复杂,只需在 package.json 里配置 bin 属性就可以了,下面我们通过一个列子来说明

// package.json"bin": {"tracelib": "./bin/tracelib.js"},
#!/usr/bin/env node
const fs = require('fs');
const path = require('path');
const package = require('../package.json');
const { tracelib } = require('../dist/tracelib.js');// 输出数据
function outputData(result, outputPath) {if (outputPath) {fs.writeFile(path.resolve(process.cwd(), outputPath), JSON.stringify(result), 'utf-8', function(error) {console.log('写入成功');});} else {console.log(result);}
}function run(argv) {if (argv[0] === '-v' || argv[0] === '--version') {console.log('  version is ' + package.version);} else if (argv[0] === '-h' || argv[0] === '--help') {console.log('  usage:\n');console.log('  -v --version                                 [show version]');console.log('  [logPath][getSummary][outputPath?]           Fetch total time-durations of scripting, rendering, painting from tracelogs.');console.log('  [logPath][getWarningCounts][outputPath?]     Fetch amount of forced synchronous layouts and styles as well as long recurring handlers.');console.log('  [logPath][getFPS][outputPath?]               Fetch frames per second.');console.log('  [logPath][getMemoryCounters][outputPath?]    Fetch data for JS Heap, Documents, Nodes, Listeners and GPU Memory from tracelogs.');console.log('  [logPath][getDetailStats][outputPath?]       Fetch data (timestamp and values) of scripting, rendering, painting from tracelogs.');} else if (argv.length >= 2) {const logData = require(path.resolve(process.cwd(), argv[0]));const type = argv[1];let result = '';switch (type) {case 'getSummary':result = tracelib.getSummary(logData);break;case 'getWarningCounts':result = tracelib.getWarningCounts(logData);break;case 'getFPS':result = tracelib.getFPS(logData);break;case 'getMemoryCounters':result = tracelib.getMemoryCounters(logData);break;case 'getDetailStats':result = tracelib.getDetailStats(logData);break;default:console.log(new Error('This method is not available yet.'));break;}outputData(result, argv[2]);}
}run(process.argv.slice(2));

这里是一个简单的一个封装命令的源码

其实就是一个简单的 cmd 命令参数的解析,process.argv值的处理

process 对象是一个全局变量,它提供当前 Node.js 进程的有关信息,以及控制当前 Node.js 进程。 因为是全局变量,所以无需使用 require()。

process.argv 属性返回一个数组,这个数组包含了启动Node.js进程时的命令行参数,

其中:

数组的第一个元素process.argv[0]——返回启动Node.js进程的可执行文件所在的绝对路径

第二个元素process.argv[1]——为当前执行的JavaScript文件路径

剩余的元素为其他命令行参数

node index.js param1 param2

这我们可以看到,从第二个参数后就是我们传的参数,以空格分开。

只要配置在 bin 属性后,通过命令安装后,就会在全局、局部 node_modules\bin 目录下生成对应环境的可执行文件。

这样就可以通过 bin 中的命令属性,按我们预定的规则执行代码了。

下面我们来演示一下刚才封装的命令,是否能正常执行

如果有不明白的可以具体参考下面的开源库

这是一个非常适用的库,主要功能是,根据 chrome 生成的 trace log 文件,通过模块封装的函数,输出具体的性能值,方便图表展示

tracelib-cjs: This library provides a set of models from the devtools-frontend code base in order to parse trace log files.Note: This is early development and not ready to be consumed yet!

如何发布自己封装的库到 npm 请参考

vue 如何开发封装自己的公共组件库,并发布到 npm 上

这篇关于npm 开源模块,如何配置属于本模块的命令集,全局、局部安装可以使用该命令的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/945569

相关文章

Git可视化管理工具(SourceTree)使用操作大全经典

《Git可视化管理工具(SourceTree)使用操作大全经典》本文详细介绍了SourceTree作为Git可视化管理工具的常用操作,包括连接远程仓库、添加SSH密钥、克隆仓库、设置默认项目目录、代码... 目录前言:连接Gitee or github,获取代码:在SourceTree中添加SSH密钥:Cl

Python中模块graphviz使用入门

《Python中模块graphviz使用入门》graphviz是一个用于创建和操作图形的Python库,本文主要介绍了Python中模块graphviz使用入门,具有一定的参考价值,感兴趣的可以了解一... 目录1.安装2. 基本用法2.1 输出图像格式2.2 图像style设置2.3 属性2.4 子图和聚

windows和Linux使用命令行计算文件的MD5值

《windows和Linux使用命令行计算文件的MD5值》在Windows和Linux系统中,您可以使用命令行(终端或命令提示符)来计算文件的MD5值,文章介绍了在Windows和Linux/macO... 目录在Windows上:在linux或MACOS上:总结在Windows上:可以使用certuti

CentOS和Ubuntu系统使用shell脚本创建用户和设置密码

《CentOS和Ubuntu系统使用shell脚本创建用户和设置密码》在Linux系统中,你可以使用useradd命令来创建新用户,使用echo和chpasswd命令来设置密码,本文写了一个shell... 在linux系统中,你可以使用useradd命令来创建新用户,使用echo和chpasswd命令来设

Python使用Matplotlib绘制3D曲面图详解

《Python使用Matplotlib绘制3D曲面图详解》:本文主要介绍Python使用Matplotlib绘制3D曲面图,在Python中,使用Matplotlib库绘制3D曲面图可以通过mpl... 目录准备工作绘制简单的 3D 曲面图绘制 3D 曲面图添加线框和透明度控制图形视角Matplotlib

Pandas中统计汇总可视化函数plot()的使用

《Pandas中统计汇总可视化函数plot()的使用》Pandas提供了许多强大的数据处理和分析功能,其中plot()函数就是其可视化功能的一个重要组成部分,本文主要介绍了Pandas中统计汇总可视化... 目录一、plot()函数简介二、plot()函数的基本用法三、plot()函数的参数详解四、使用pl

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述:为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格

redis中使用lua脚本的原理与基本使用详解

《redis中使用lua脚本的原理与基本使用详解》在Redis中使用Lua脚本可以实现原子性操作、减少网络开销以及提高执行效率,下面小编就来和大家详细介绍一下在redis中使用lua脚本的原理... 目录Redis 执行 Lua 脚本的原理基本使用方法使用EVAL命令执行 Lua 脚本使用EVALSHA命令

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok?2. @SneakyThrows