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

相关文章

Java中String字符串使用避坑指南

《Java中String字符串使用避坑指南》Java中的String字符串是我们日常编程中用得最多的类之一,看似简单的String使用,却隐藏着不少“坑”,如果不注意,可能会导致性能问题、意外的错误容... 目录8个避坑点如下:1. 字符串的不可变性:每次修改都创建新对象2. 使用 == 比较字符串,陷阱满

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定

Linux使用nload监控网络流量的方法

《Linux使用nload监控网络流量的方法》Linux中的nload命令是一个用于实时监控网络流量的工具,它提供了传入和传出流量的可视化表示,帮助用户一目了然地了解网络活动,本文给大家介绍了Linu... 目录简介安装示例用法基础用法指定网络接口限制显示特定流量类型指定刷新率设置流量速率的显示单位监控多个

JavaScript中的reduce方法执行过程、使用场景及进阶用法

《JavaScript中的reduce方法执行过程、使用场景及进阶用法》:本文主要介绍JavaScript中的reduce方法执行过程、使用场景及进阶用法的相关资料,reduce是JavaScri... 目录1. 什么是reduce2. reduce语法2.1 语法2.2 参数说明3. reduce执行过程

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

C++ Primer 多维数组的使用

《C++Primer多维数组的使用》本文主要介绍了多维数组在C++语言中的定义、初始化、下标引用以及使用范围for语句处理多维数组的方法,具有一定的参考价值,感兴趣的可以了解一下... 目录多维数组多维数组的初始化多维数组的下标引用使用范围for语句处理多维数组指针和多维数组多维数组严格来说,C++语言没

Springboot中分析SQL性能的两种方式详解

《Springboot中分析SQL性能的两种方式详解》文章介绍了SQL性能分析的两种方式:MyBatis-Plus性能分析插件和p6spy框架,MyBatis-Plus插件配置简单,适用于开发和测试环... 目录SQL性能分析的两种方式:功能介绍实现方式:实现步骤:SQL性能分析的两种方式:功能介绍记录

在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

《在SpringBoot中使用@Autowired和@Bean注解的示例详解》本文通过一个示例演示了如何在SpringBoot中使用@Autowired和@Bean注解进行依赖注入和Bean... 目录在 Spring Boot 中使用 @Autowired 和 @Bean 注解示例背景1. 定义 Stud