vscode插件-Turbo Console Log的完全使用指南

3,318 阅读5分钟

在实际开发中,console.log作为最常用的调试输出工具,是非常高频使用的函数,函数的目的是帮我们打印调试信息,但函数的调用却需要花费敲代码的时间,所以如何在最短的时间内调用此函数就成了我们提效的一个点。

虽然一些代码片段插件提供了 console 相关的代码片段,包括vscode内也提供了自定义代码片段,即可以通过较短的输入来调用此函数,但仍避免不了键盘输入的过程。

最理想的调用方式,仍然是通过键盘快捷键,就如同我在我的一系列文章里,诸如《vscode 秒开当前文件所在远程仓库地址》所提倡的,快捷键调用才是最快的方式,我希望一键就可以在代码内自动生成打印函数的调用。

本文我就谈下我是如何使用Turbo Console Log 这个插件实现我的目的的。

此插件的安装和基本使用我就不过多赘述,相关的文章有很多,我只谈下我是如何让其更加好用的,以及其中一些的使用细节。

四个基本的快捷键

此插件提供了 5 个内置的快捷键,我们通过打开 vscode 的快捷键配置,搜索turboConsoleLog可以看到五个结果

这 5 个快捷键的功能分别是:

  1. 注释由turbo生成的 log 信息,多次调用会多次注释
  2. turbo的 log 信息包含行数信息时,在编辑代码后,引起打印函数的行数变化,使用此函数可以修正打印信息里的行数信息(基本用不到)
  3. 删除由turbo生成的 log 信息
  4. 生成turboConsoleLog 信息
  5. 取消注释由turbo生成的 log 信息

这里需要说明的是,对于 1,3 快捷键,即取消或删除由turbo生产的打印信息,尽在当前项目在 vscode 中处于激活的状态,也就是说如果你在用turbo生成了打印信息后,如果关闭了vscode后重启项目,使用这两个快捷键是没用的,消除和注释不了已生成的turbo日志。

自定义打印输出的快捷键

这里我们着重需要使用的是其第四个快捷键,即生成打印信息,其默认的快捷键是⌘ +⌥ + L,就实际使用上来说,并不方便,一是⌘ +⌥的修饰键组合并不顺手,而是L键的太靠肩键盘右侧,调用这个快捷按需要两只手操作,所以我对其进行了键绑定的用户自定义修改。

我改成了⌘ + ⇧ + a,之所以采用这个键绑定,是因为系统内置的函数注释⌘+⌥+a,两者都是输出辅助的信息,所以也方便记忆,而且其绑定键的键位布局也更顺手,一只手就能操作。

进一步美化打印的输出信息

这个插件在v2.11.0版本之后取消了对所在行数和文件的打印,所以现在默认的打印是这样的:

onLaunch(options) {
  console.log("🚀 ~ onLaunch ~ options:", options)
}

可以看到只包含函数的名称和变量的名称,而我希望打印信息可以更丰富,毕竟当项目内存在很多打印信息时,我们需要知道具体所在的页面,以及所在的行数,同时我也希望打印信息能更直观些,方便在控制台中更清楚的被视线捕捉到,具体来说:

  • 增加所在的文件信息
  • 增加打印所在的行号
  • 自定义前缀尾缀符号
  • 修改为warn类型的打印
  • 修改为单引号打印

修改方式如下,⌘+⇧+p调出全局命令窗口,搜索 user,选择打开用户设置

在搜索框内输入Turbo Console Log,看到匹配的结果,勾选红框选中选项

这样就完成了行号的配置,下面就行输出的美化:

  • Log Message Prefix:打印的前缀信息,这里我给改成了🐛
  • Log Message Suffix: 打印的后缀信息,默认是个:,为了更直观,我增加了🐛作为结尾
  • Log Type改为了warn类型
  • Quote下拉选择单引号

修改完配置后不会立即生效,需要重新启动 vscode 再执行快捷键才会生效,下面看新的打印效果:

onLaunch(options) {
    console.warn('🐛 ~ App.vue:91 ~ onLaunch ~ options 🐛:', options)
}

在控制台中的现实效果:

可以看到最后的打印信息丰富了许多,也直观了许多。

如果还不嫌不够直观,可以继续下拉后,开启wrap Log Message这个配置后

其输出的效果为:

onLaunch(options) {
    console.warn('🐛 -------------------------------------------------🐛')
    console.warn('🐛 ~ App.vue:91 ~ onLaunch ~ options 🐛:', options)
    console.warn('🐛 -------------------------------------------------🐛')
}

控制台中的实际现实效果:

还有一些其他的自定义配置,比如在打印前后添加空行,我就不过多赘述,可以自行参考官方文档

至此就实现了我理想中的调试输出效果,即能快速的完成打印日志的输出,同时也足够醒目直观。剩下要做的就是熟记⌘ + ⇧ + a这个快捷键。

最佳实践

下面说下在具体的项目开发中应该如何应用此插件

  • 对于变量的打印,光标置于变量的任意位置,使用快捷键后可生成打印日志
  • 对于方法结果的打印,需要光标选中方法的调用函数,再执行快捷键,注意这里和变量是不同的,只是光标在函数调用的位置是不生效的。
  • 当项目调试完毕后,使用⌘+⌥+d快捷键一次性删除由turbo生成的打印日志,达到快速去除打印信息的目的