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

相关文章

详解Vue如何使用xlsx库导出Excel文件

《详解Vue如何使用xlsx库导出Excel文件》第三方库xlsx提供了强大的功能来处理Excel文件,它可以简化导出Excel文件这个过程,本文将为大家详细介绍一下它的具体使用,需要的小伙伴可以了解... 目录1. 安装依赖2. 创建vue组件3. 解释代码在Vue.js项目中导出Excel文件,使用第三

Linux alias的三种使用场景方式

《Linuxalias的三种使用场景方式》文章介绍了Linux中`alias`命令的三种使用场景:临时别名、用户级别别名和系统级别别名,临时别名仅在当前终端有效,用户级别别名在当前用户下所有终端有效... 目录linux alias三种使用场景一次性适用于当前用户全局生效,所有用户都可调用删除总结Linux

java图像识别工具类(ImageRecognitionUtils)使用实例详解

《java图像识别工具类(ImageRecognitionUtils)使用实例详解》:本文主要介绍如何在Java中使用OpenCV进行图像识别,包括图像加载、预处理、分类、人脸检测和特征提取等步骤... 目录前言1. 图像识别的背景与作用2. 设计目标3. 项目依赖4. 设计与实现 ImageRecogni

python管理工具之conda安装部署及使用详解

《python管理工具之conda安装部署及使用详解》这篇文章详细介绍了如何安装和使用conda来管理Python环境,它涵盖了从安装部署、镜像源配置到具体的conda使用方法,包括创建、激活、安装包... 目录pytpshheraerUhon管理工具:conda部署+使用一、安装部署1、 下载2、 安装3

Mysql虚拟列的使用场景

《Mysql虚拟列的使用场景》MySQL虚拟列是一种在查询时动态生成的特殊列,它不占用存储空间,可以提高查询效率和数据处理便利性,本文给大家介绍Mysql虚拟列的相关知识,感兴趣的朋友一起看看吧... 目录1. 介绍mysql虚拟列1.1 定义和作用1.2 虚拟列与普通列的区别2. MySQL虚拟列的类型2

使用MongoDB进行数据存储的操作流程

《使用MongoDB进行数据存储的操作流程》在现代应用开发中,数据存储是一个至关重要的部分,随着数据量的增大和复杂性的增加,传统的关系型数据库有时难以应对高并发和大数据量的处理需求,MongoDB作为... 目录什么是MongoDB?MongoDB的优势使用MongoDB进行数据存储1. 安装MongoDB

关于@MapperScan和@ComponentScan的使用问题

《关于@MapperScan和@ComponentScan的使用问题》文章介绍了在使用`@MapperScan`和`@ComponentScan`时可能会遇到的包扫描冲突问题,并提供了解决方法,同时,... 目录@MapperScan和@ComponentScan的使用问题报错如下原因解决办法课外拓展总结@

mysql数据库分区的使用

《mysql数据库分区的使用》MySQL分区技术通过将大表分割成多个较小片段,提高查询性能、管理效率和数据存储效率,本文就来介绍一下mysql数据库分区的使用,感兴趣的可以了解一下... 目录【一】分区的基本概念【1】物理存储与逻辑分割【2】查询性能提升【3】数据管理与维护【4】扩展性与并行处理【二】分区的

使用Python实现在Word中添加或删除超链接

《使用Python实现在Word中添加或删除超链接》在Word文档中,超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能,本文将为大家介绍一下Python如何实现在Word中添加或... 在Word文档中,超链接是一种将文本或图像连接到其他文档、网页或同一文档中不同部分的功能。通过添加超

Linux使用fdisk进行磁盘的相关操作

《Linux使用fdisk进行磁盘的相关操作》fdisk命令是Linux中用于管理磁盘分区的强大文本实用程序,这篇文章主要为大家详细介绍了如何使用fdisk进行磁盘的相关操作,需要的可以了解下... 目录简介基本语法示例用法列出所有分区查看指定磁盘的区分管理指定的磁盘进入交互式模式创建一个新的分区删除一个存