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。

相关文章

gitlab安装及邮箱配置和常用使用方式

gitlab安装及邮箱配置和常用使用方式

《gitlab安装及邮箱配置和常用使用方式》：本文主要介绍gitlab安装及邮箱配置和常用使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装GitLab2.配置GitLab邮件服务3.GitLab的账号注册邮箱验证及其分组4.gitlab分支和标签的
阅读更多...
SpringBoot3应用中集成和使用Spring Retry的实践记录

SpringBoot3应用中集成和使用Spring Retry的实践记录

《SpringBoot3应用中集成和使用SpringRetry的实践记录》SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故... 目录1. 简介2. 环境准备3. 使用方式3.1 注解方式 基础使用自定义重试策略失败恢复机制注意事项
阅读更多...
nginx启动命令和默认配置文件的使用

nginx启动命令和默认配置文件的使用

《nginx启动命令和默认配置文件的使用》：本文主要介绍nginx启动命令和默认配置文件的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录常见命令nginx.conf配置文件location匹配规则图片服务器总结常见命令# 默认配置文件启动./nginx
阅读更多...
在Windows上使用qemu安装ubuntu24.04服务器的详细指南

在Windows上使用qemu安装ubuntu24.04服务器的详细指南

《在Windows上使用qemu安装ubuntu24.04服务器的详细指南》本文介绍了在Windows上使用QEMU安装Ubuntu24.04的全流程：安装QEMU、准备ISO镜像、创建虚拟磁盘、配置... 目录1. 安装QEMU环境2. 准备Ubuntu 24.04镜像3. 启动QEMU安装Ubuntu4
阅读更多...
使用Python和OpenCV库实现实时颜色识别系统

使用Python和OpenCV库实现实时颜色识别系统

《使用Python和OpenCV库实现实时颜色识别系统》：本文主要介绍使用Python和OpenCV库实现的实时颜色识别系统,这个系统能够通过摄像头捕捉视频流,并在视频中指定区域内识别主要颜色（红... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间详解
阅读更多...
Windows下C++使用SQLitede的操作过程

Windows下C++使用SQLitede的操作过程

《Windows下C++使用SQLitede的操作过程》本文介绍了Windows下C++使用SQLite的安装配置、CppSQLite库封装优势、核心功能（如数据库连接、事务管理）、跨平台支持及性能优... 目录Windows下C++使用SQLite1、安装2、代码示例CppSQLite：C++轻松操作SQ
阅读更多...
Python常用命令提示符使用方法详解

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,：本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安
阅读更多...
Python并行处理实战之如何使用ProcessPoolExecutor加速计算

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.
阅读更多...
Python中help()和dir()函数的使用

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象（如模块、类、函数等）的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(
阅读更多...
Linux脚本(shell)的使用方式

Linux脚本(shell)的使用方式

《Linux脚本(shell)的使用方式》：本文主要介绍Linux脚本(shell)的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录概述语法详解数学运算表达式Shell变量变量分类环境变量Shell内部变量自定义变量：定义、赋值自定义变量：引用、修改、删
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2