Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Use GitHub markdown diff syntax highlighting for assertion failures

オープン
#254 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
github-actions, typescript
領域
ci-cd, testing

調査の方向性

アサーション失敗と生成された GitHub テストサマリーをフォーマットするコードを見つけ、その出力を提案された diff-markdown の例と比較します。長いアサーション失敗が既存のレイアウトを変更せずに GitHub の diff 構文ハイライト付きでレンダリングされれば作業は完了です。payload では特定のファイルやテストを指定しません。

索引モデルが issue の本文から書いたものです。

説明

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?

主要言語
TypeScript
スター
380
フォーク
43
平均マージ
3日 11時間
マージ済み PR(30日)
2

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ctrf-io/github-test-reporter のほかの issue

ctrf-io/github-test-reporter の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。