From 5858da3cbfd8b2b7625eeed824f38024bde33328 Mon Sep 17 00:00:00 2001
From: Janhvibabani <janhvibabani@gmail.com>
Date: Wed, 11 Sep 2024 22:22:47 +0530
Subject: [PATCH] Added codemods for socket.io 4.0

---
 .../07-Migrations/migrating-from-3-to-4.md    | 36 +++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/docs/categories/07-Migrations/migrating-from-3-to-4.md b/docs/categories/07-Migrations/migrating-from-3-to-4.md
index c93188ea..e3788b7c 100644
--- a/docs/categories/07-Migrations/migrating-from-3-to-4.md
+++ b/docs/categories/07-Migrations/migrating-from-3-to-4.md
@@ -25,6 +25,30 @@ Here is the complete list of changes:
   - [`autoUnref` option](#autounref-option)
 - [Known migration issues](#known-migration-issues)
 
+## Codemods
+### Socket.io v4 Codemods
+To assist with the upgrade from Socket.io 3.x to 4.0, Codemod provides open-source codemods that automatically transform your code to many of the new APIs and patterns.
+
+Run the following codemod to automatically update your code for Socket.io v4 migration:
+
+```
+npx codemod@latest socket.io/4/migration-recipe
+
+```
+This will run the following codemods from the Socket.io Codemod repository:
+- **socket.io/4/ws-engine-format-update**
+- **socket.io/4/removing-useless-broadcast-flag**
+
+Each of these codemods automates the changes listed in the v4 migration guide.
+For a complete list of available Fastify codemods and further details, 
+see the [codemod registry](https://codemod.com/registry?q=socket.io).
+
+If you have any feedback for codemods run this command:
+
+```
+npx codemod feedback
+```
+
 ### Breaking changes
 
 #### `io.to()` is now immutable
@@ -79,6 +103,12 @@ const io = require("socket.io")(httpServer, {
 });
 ```
 
+> **Note**: Codemod updates the format of ws-engine:
+>
+> ```bash
+> npx codemod@latest socket.io/4/ws-engine-format-update
+> ```
+
 ### Configuration
 
 #### Ensure compatibility with Swift v15 clients
@@ -322,3 +352,9 @@ socket.broadcast.to("room1").emit(/* ... */);
 // INVALID
 socket.to("room1").broadcast.emit(/* ... */);
 ```
+
+> **Note**: Codemod removes `broadcast flag` with:
+>
+> ```bash
+> npx codemod@latest socket.io/4/removing-useless-broadcast-flag
+> ```
\ No newline at end of file