Skip to content

Conversation

@guest271314
Copy link
Contributor

@guest271314 guest271314 commented Nov 18, 2025

  • Update README.md with server and JavaScript usage
  • Remove ws dependency; Node.js is shipped with builtin WebSocket support since v21; Deno and Bun have builtin WebSocket support

https://nodejs.org/en/learn/getting-started/websocket
https://docs.deno.com/api/web/~/WebSocket
https://bun.com/docs/runtime/http/websockets

Summary by CodeRabbit

  • Documentation

    • Added a Usage section describing how to run the example server and client across multiple runtimes (including bun and deno), steps for bundling TypeScript into a single JavaScript file, and subsequent node execution instructions.
  • Chores

    • Removed an unused development dependency from the project configuration.

@coderabbitai
Copy link

coderabbitai bot commented Nov 18, 2025

Walkthrough

This pull request updates documentation and one dev dependency for the web-transport-ws project. The README gains a Usage section documenting how to run the example server and clients (including bun and deno), how to bundle TypeScript into a single JavaScript file, and how to run it with Node. The devDependency "ws" (^8.16.0) was removed from package.json. No functional or API changes were made.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: updating README.md with usage details and noting built-in WebSocket support across runtimes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb09e61 and dbe8d45.

📒 Files selected for processing (1)
  • web-transport-ws/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • web-transport-ws/README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9239033 and fb09e61.

⛔ Files ignored due to path filters (2)
  • web-transport-ws/package-lock.json is excluded by !**/package-lock.json
  • web-transport-ws/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • web-transport-ws/README.md (1 hunks)
  • web-transport-ws/package.json (0 hunks)
💤 Files with no reviewable changes (1)
  • web-transport-ws/package.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
web-transport-ws/README.md

49-49: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


53-53: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


58-58: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


62-62: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@kixelated kixelated enabled auto-merge (squash) November 18, 2025 16:11
@kixelated kixelated merged commit 21f3417 into kixelated:main Nov 18, 2025
1 check passed
@github-actions github-actions bot mentioned this pull request Nov 18, 2025
@guest271314 guest271314 deleted the guest271314-patch-2 branch November 19, 2025 04:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants