api-client: typed helper to parse the audit JSON Lines export

オープン 初心者向け
  • 何か問題がありますか？
#144 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
85/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
api

調査の方向性

packages/api-clientで作業し、まず生成されたクライアントと既存のユニットテストのパターンを調べて、パーサーを配置する適切な場所を見つけてください。parseAuditExport(text: string): AuditEventDto[]を追加し、行の順序を保持し、末尾の改行を無視し、無効なJSON行に対してエラーを投げるようにしてください。ユニットテストを追加し、pnpm nx test api-clientを実行してください。

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

説明

enhancement good first issue priority:P3 track:web

The audit export (/audit-events/export) returns application/x-ndjson, one AuditEventDto per line, which the generated client does not parse.

Task

In packages/api-client:

  • add parseAuditExport(text: string): AuditEventDto[];
  • ignore a trailing newline, throw on invalid JSON lines, and keep the original order;
  • add unit tests.

Acceptance

pnpm nx test api-client passes. No new dependency.

主要言語
TypeScript
スター
2
フォーク
1
平均マージ
7時間 17分
マージ済み PR（30日）
197

環境構築

はじめの一歩

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

shipkeepdev/shipkeep のほかの issue

shipkeepdev/shipkeep の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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