Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Allen Zhang (张涛) committed May 23, 2024
1 parent a72a76d commit e53e551
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
# Canyon [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/canyon-project/canyon/blob/main/LICENSE) [![build status](https://github.com/canyon-project/canyon/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/canyon-project/canyon/actions/workflows/ci.yml) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](CODE_OF_CONDUCT.md) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fcanyoncov.com&logo=canyon)](https://canyoncov.com)

👋 Canyon 是一个代码覆盖率解决方案。
👋 Canyon is a JavaScript code coverage solution

![](./screenshots/coverage-report.jpg)


## 特性
## Features

**Bundling:** 多种生态的bundling方案。
**Bundling:** Support for various bundling ecosystems.

- `vite` - vite-plugin-istanbul
- `babel` - babel-plugin-istanbul
- `swc` - swc-coverage-instrument

**React Native:** 支持React Native覆盖率数据收集。
**React Native:** Support for collecting coverage data in React Native.

**File:** 支持多种文件类型,例如js、jsx、ts、tsx
**File:** Supports multiple file types, such as js, jsx, ts, and tsx.

**源码回溯:** 开启sourceMap选项来回溯源码覆盖率信息。
**Source Traceback:** Enable the sourceMap option to trace back to the original source code coverage information.

**CI** 提供覆盖率接口,方便CI工具集成。
**CI:** Provides coverage interfaces for easy integration with CI tools.

**变更代码:** 通过配置想要对比的基线Commit Sha或者分支名,过滤筛选出变更代码文件的覆盖率以及计算出整体新增代码行覆盖率。
**Changed Code:** Configure the baseline commit SHA or branch name you want to compare, filter the coverage of changed files, and calculate the overall coverage of newly added lines.

**报告组件:** 构建最小原生JavasScript的npm包,提供现代化前端报告水合方案以代替传统istanbul report。
**Reporting Component:** Build a minimal native JavaScript npm package, providing a modern frontend reporting hydration solution to replace traditional istanbul reports.

**浏览器插件:** 提供浏览器插件,供开发人员实时检测应用覆盖率详情。
**Browser Plugin:** Provide a browser plugin for developers to detect application coverage details in real-time.

Canyon 是一个JavaScript代码覆盖率收集平台。我们解决了开发人员和 QA 工程师在端到端测试中遇到的测试用例代码覆盖率收集困难的问题。
Canyon is a JavaScript code coverage collection platform. We address the difficulties developers and QA engineers encounter in collecting test case code coverage during end-to-end testing. It consists of three main parts:

- 一部分是适配各种流水线环境,提供了CI工具集成的覆盖率接口。
- A Babel plugin responsible for adapting to various CI tools and reading environment variables.

- A backend service responsible for collecting and processing coverage data, and providing coverage reporting interfaces.

- A frontend service responsible for displaying coverage reports.

- 一部分是报告,负责处理展示覆盖率数据

[Read the Docs to Learn More.](https://canyon-docs.vercel.app/overview/why-canyon)

Expand Down

0 comments on commit e53e551

Please sign in to comment.