README.md · WeBank/wt-console

# wt-console

[![Open Source Love](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](https://shields.io/)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

注：从[WeTrident项目](https://gitee.com/WeBank/WeTrident)提炼而来。

## 📥 安装

- `npm i @webank/wt-console --save`
- `yarn add @webank/wt-console`

## 💡 背景

App开发过程中，经常会遇到一个场景就是，测试说我遇到一个xxx问题，但是不能复现，之前比较多的解决方案是基于文件日志。我们自己使用过程中发现文件日志太重，而且测试同学取日志的学习成本太高。于是在web项目中开始使用类似vConsole这一类的工具，又因为我们主要使用到的日志查看和日志上传功能。因此我们在React Native实现了类似vConsole的功能，同时在陆续扩展一些功能。

## 🌱 特性

1. 添加一行代码即可在App内查看日志。
2. 支持展示Network信息（目前支持fetch api的展示）。
3. 收拢警告和错误提示，跟RN内烦人的底部黄色警告条说再见。

## 📱 截图

![](./images/screenshot1.png)

![](./images/screenshot2.png)

## 📗 用法说明

正式使用之前可以先使用snack版本体验，在线示例： [https://snack.expo.io/@erichua23/wt-console-demo](https://snack.expo.io/@erichua23/wt-console-demo)

### 基础用法
将`TianYan`嵌入到App最外层View中：

``` jsx
import TianYan from '@webank/wt-console'

export default class SimpleApp extends Component {
  render () {
    return (
      <View style={styles.container}>
        {/* other view */}

{/* 添加下面一行代码即完成接入 */}
        <TianYan />

</View>
    )
  }
}
```

### 进阶用法

#### Console插件

默认会展示Console板块，内容类型Chrome中的Console板块。

Console插件支持三个参数：
- `showTimestamp` 是否在日志前面展示时间戳。布尔类型，默认为false
- `ignoreRedBox` 是否忽略RN对console.error默认的处理（默认会展示红屏）。布尔类型，默认为false
- `ignoreYellowBox` 是否忽略RN对console.warn默认的处理（默认会在底部展示小黄条）。布尔类型，默认为false

``` jsx
<TianYan
  consoleOptions={{
    showTimestamp: true, // 展示日志时间戳
    ignoreRedBox: true, // 隐藏默认红屏
    ignoreYellowBox: true // 隐藏默认小黄条
  }}
/>
```

注：
- 为什么引入`ignoreRedBox`和`ignoreYellowBox`：因为RN对警告的处理比较暴力，直接使用浮窗在底部拦截操作，遇到警告比较多的时候非常烦人。官方提供的了ignore的方式，但是用官方的ignore，又担心某些需要关心的警告被忽略。wt-console采用了折中的策略，将黄色警告条去除后都收拢到wt-console的图标上展示，出现warning的时候开发者可以自有选择当前是否需要继续查看warning的详细信息。如下代码将错误和警告都收拢到wt-console统一管理。

#### Network插件

默认会展示Network板块，展示应用中的网络请求信息。**同时支持一键重发指定请求。**

### 开发调试

```shell script
// 使用react-native-web进行演示
cd react-native-web-demo
npm i
npm run syncLib // 将 library 同步到 react-native-web-demo/src/ 下面
npm start // 将自动在浏览器打开
```

## ❤️ 我们的其他项目

- [WeTrident](https://github.com/WeBankFinTech/WeTrident): 一站式App开发套件。
- [React Native Search List](https://github.com/UnPourTous/react-native-search-list): A searchable ListView which supports Chinese PinYin and alphabetical index.
- [React Native Popup Stub](https://github.com/UnPourTous/react-native-popup-stub): A smart popup container.
- [WT Console Server](https://github.com/UnPourTous/wt-console-server): An open source log manager backend.

## 🤝 类似项目

- [web-console](https://github.com/whinc/web-console)：H5-based mobile web debugging tool similar to chrome devtools.
- [vConsole](https://github.com/Tencent/vConsole)：A lightweight, extendable front-end developer tool for mobile web page.

WeBank/wt-console

简介

发行版

贡献者

语言

近期动态

WeBank/wt-console .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

语言

近期动态

搜索帮助

WeBank/wt-console