feature: @putout/plugin-socket-io: add

coderaiser · coderaiser · commit cedb0aa6d073 · 2026-02-13T13:54:44.000+02:00
diff --git a/README.md b/README.md
@@ -2310,6 +2310,7 @@ Next packages not bundled with 🐊**Putout** but can be installed separately.
 | [`@putout/plugin-convert-throw`](/packages/plugin-convert-throw#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-convert-throw.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-convert-throw) |
 | [`@putout/plugin-printer`](/packages/plugin-printer#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-printer.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-printer) |
 | [`@putout/plugin-minify`](/packages/plugin-minify#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-minify.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-minify) |
+| [`@putout/plugin-socket-io`](/packages/plugin-socket-io#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-socket-io.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-socket-io) |
 
 ## 🦚 Formatters
 
diff --git a/packages/plugin-socket-io/.madrun.js b/packages/plugin-socket-io/.madrun.js
@@ -0,0 +1,12 @@
+import {run} from 'madrun';
+
+export default {
+    'test': () => `tape 'lib/**/*.spec.js' 'test/*.js'`,
+    'watch:test': async () => `nodemon -w lib -w test -x "${await run('test')}"`,
+    'lint': () => `putout .`,
+    'fresh:lint': () => run('lint', '--fresh'),
+    'lint:fresh': () => run('lint', '--fresh'),
+    'fix:lint': () => run('lint', '--fix'),
+    'coverage': async () => `c8 ${await run('test')}`,
+    'report': () => 'c8 report --reporter=lcov',
+};
diff --git a/packages/plugin-socket-io/.npmignore b/packages/plugin-socket-io/.npmignore
@@ -0,0 +1,8 @@
+.*
+test
+*.spec.js
+fixture
+yarn-error.log
+
+coverage
+*.config.*
diff --git a/packages/plugin-socket-io/.nycrc.json b/packages/plugin-socket-io/.nycrc.json
@@ -0,0 +1,15 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "exclude": [
+        "**/*.spec.*",
+        "**/fixture",
+        "test",
+        ".*.*",
+        "**/*.config.*"
+    ],
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100
+}
diff --git a/packages/plugin-socket-io/LICENSE b/packages/plugin-socket-io/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/plugin-socket-io/README.md b/packages/plugin-socket-io/README.md
@@ -0,0 +1,68 @@
+# @putout/plugin-socket-io [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-socket-io-hooks.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/plugin-socket-io-hooks "npm"
+
+> The library for web and native user interfaces
+>
+> (c) [socket-io.dev](https://socket-io.dev)
+
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin helps to migrate to new version of [socket.io](https://socket.io/). *Not bundled*.
+
+## Install
+
+```
+npm i putout @putout/plugin-socket-io-hooks -D
+```
+
+Add `.putout.json` with:
+
+```json
+{
+    "plugins": ["socket-io"]
+}
+```
+
+## Rules
+
+- ✅ [convert-io-listen-to-new-server](#convert-io-listen-to-new-server);
+- ✅ [declare](#declare);
+
+## Config
+
+```json
+{
+    "rules": {
+        "socket-io/convert-io-listen-to-new-server": "on",
+        "socket-io/declare": "on"
+    }
+}
+```
+
+## declare
+
+```diff
++import {Server} from 'socket.io';
+new Server(server);
+```
+
+## convert-io-listen-to-new-server
+
+ESM has no `listen` exported, only `Server`. So it is better to change it to simplify migration.
+Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/5348f80f9fea90155ca3a91a56bad498/7fd768e92dd2effd40cd7c1491bdbfc2cd5bff5c).
+
+### ❌ Example of incorrect code
+
+```
+io.listen(server);
+```
+
+### ✅ Example of correct code
+
+```js
+new Server(server);
+```
+
+## License
+
+MIT
diff --git a/packages/plugin-socket-io/eslint.config.js b/packages/plugin-socket-io/eslint.config.js
@@ -0,0 +1,3 @@
+import {safeAlign} from 'eslint-plugin-putout';
+
+export default safeAlign;
diff --git a/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/fixture/convert-io-listen-to-new-server-fix.js b/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/fixture/convert-io-listen-to-new-server-fix.js
@@ -0,0 +1,3 @@
+import io from 'socket.io';
+
+new Server(server);
diff --git a/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/fixture/convert-io-listen-to-new-server.js b/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/fixture/convert-io-listen-to-new-server.js
@@ -0,0 +1,3 @@
+import io from 'socket.io'
+
+io.listen(server);
diff --git a/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/index.js b/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/index.js
@@ -0,0 +1,5 @@
+export const report = () => `Use 'new Server(server)' instead of 'io.listen(server)'`;
+
+export const replace = () => ({
+    'io.listen(__a)': 'new Server(__a)',
+});
diff --git a/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/index.spec.js b/packages/plugin-socket-io/lib/convert-io-listen-to-new-server/index.spec.js
@@ -0,0 +1,18 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['convert-io-listen-to-new-server', plugin],
+    ],
+});
+
+test('socket-io: convert-io-listen-to-new-server: report', (t) => {
+    t.report('convert-io-listen-to-new-server', `Use 'new Server(server)' instead of 'io.listen(server)'`);
+    t.end();
+});
+
+test('socket-io: convert-io-listen-to-new-server: transform', (t) => {
+    t.transform('convert-io-listen-to-new-server');
+    t.end();
+});
diff --git a/packages/plugin-socket-io/lib/declare/fixture/server-fix.js b/packages/plugin-socket-io/lib/declare/fixture/server-fix.js
@@ -0,0 +1,3 @@
+import {Server} from 'socket.io';
+
+new Server(server);
diff --git a/packages/plugin-socket-io/lib/declare/fixture/server.js b/packages/plugin-socket-io/lib/declare/fixture/server.js
@@ -0,0 +1 @@
+new Server(server);
diff --git a/packages/plugin-socket-io/lib/declare/index.js b/packages/plugin-socket-io/lib/declare/index.js
@@ -0,0 +1,3 @@
+export const declare = () => ({
+    Server: 'import {Server} from "socket.io"',
+});
diff --git a/packages/plugin-socket-io/lib/declare/index.spec.js b/packages/plugin-socket-io/lib/declare/index.spec.js
@@ -0,0 +1,18 @@
+import {createTest} from '@putout/test';
+import * as declare from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['socket-io/declare', declare],
+    ],
+});
+
+test('plugin-socket-io: declare: report: server', (t) => {
+    t.report('server', `Declare 'Server', it referenced but not defined`);
+    t.end();
+});
+
+test('plugin-socket-io: declare: transform: server', (t) => {
+    t.transform('server');
+    t.end();
+});
diff --git a/packages/plugin-socket-io/lib/index.js b/packages/plugin-socket-io/lib/index.js
@@ -0,0 +1,7 @@
+import * as convertIoListenToNewServer from './convert-io-listen-to-new-server/index.js';
+import * as declare from './declare/index.js';
+
+export const rules = {
+    'declare': declare,
+    'convert-io-listen-to-new-server': convertIoListenToNewServer,
+};
diff --git a/packages/plugin-socket-io/package.json b/packages/plugin-socket-io/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@putout/plugin-socket-io",
+  "version": "1.0.0",
+  "type": "module",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "🐊Putout plugin helps to migrate to new version of socket.io",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-socket-io#readme",
+  "main": "lib/index.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "dependencies": {},
+  "keywords": [
+    "putout",
+    "putout-plugin",
+    "plugin",
+    "socket-io"
+  ],
+  "peerDependencies": {
+    "putout": ">=41"
+  },
+  "devDependencies": {
+    "@putout/test": "^15.0.0",
+    "c8": "^10.0.0",
+    "eslint": "^10.0.0",
+    "eslint-plugin-n": "^17.0.0",
+    "eslint-plugin-putout": "^30.0.0",
+    "madrun": "^12.0.0",
+    "montag": "^1.2.1"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/plugin-socket-io/test/fixture/convert-io-listen-to-new-server-fix.js b/packages/plugin-socket-io/test/fixture/convert-io-listen-to-new-server-fix.js
@@ -0,0 +1,4 @@
+import {Server} from 'socket.io';
+import io from 'socket.io';
+
+new Server(server);
diff --git a/packages/plugin-socket-io/test/fixture/convert-io-listen-to-new-server.js b/packages/plugin-socket-io/test/fixture/convert-io-listen-to-new-server.js
@@ -0,0 +1,3 @@
+import io from 'socket.io'
+
+io.listen(server);
diff --git a/packages/plugin-socket-io/test/fixture/declare-fix.js b/packages/plugin-socket-io/test/fixture/declare-fix.js
@@ -0,0 +1,3 @@
+import {Server} from 'socket.io';
+
+new Server(server);
diff --git a/packages/plugin-socket-io/test/fixture/declare.js b/packages/plugin-socket-io/test/fixture/declare.js
@@ -0,0 +1 @@
+new Server(server);
diff --git a/packages/plugin-socket-io/test/socket-io.js b/packages/plugin-socket-io/test/socket-io.js
@@ -0,0 +1,18 @@
+import {createTest} from '@putout/test';
+import * as socketIO from '../lib/index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['socket-io', socketIO],
+    ],
+});
+
+test('plugin-react: transform: declare', (t) => {
+    t.transform('declare');
+    t.end();
+});
+
+test('plugin-socket-io: transform: convert-io-listen-to-new-server', (t) => {
+    t.transform('convert-io-listen-to-new-server');
+    t.end();
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import {safeAlign} from 'eslint-plugin-putout';`
	`2`	`+`
	`3`	`+export default safeAlign;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import io from 'socket.io';`
	`2`	`+`
	`3`	`+new Server(server);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import io from 'socket.io'`
	`2`	`+`
	`3`	`+io.listen(server);`