nrm的使用与源码分析

2024-02-27 21:48
文章标签 分析 源码 使用 nrm

本文主要是介绍nrm的使用与源码分析,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、nrm的使用

.在使用npm进行项目拉取的时候,我们可能会进行切换不同的镜像去下载,下面这个就是快速切换镜像的插件
快速切换npm源的开源工具nrm-github地址
快速切换npm源的开源工具–nrm
在这里我们对nrm源码进行查看:
1.如下所示,nrm源码结构
nrm源码
在上面源码中,各个文件对应意义如下所示:

.gitignore--------------------git上传文件时的忽略文件
cli.js------------------------nrm项目的主要代码
package.json------------------npm项目配置文件
registries.json---------------已经注册过的镜像地址,可以进行拉取包的镜像

2.cli.js文件说明
首先来看一下代码内容

#!/usr/bin/env node
var path = require('path');
var fs = require('fs');
var program = require('commander');
var npm = require('npm');
var ini = require('ini');
var echo = require('node-echo');
var extend = require('extend');
var open = require('open');
var async = require('async');
var request = require('request');
var only = require('only');var registries = require('./registries.json');
var PKG = require('./package.json');
var NRMRC = path.join(process.env.HOME, '.nrmrc');
program.version(PKG.version);
program.command('ls').description('List all the registries').action(onList);
program.command('current').description('Show current registry name').action(showCurrent);
program.command('use <registry>').description('Change registry to registry').action(onUse);
program.command('add <registry> <url> [home]').description('Add one custom registry').action(onAdd);
program.command('del <registry>').description('Delete one custom registry').action(onDel);
program.command('home <registry> [browser]').description('Open the homepage of registry with optional browser').action(onHome);
program.command('test [registry]').description('Show response time for specific or all registries').action(onTest);
program.command('help').description('Print this help').action(function () {program.outputHelp();});
program.parse(process.argv);
if (process.argv.length === 2) {program.outputHelp();
}
/* cmd methods /*/
function onList() {getCurrentRegistry(function(cur) {var info = [''];var allRegistries = getAllRegistry();Object.keys(allRegistries).forEach(function(key) {var item = allRegistries[key];var prefix = item.registry === cur ? '* ' : '  ';info.push(prefix + key + line(key, 8) + item.registry);});info.push('');printMsg(info);});
}
function showCurrent() {getCurrentRegistry(function(cur) {var allRegistries = getAllRegistry();Object.keys(allRegistries).forEach(function(key) {var item = allRegistries[key];if (item.registry === cur) {printMsg([key]);return;}});});
}
function onUse(name) {var allRegistries = getAllRegistry();if (allRegistries.hasOwnProperty(name)) {var registry = allRegistries[name];npm.load(function (err) {if (err) return exit(err);npm.commands.config(['set', 'registry', registry.registry], function (err, data) {if (err) return exit(err);console.log('                        ');var newR = npm.config.get('registry');printMsg(['', '   Registry has been set to: ' + newR, '']);})});} else {printMsg(['', '   Not find registry: ' + name, '']);}
}
function onDel(name) {var customRegistries = getCustomRegistry();if (!customRegistries.hasOwnProperty(name)) return;getCurrentRegistry(function(cur) {if (cur === customRegistries[name].registry) {onUse('npm');}delete customRegistries[name];setCustomRegistry(customRegistries, function(err) {if (err) return exit(err);printMsg(['', '    delete registry ' + name + ' success', '']);});});
}
function onAdd(name, url, home) {var customRegistries = getCustomRegistry();if (customRegistries.hasOwnProperty(name)) return;var config = customRegistries[name] = {};if (url[url.length - 1] !== '/') url += '/'; // ensure url end with /config.registry = url;if (home) {config.home = home;}setCustomRegistry(customRegistries, function(err) {if (err) return exit(err);printMsg(['', '    add registry ' + name + ' success', '']);});
}
function onHome(name, browser) {var allRegistries = getAllRegistry();var home = allRegistries[name] && allRegistries[name].home;if (home) {var args = [home];if (browser) args.push(browser);open.apply(null, args);}
}
function onTest(registry) {var allRegistries = getAllRegistry();var toTest;if (registry) {if (!allRegistries.hasOwnProperty(registry)) {return;}toTest = only(allRegistries, registry);} else {toTest = allRegistries;}async.map(Object.keys(toTest), function(name, cbk) {var registry = toTest[name];var start = +new Date();request(registry.registry + 'pedding', function(error) {cbk(null, {name: name,registry: registry.registry,time: (+new Date() - start),error: error ? true : false});});}, function(err, results) {getCurrentRegistry(function(cur) {var msg = [''];results.forEach(function(result) {var prefix = result.registry === cur ? '* ' : '  ';var suffix = result.error ? 'Fetch Error' : result.time + 'ms';msg.push(prefix + result.name + line(result.name, 8) + suffix);});msg.push('');printMsg(msg);});});
}
/* helper methods /*/
/** get current registry*/
function getCurrentRegistry(cbk) {npm.load(function(err, conf) {if (err) return exit(err);cbk(npm.config.get('registry'));});
}
function getCustomRegistry() {return fs.existsSync(NRMRC) ? ini.parse(fs.readFileSync(NRMRC, 'utf-8')) : {};
}
function setCustomRegistry(config, cbk) {echo(ini.stringify(config), '>', NRMRC, cbk);
}
function getAllRegistry() {return extend({}, registries, getCustomRegistry());
}
function printErr(err) {console.error('an error occured: ' + err);
}
function printMsg(infos) {infos.forEach(function(info) {console.log(info);});
}
/** print message & exit*/
function exit(err) {printErr(err);process.exit(1);
}
function line(str, len) {var line = new Array(Math.max(1, len - str.length)).join('-');return ' ' + line + ' ';
}
如下代码,进行引入使用的依赖包
#!/usr/bin/env node
var path = require('path'); 
var fs = require('fs');
var program = require('commander');
var npm = require('npm');
var ini = require('ini');
var echo = require('node-echo');
var extend = require('extend');
var open = require('open');
var async = require('async');
var request = require('request');
var only = require('only');var registries = require('./registries.json');
var PKG = require('./package.json');
var NRMRC = path.join(process.env.HOME, '.nrmrc');

