Hacktoberfest 2026：維護者為十月標記出來的 issue，仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Add one shared encoder for the server's event stream lines

未關閉
  • 哪裡不對？
#241 2 則留言 0 個 reaction 已指派 1 人 在 GitHub 檢視

維護者通常 1 天內回覆

@kachamsiddarth 已經在處理了。

開始於 2026年10月20日。

評估

這個 Issue 還沒有評估資料。

描述

core enhancement good first issue hacktoberfest

Each server adapter builds its own SSE lines and writes its own data: [DONE] (packages/server/src/adapters/express.ts, lines 59 and 61, vercel.ts, lines 55 and 57, cloudflare.ts, lines 72 and 74), and their headers differ slightly. For protocol v1, one module will own the format so the adapters only move bytes. This issue is that module.

What to do
Create packages/core/src/protocol/sse.ts:

/** One event: `data: <json>` and a blank line. */
export function encodeSSE(part: WirePart | Record<string, unknown>): string;

/** A comment line that keeps the connection busy while nothing else is sent. */
export const SSE_PING: string;     // ': ping\n\n'

/** Ends the stream. */
export const SSE_DONE: string;     // 'data: [DONE]\n\n'

export const SSE_HEADERS: Readonly<Record<string, string>>;
  • SSE_HEADERS: Content-Type: text/event-stream; charset=utf-8, Cache-Control: no-cache, no-transform (stops proxies from compressing and buffering), X-Accel-Buffering: no (nginx). Leave out Connection. HTTP/2 doesn't allow it, and the runtimes handle it themselves.
  • encodeSSE must never produce a raw line break inside the data line. JSON.stringify already escapes \n and \r, so test that a part with line breaks in its text stays on one line. Also test that U+2028 and U+2029 survive.

Where to look

Acceptance criteria

  • New packages/core/src/protocol/sse.ts, exported from packages/core/src/protocol/index.ts and from @chatcops/core
  • Tests for the line format, line breaks in text, U+2028/U+2029, and the exact header values
  • The adapters aren't changed in this PR (I switch them over in the protocol PR)
  • Changeset for @chatcops/core (minor)
  • pnpm test:coverage and pnpm lint pass

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

主要語言
TypeScript
星號
13
分支
7
平均合併
4 小時 11 分鐘
30 天內合併 PR
122

環境準備

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

codercops/chatcops 的其他 Issue

查看 codercops/chatcops 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。