收获清单调试源码优雅的获取package.json规范包元数据import.meta.url的应用学前准备下载源码git clone https://github.com/sindresorhus/read-pkg.gitcd read-pkg&&yarn
一般源码学习先看readme.md和package.json，readme教用法，package.json则会注明命令，一般我们调试也是从package.json的script入手，甩个截图：
这命令第一次见可能不知道它想表达啥，再往下看devdependencies就可以知道三个命令分别对应三个包，不知道包干嘛的？自行百度去，一般包的用法都能在npm上搜到
ava
node.js测试包
tsd
检测ts类型
xo
(eslint包装器)，具有很好的默认值
源码调试分析 提前在入口文件打好断点，然后点package.json的script中的调试脚本按钮开启调试，如果没有这个按钮，则可能需要更新vscode。
源码结构分析
引入依赖// node进程import process from 'node:process';// fs文件模块import fs, {promises as fspromises} from 'node:fs';// path 路径模块import path from 'node:path';// url模块import {fileurltopath} from 'node:url';// 解析json，并且会伴随有用的报错，https://github.com/sindresorhus/parse-json#readmeimport parsejson from 'parse-json';// 规范化包元数据 https://github.com/npm/normalize-package-data#readmeimport normalizepackagedata from 'normalize-package-data';
将url转化为文件路径// fileurltopath将url转化为文件路径const topath = urlorpath => urlorpath instanceof url ? fileurltopath(urlorpath) : urlorpath;
随着调试来到了test文件，有几个概念在很多源码中都会看到，因此值得我们关注一下，下面分别解析：
import.meta.url
主要是应用于__filename和__dirname在es模块不可用
path.dirname 用于获取指定路径的目录名称
fileurltopath(import.meta.url)
提取路径
process.chdir 更改node.js进程的当前工作目录，或者在执行失败时抛出异常(例如，如果指定的目录不存在)。
readpackage方法(异步读取)export async function readpackage({cwd, normalize = true} = {}) {// 默认用process.cwd获取当前工作目录，获取工作目录 cwd = topath(cwd) || process.cwd();// 获取package.json相对当前工作目录的绝对路径 const filepath = path.resolve(cwd, 'package.json');// 异步读取package.json并解析，fspromises异步文件模块 const json = parsejson(await fspromises.readfile(filepath, 'utf8')); // 规范化包元数据 if (normalize) { normalizepackagedata(json); } return json;}
readpackagesync方法（同步读取）export function readpackagesync({cwd, normalize = true} = {}) { // 默认用process.cwd获取当前工作目录，获取工作目录 cwd = topath(cwd) || process.cwd(); // 获取package.json相对当前工作目录的绝对路径 const filepath = path.resolve(cwd, 'package.json'); // 读取package.json并解析 const json = parsejson(fs.readfilesync(filepath, 'utf8')); // 序列化元数据 if (normalize) { normalizepackagedata(json); } return json;}
normalizepackagedata作用序列化前
序列化后
调试后发现序列化后会生成_id,对应测试用例中的t.truthy(package_._id)
总结 今天下载并调试了read-pkg的源码，进一步了解了nodejs的path、url、process模块对于读取文件的应用，read-pkg麻雀虽小五脏俱全，完整的测试用例也是我们可以在自己的工具包中借鉴使用的！今天刚好是国庆，追梦人们国庆快乐哇~
更多node相关知识，请访问：nodejs 教程！
以上就是技巧分享：优雅的获取 package.json 文件的详细内容。