上面代码中,第一行这种用法是为了防止操作系统用户没有将node装在默认的/usr/bin路径里。当系统看到这一行的时候,首先会到env设置里查找node的安装路径,再调用对应路径下的解释器程序完成操作。
commander包是npm依赖排名前十之一的模块,主要作用为命令行辅助工具
registries注册的npm镜像
PKG是package.json文件,在这里用于获取包的版本号
NRMRC是npm配置文件的位置,用于写入npm配置信息,里边就包含npm镜像的地址位置

如下代码,能够使用的命令行代码
program.version(PKG.version); //package包的版本
program.command('ls') //可以输入的命令ls.description('List all the registries')//描述性信息.action(onList); //调用该命令行对应的方法
program.command('current')//可以输入的命令ls.description('Show current registry name')//描述性信息.action(showCurrent); //调用的方法名,对应后面自己写的方法名,在该方法中进行该命令行对应的代码功能
program.command('use <registry>').description('Change registry to registry').action(onUse);
program.command('add <registry> <url> [home]').description('Add one custom registry').action(onAdd);
program.command('del <registry>').description('Delete one custom registry').action(onDel);
program.command('home <registry> [browser]').description('Open the homepage of registry with optional browser').action(onHome);
program.command('test [registry]').description('Show response time for specific or all registries').action(onTest);
program.command('help').description('Print this help').action(function () {program.outputHelp();});
program.parse(process.argv);
if (process.argv.length === 2) {program.outputHelp();
}
命令行调用的方法
/* cmd methods /*/
function onList() {//展示镜像列表的方法,对应上面命令行代码中action调用的方法名getCurrentRegistry(function(cur) {var info = [''];var allRegistries = getAllRegistry();Object.keys(allRegistries).forEach(function(key) {var item = allRegistries[key];var prefix = item.registry === cur ? '* ' : '  ';info.push(prefix + key + line(key, 8) + item.registry);});info.push('');printMsg(info);});
}
function showCurrent() {//展示当前使用的镜像getCurrentRegistry(function(cur) {var allRegistries = getAllRegistry();Object.keys(allRegistries).forEach(function(key) {var item = allRegistries[key];if (item.registry === cur) {printMsg([key]);return;}});});
}
function onUse(name) {var allRegistries = getAllRegistry();if (allRegistries.hasOwnProperty(name)) {var registry = allRegistries[name];npm.load(function (err) {if (err) return exit(err);npm.commands.config(['set', 'registry', registry.registry], function (err, data) {if (err) return exit(err);console.log('                        ');var newR = npm.config.get('registry');printMsg(['', '   Registry has been set to: ' + newR, '']);})});} else {printMsg(['', '   Not find registry: ' + name, '']);}
}
function onDel(name) {var customRegistries = getCustomRegistry();if (!customRegistries.hasOwnProperty(name)) return;getCurrentRegistry(function(cur) {if (cur === customRegistries[name].registry) {onUse('npm');}delete customRegistries[name];setCustomRegistry(customRegistries, function(err) {if (err) return exit(err);printMsg(['', '    delete registry ' + name + ' success', '']);});});
}
function onAdd(name, url, home) {var customRegistries = getCustomRegistry();if (customRegistries.hasOwnProperty(name)) return;var config = customRegistries[name] = {};if (url[url.length - 1] !== '/') url += '/'; // ensure url end with /config.registry = url;if (home) {config.home = home;}setCustomRegistry(customRegistries, function(err) {if (err) return exit(err);printMsg(['', '    add registry ' + name + ' success', '']);});
}
function onHome(name, browser) {var allRegistries = getAllRegistry();var home = allRegistries[name] && allRegistries[name].home;if (home) {var args = [home];if (browser) args.push(browser);open.apply(null, args);}
}
function onTest(registry) {var allRegistries = getAllRegistry();var toTest;if (registry) {if (!allRegistries.hasOwnProperty(registry)) {return;}toTest = only(allRegistries, registry);} else {toTest = allRegistries;}async.map(Object.keys(toTest), function(name, cbk) {var registry = toTest[name];var start = +new Date();request(registry.registry + 'pedding', function(error) {cbk(null, {name: name,registry: registry.registry,time: (+new Date() - start),error: error ? true : false});});}, function(err, results) {getCurrentRegistry(function(cur) {var msg = [''];results.forEach(function(result) {var prefix = result.registry === cur ? '* ' : '  ';var suffix = result.error ? 'Fetch Error' : result.time + 'ms';msg.push(prefix + result.name + line(result.name, 8) + suffix);});msg.push('');printMsg(msg);});});
}
帮助信息方法
/* helper methods /*/
/** get current registry*/
function getCurrentRegistry(cbk) {npm.load(function(err, conf) {if (err) return exit(err);cbk(npm.config.get('registry'));});
}
function getCustomRegistry() {return fs.existsSync(NRMRC) ? ini.parse(fs.readFileSync(NRMRC, 'utf-8')) : {};
}
function setCustomRegistry(config, cbk) {echo(ini.stringify(config), '>', NRMRC, cbk);
}
function getAllRegistry() {return extend({}, registries, getCustomRegistry());
}
function printErr(err) {console.error('an error occured: ' + err);
}
function printMsg(infos) {infos.forEach(function(info) {console.log(info);});
}
打印信息语句
/** print message & exit*/
function exit(err) {printErr(err);process.exit(1);
}
function line(str, len) {var line = new Array(Math.max(1, len - str.length)).join('-');return ' ' + line + ' ';
}

3.registries.json文件说明
在下面这个文件中,指明了镜像的地址,通过在.npmrc中修改该地址,能够进行切换npm镜像地址,下面就是可以拉取包的npm

{"npm": {"home": "https://www.npmjs.org","registry": "https://registry.npmjs.org/"},"cnpm": {"home": "http://cnpmjs.org","registry": "http://r.cnpmjs.org/"},"taobao": {"home": "https://npm.taobao.org","registry": "https://registry.npm.taobao.org/"},"nj": {"home": "https://www.nodejitsu.com","registry": "https://registry.nodejitsu.com/"},"rednpm": {"home": "http://npm.mirror.cqupt.edu.cn/","registry": "http://registry.mirror.cqupt.edu.cn/"},"npmMirror": {"home": "https://skimdb.npmjs.com/","registry": "https://skimdb.npmjs.com/registry/"},"edunpm": {"home": "http://www.enpmjs.org","registry": "http://registry.enpmjs.org/"}
}
二、npm包发布问题

npm发布包–所遇到的问题

这篇关于nrm的使用与源码分析的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种

解决1093 - You can‘t specify target table报错问题及原因分析

《解决1093-Youcan‘tspecifytargettable报错问题及原因分析》MySQL1093错误因UPDATE/DELETE语句的FROM子句直接引用目标表或嵌套子查询导致,... 目录报js错原因分析具体原因解决办法方法一:使用临时表方法二:使用JOIN方法三:使用EXISTS示例总结报错原

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

使用Python删除Excel中的行列和单元格示例详解

《使用Python删除Excel中的行列和单元格示例详解》在处理Excel数据时,删除不需要的行、列或单元格是一项常见且必要的操作,本文将使用Python脚本实现对Excel表格的高效自动化处理,感兴... 目录开发环境准备使用 python 删除 Excphpel 表格中的行删除特定行删除空白行删除含指定

深入理解Go语言中二维切片的使用

《深入理解Go语言中二维切片的使用》本文深入讲解了Go语言中二维切片的概念与应用,用于表示矩阵、表格等二维数据结构,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录引言二维切片的基本概念定义创建二维切片二维切片的操作访问元素修改元素遍历二维切片二维切片的动态调整追加行动态

MySQL中的LENGTH()函数用法详解与实例分析

《MySQL中的LENGTH()函数用法详解与实例分析》MySQLLENGTH()函数用于计算字符串的字节长度,区别于CHAR_LENGTH()的字符长度,适用于多字节字符集(如UTF-8)的数据验证... 目录1. LENGTH()函数的基本语法2. LENGTH()函数的返回值2.1 示例1:计算字符串

prometheus如何使用pushgateway监控网路丢包

《prometheus如何使用pushgateway监控网路丢包》:本文主要介绍prometheus如何使用pushgateway监控网路丢包问题,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录监控网路丢包脚本数据图表总结监控网路丢包脚本[root@gtcq-gt-monitor-prome

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数