Use GitHub markdown diff syntax highlighting for assertion failures

Đang mở
  • Có gì không ổn?
#254 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions, typescript
Lĩnh vực
ci-cd, testing

Hướng nghiên cứu

Xác định code định dạng các lỗi assertion và bản tóm tắt test GitHub được tạo ra, sau đó so sánh output của nó với ví dụ diff-markdown được đề xuất. Công việc hoàn tất khi các lỗi assertion dài được render với tô sáng cú pháp diff của GitHub mà không thay đổi layout hiện có; payload không nêu tên file hoặc test cụ thể nào.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

It would be nice if assertion failures used syntax highlighting, to make them easier to read, especially when the output is long (e.g. assert.deepEqual).

The following markdown achieves this without changing the layout:

Failed Tests
❌ Test name 
... Skipped lines
  {
    thing: {
+     id: 111,
-     id: 222,
      prop1: 'aaa',
      prop2: 'bbb'
    },
    prop3: 'ccc',
    prop4: 'ddd',
...
          {
+           id: 333,
-           id: 555,
          }
        ],
        prop5: 'eee',
        prop6: 'fff',
        prop7: [

<table>
  <thead>
    <tr>
      <th>Failed Tests</th>
    </tr>
  </thead>
  <tbody>
      <tr>
        <td>
<details>
<summary>❌ Test name</summary>

```diff
... Skipped lines
  {
    thing: {
+     id: 111,
-     id: 222,
      prop1: 'aaa',
      prop2: 'bbb'
    },
    prop3: 'ccc',
    prop4: 'ddd',
...
          {
+           id: 333,
-           id: 555,
          }
        ],
        prop5: 'eee',
        prop6: 'fff',
        prop7: [
```
</details>
        </td>
      </tr>
  </tbody>
</table>

It's a bit clumsy, because of the HTML table, but seems to render okay on GitHub. Can you see any drawbacks?

Ngôn ngữ chính
TypeScript
Star
381
Fork
44
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ctrf-io/github-test-reporter

Tất cả issue của ctrf-io/github-test-reporter

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.