腾讯移动端调试·vConsole

English | 简体中文

vConsole

一个轻量、可拓展、针对手机网页的前端开发者调试面板。

vConsole 是框架无关的,可以在 Vue、React 或其他任何框架中使用。

现在 vConsole 是微信小程序的官方调试工具。


功能特性

  • 日志(Logs): console.log|info|error|...
  • 网络(Network): XMLHttpRequest, Fetch, sendBeacon
  • 节点(Element): HTML 节点树
  • 存储(Storage): Cookies, LocalStorage, SessionStorage
  • 手动执行 JS 命令行
  • 自定义插件

详情可参考下方的截图。


版本说明

最新版本: 在这里插入图片描述
每个版本的详细说明请参阅 Changelog


上手

详细使用方法请参阅使用教程

将 vConsole 添加到项目中主要有以下方式:

方法一:使用 npm(推荐)
$ npm install vconsole

Import 并初始化后,即可使用 console.log 功能,如 Chrome devtools 上一样。

import VConsole from 'vconsole';

const vConsole = new VConsole();
// 或者使用配置参数来初始化,详情见文档
const vConsole = new VConsole({ theme: 'dark' });

// 接下来即可照常使用 `console` 等方法
console.log('Hello world');

// 结束调试后,可移除掉
vConsole.destroy();
方法二:使用 CDN 直接插入到 HTML
<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
<script>
  // VConsole 默认会挂载到 `window.VConsole` 上
  var vConsole = new window.VConsole();
</script>

可用的 CDN:

  • https://unpkg.com/vconsole@latest/dist/vconsole.min.js
  • https://cdn.jsdelivr.net/npm/vconsole@latest/dist/vconsole.min.js

手机预览

http://wechatfe.github.io/vconsole/demo.html

在这里插入图片描述


截图

概览

浅色主题

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jnmwIqIx-1683785301865)(./doc/screenshot/overview_light.jpg)]

深色主题

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-SjCTHCRE-1683785301867)(./doc/screenshot/overview_dark.jpg)]

Log 面板

Log 样式

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-kgYWEf7I-1683785301870)(./doc/screenshot/plugin_log_types.jpg)]

命令行

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-P42JBxOM-1683785301873)(./doc/screenshot/plugin_log_command.jpg)]

System 面板

Performance 信息

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mqW89lqs-1683785301874)(./doc/screenshot/plugin_system.jpg)]

输入日志到不同的 log 面板
console.log('output to Log panel.')
console.log('[system]', 'output to System panel.')

Network 面板

请求、回包的详情

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oRG1EqIu-1683785301876)(./doc/screenshot/plugin_network.jpg)]

Element 面板

查看 HTML 对象结构

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A7up64fB-1683785301877)(./doc/screenshot/plugin_element.jpg)]

Storage 面板

添加、编辑、删除、复制 Cookies / LocalStorage / SessionStorage

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XFaHhU2m-1683785301879)(./doc/screenshot/plugin_storage.jpg)]


文档

vConsole 本体:

自定义插件:


第三方插件列表


交流反馈

QQ 群:497430533


License

The MIT License

1 前言我们在开发手机版网页的时候,常常会出现下面的情景: (1) 开发时,在自己电脑上运行得好好的,在手机上打开就挂了,但是手机上又看不到error log;  (2) 上线后,某用户表示页面失灵,但我们自己又重现不出来,看不到用户侧的出错信息。如果说(1)还可以通过电脑连接手机以查看log来解决,那(2)在没有完善的前端上报体系时就非常被动了。作为开发者,我们的诉求很简单:有没有快捷的方法在手机前端页面看到log日志?2 vConsole前端调试面板莫慌,抱紧vConsole!vConsole是一款由微信公众平台前端团队打造的前端调试面板,专治手机端看log难题。目前vConsole自带有2个面板,默认为“日志”面板,负责展示log。细心的同学可能会发现上面的log颜色各有不同。与电脑端的Developer Tools一样,开发者可以通过调用不同的方法来打出不同的颜色,以便快速区分日志类型:console.log('foo'); // 白底黑字   console.info('bar'); // 白底紫字   console.debug('oh'); // 白底黄字  console.warn('foo'); // 黄底黄字  console.error('bar'); // 红底红字第二个是“系统”面板,vConsole会自动将一些基础信息(如系统版本)打印出来,方便开发者定位问题。若页面是在微信内置浏览器中打开的,vConsole还会打印出微信版本号、当前网络类型等额外信息。默认情况下,vConsole的面板是隐藏起来的。我们可以点击右下角的“面板”悬浮按钮来显示vConsole面板。3 使用方法Talk is cheap, show me the code.首先,在需要展示日志的页面引入vConsole模块。我们建议在<head>中而非<body>底部引入,方便后续的新版本vConsole在页面初始化时预埋各种debug钩子。引入后,会自动生成window.vConsole对象实例。<head>  [removed][removed]  </head>对于更通常的情况,我们只需在调试模式下才启用vConsole,平时用户无需看到调试面板。这时候就需要开发者自行判断引入模块的时机。以PHP为例,通过判断URL中有无 dev_mode参数来选择性加载vConsole:<?php if($_GET['dev_mode'=='1'){?>  [removed][removed]   <?php}?>如果项目中用到了CommonJS或SeaJS这种AMD/CMD规范的模块加载方式,可以在module中使用require()引入vConsole:var vConsole =require('path/to/vconsole.min.js');好了,怎么打印log呢?与电脑端一致,可以直接使用console.log()等方法来打印日志,目前支持的方法有:console.log('foo');  console.info('bar');  console.debug('oh');  console.warn('foo'); console.error('bar');若页面未加载vConsole模块,console.log()会直接输出到原生控制台中;加载模块后,日志则会输出到原生控制台 前端面板。因此不必担心兼容性问题。引入模块后,vConsole会有一小段时间用于初始化工作,在渲染出面板HTML之前将无法立即打印log。因此,若要在引入模块后立即打印log,应使用vConsole.ready()方法:vConsole.ready(function() { console.log('Hello World');  });4 在线demo微信扫描以下二维码(或微信内长按图片识别二维码),即可体验vConsole面板。目前vConsole已开源到WeChatFE的Github中。 标签:腾讯  前端工具
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值