简介
purdy 是一个 Node.js 的终端打印工具,支持将 JSON、JavaScript 对象和数组优化并美化输出到终端,方便调试和排查问题。
使用 purdy 可以:
- 高亮显示关键字,让输出更清晰易懂
- 自定义主题配色
- 提供多种输出格式,包括 JSON、JavaScript 和 Ruby
安装
通过 npm 进行安装:
npm install purdy
或全局安装:
npm install -g purdy
使用
基本用法
在代码中引入 purdy 模块:
const purdy = require('purdy');
输出 JSON、JavaScript 对象和数组,如下所示:
const data = { name: "John", age: 30 }; purdy(data); purdy([1, 2, 3]);
上述代码将优化和美化输出 data 和数组 [1, 2, 3] 至终端。
purdy 还支持输出字符串和整数等数据类型:
purdy("Hello, World!"); purdy(42);
在终端中使用
在终端运行以下代码,将 JSON 文件内容输出至终端:
cat data.json | purdy
以下代码将用户的信息以表格的形式输出至终端:
curl -X GET http://localhost:5000/api/user -H "Content-Type: application/json" | purdy -t table -k name,email,address
上述命令中 -t
参数指定输出格式,这里为表格格式,-k
参数指定要输出的字段,多个字段用逗号分隔。
高级选项
purdy 支持几种自定义选项,让输出更人性化。
高亮关键字
高亮关键字可以让输出更加清晰易懂,以下是在代码中使用关键字高亮的示例:
const data = { name: "John", age: 30 }; const options = { keywords: ['name', 'age'] }; purdy(data, options);
在终端中输出 data 参数时,将会把 ‘name’ 和 ‘age’ 这两个关键字高亮。
自定义主题配色
purdy 支持自定义主题,可以通过以下代码创建一个新的 theme:
-- -------------------- ---- ------- ----- ----- - ---------------- ------------ ------ ------------ --------- ---------- ------- ---------- ------- --------- -------- ------------- --------- ------------ --------- ---
上述代码创建了一个名为 theme 的主题,可以用在接下来的输出中。
使用主题实例时,可以通过在第二个参数中传递 options 对象,选中 theme 中的样式。
const data = { name: "John", age: 30 }; const options = { theme: theme }; purdy(data, options);
purdy 还支持使用内置主题。
purdy(data, { theme: 'daisy' });
自定义缩进和极限深度
purdy 还支持在输出中自定义缩进和极限深度。以下是在代码中使用自定义缩进和极限深度的示例:
const data = { name: "John", age: 30 }; const options = { indent: 8, depth: 3 }; purdy(data, options);
在终端中输出 data 参数时,将会把缩进距离设置为 8 个空格,最大输出深度为 3 级。
结论
本文介绍了 purdy 包的使用方法,包括基本用法、在终端中使用、高级选项等。通过本文,你可以了解到 purdy 的许多特性,帮助你更方便地调试和排查问题。
在实际开发中,purdy 已经成为了一款广受欢迎的 Node.js 开发工具,大大提高了开发效率。想要了解更多 purdy 的使用技巧和案例,可以参考官方文档。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/63998