docs: add ipc example (#3667)

Author: snitin315

examples/cli/ipc/README.md

@@ -0,0 +1,53 @@
+# CLI: IPC
+
+The Unix socket to listen to (instead of a [host](../host-and-port/README.md)).
+
+## true
+
+Setting it to `true` will listen to a socket at `/your-os-temp-dir/webpack-dev-server.sock`:
+
+**webpack.config.js**
+
+```js
+module.exports={
+// ...
+ devServer:{
+ ipc:true,
+ },
+};
+```
+
+Usage via CLI:
+
+```console
+npx webpack serve --ipc
+```
+
+## string
+
+You can also listen to a different socket with:
+
+**webpack.config.js**
+
+```js
+constpath=require("path");
+
+module.exports={
+// ...
+ devServer:{
+ ipc:path.join(__dirname, "my-socket.sock"),
+ },
+};
+```
+
+Usage via CLI:
+
+```console
+npx webpack serve --ipc ./my-socket.sock
+```
+
+## What Should Happen
+
+1. The script should listen to the socket provided.
+1. A proxy server should be created.
+1. Go to `http://localhost:8080/`, you should see the text on the page itself change to read `Success!`.

examples/cli/web-server-socket/app.js examples/cli/ipc/app.jsexamples/cli/web-server-socket/app.js renamed to examples/cli/ipc/app.js

@@ -0,0 +1,34 @@
+"use strict";
+
+consthttp=require("http");
+consthttpProxy=require("http-proxy");
+// our setup function adds behind-the-scenes bits to the config that all of our
+// examples need
+const{ setup }=require("../../util");
+
+module.exports=setup({
+context: __dirname,
+entry: "./app.js",
+devServer: {
+webSocketServer: "ws",
+onAfterSetupMiddleware: (server)=>{
+constproxyPort=8080;
+constproxyHost="127.0.0.1";
+constproxy=httpProxy.createProxyServer({
+target: {socketPath: server.options.ipc},
+});
+
+constproxyServer=http.createServer((request,response)=>{
+// You can define here your custom logic to handle the request
+// and then proxy the request.
+proxy.web(request,response);
+});
+
+proxyServer.on("upgrade",(request,socket,head)=>{
+proxy.ws(request,socket,head);
+});
+
+proxyServer.listen(proxyPort,proxyHost);
+},
+},
+});

examples/cli/ipc/webpack.config.js

@@ -0,0 +1,6 @@
+"use strict";
+
+consttarget=document.querySelector("#target");
+
+target.classList.add("pass");
+target.innerHTML="Success!";