xx-chat 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,111 @@
+# xx-chat
+
+English | [中文](#中文)
+
+A simple, lightweight, and real-time LAN CLI chat tool based on Node.js and Socket.io. With `xx-chat`, you can easily set up a chat room on your local network and chat with your friends right in your terminal.
+
+## Features
+
+- **Quick Setup**: Start a server or join as a client with simple commands or interactive prompts.
+- **Real-time Messaging**: Instant message broadcasting powered by Socket.io.
+- **Clean UI**: Solved terminal input conflicts, providing a modern chat experience in the CLI.
+- **Customizable Colors**: Personalize your message colors (supports standard color names and Hex codes like `#ff0000`).
+- **Timestamps**: Messages are displayed with clear timestamps.
+- **Command Support**: Use `/` to trigger commands like changing nicknames or quitting.
+
+## Installation
+
+You can install it globally via npm or yarn:
+
+```bash
+npm install -g xx-chat
+# or
+yarn global add xx-chat
+```
+
+## Usage
+
+### Start as a Server (Host)
+
+Start a chat server on your machine and join the chat room:
+
+```bash
+xx-chat --role server --nickname <YourNickname>
+```
+
+### Start as a Client (Guest)
+
+Join an existing chat server using its IP address:
+
+```bash
+xx-chat --role client --ip <Server_IP> --nickname <YourNickname>
+```
+
+*Tip: If you run `xx-chat` without any arguments, it will launch an interactive prompt to help you configure these settings.*
+
+### Available Commands
+
+In the chat interface, type `/` and press `Enter` to see available commands (Tab completion is supported):
+
+- `/nickname <NewName>` - Change your nickname.
+- `/color-send <Color>` - Change the color of the messages you send.
+- `/color-recv <Color>` - Change the color of the messages you receive.
+- `/quit` - Exit the chat room.
+
+*Supported colors: `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `gray`, or any Hex color code (e.g., `#ff00ff`).*
+
+---
+
+<h2 id="中文">中文</h2>
+
+一个简单、轻量级的局域网命令行（CLI）聊天工具，基于 Node.js 和 Socket.io 开发。使用 `xx-chat`，你可以轻松在局域网内搭建聊天室，并直接在终端里与朋友进行实时聊天。
+
+## 特性
+
+- **快速启动**：通过简单的命令或交互式问答，即可快速作为服务端或客户端启动。
+- **实时通信**：基于 Socket.io 的低延迟消息广播。
+- **纯净的 UI**：解决了终端输入与接收消息时的冲突问题，带来类似现代聊天软件的体验。
+- **自定义颜色**：支持自定义发送和接收消息的颜色（支持标准颜色名及 `#ff0000` 等十六进制颜色值）。
+- **时间戳**：每条消息都会清晰地展示发送时间。
+- **命令支持**：支持输入 `/` 触发快捷命令，如修改昵称或退出。
+
+## 安装
+
+你可以通过 npm 或 yarn 将其安装到全局：
+
+```bash
+npm install -g xx-chat
+# 或者
+yarn global add xx-chat
+```
+
+## 使用方法
+
+### 作为服务端（房主）启动
+
+在你的电脑上启动聊天服务，并作为第一个用户加入：
+
+```bash
+xx-chat --role server --nickname <你的昵称>
+```
+
+### 作为客户端（访客）加入
+
+使用服务端的 IP 地址连接到现有的聊天室：
+
+```bash
+xx-chat --role client --ip <服务器的局域网IP> --nickname <你的昵称>
+```
+
+*提示：如果你直接输入 `xx-chat` 不带任何参数，程序会通过交互式的问答引导你完成这些配置。*
+
+### 聊天室命令
+
+在聊天输入框中，输入 `/` 即可使用以下命令（支持按 `Tab` 键补全）：
+
+- `/nickname <新昵称>` - 修改你的聊天昵称
+- `/color-send <颜色>` - 修改你发送消息的显示颜色
+- `/color-recv <颜色>` - 修改你接收消息的显示颜色
+- `/quit` - 退出聊天室
+
+*支持的颜色：`red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `gray`，或者十六进制颜色代码（例如：`#ff00ff`）。*

package/index.js

@@ -2,7 +2,7 @@
 import { parseCli } from './src/cli.js';
 import { startServer } from './src/server.js';
 import { startClient } from './src/client.js';
-import { initUI, renderSystemMessage, renderChatMessage } from './src/ui.js';
+import { initUI, renderSystemMessage, renderChatMessage, setSendColor, setRecvColor } from './src/ui.js';
 
 async function main() {
   const { role, ip, nickname } = await parseCli();
@@ -28,7 +28,7 @@ async function main() {
       const command = parts[0];
 
       if (command === '/' || command === '/help') {
-        renderSystemMessage('可用命令：\n  /nickname <新昵称> - 修改昵称\n  /quit - 退出聊天');
+        renderSystemMessage('可用命令：\n  /nickname <新昵称> - 修改昵称\n  /color-send <颜色> - 修改发送消息颜色\n  /color-recv <颜色> - 修改接收消息颜色\n  /quit - 退出聊天\n支持的颜色: red, green, yellow, blue, magenta, cyan, white, gray, 或者十六进制颜色(如 #ff0000)');
       } else if (command === '/nickname') {
         const newNickname = parts.slice(1).join(' ').trim();
         if (newNickname) {
@@ -38,6 +38,20 @@ async function main() {
         } else {
           renderSystemMessage('用法: /nickname <新昵称>');
         }
+      } else if (command === '/color-send') {
+        const color = parts[1];
+        if (color && setSendColor(color)) {
+          renderSystemMessage(`发送消息颜色已修改为 ${color}`);
+        } else {
+          renderSystemMessage('用法: /color-send <颜色> (如: green, red, cyan, 或十六进制如 #ff0000)');
+        }
+      } else if (command === '/color-recv') {
+        const color = parts[1];
+        if (color && setRecvColor(color)) {
+          renderSystemMessage(`接收消息颜色已修改为 ${color}`);
+        } else {
+          renderSystemMessage('用法: /color-recv <颜色> (如: green, red, cyan, 或十六进制如 #ff0000)');
+        }
       } else if (command === '/quit') {
         renderSystemMessage('正在退出聊天...');
         process.exit(0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xx-chat",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A simple LAN CLI chat tool",
   "main": "index.js",
   "type": "module",

package/src/ui.js

@@ -2,9 +2,32 @@ import readline from 'readline';
 import chalk from 'chalk';
 
 let rl;
+let sendColor = 'green';
+let recvColor = 'cyan';
+const validColors = ['red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'gray'];
+
+function isValidHexColor(color) {
+  return /^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$/i.test(color);
+}
+
+export function setSendColor(color) {
+  if (validColors.includes(color) || isValidHexColor(color)) {
+    sendColor = color;
+    return true;
+  }
+  return false;
+}
+
+export function setRecvColor(color) {
+  if (validColors.includes(color) || isValidHexColor(color)) {
+    recvColor = color;
+    return true;
+  }
+  return false;
+}
 
 function completer(line) {
-  const completions = ['/nickname', '/quit', '/help'];
+  const completions = ['/nickname', '/quit', '/help', '/color-send', '/color-recv'];
   const hits = completions.filter((c) => c.startsWith(line));
   return [hits.length ? hits : line.startsWith('/') ? completions : [], line];
 }
@@ -27,11 +50,15 @@ export function initUI(onMessage) {
   rl.prompt();
 
   rl.on('line', (line) => {
+    // 擦除用户按下回车后留在屏幕上的原始输入内容
+    process.stdout.write('\x1B[1A\x1B[2K\x1B[0G');
+
     const text = line.trim();
     if (text) {
       onMessage(text);
+    } else {
+      rl.prompt();
     }
-    rl.prompt();
   });
 }
 
@@ -49,10 +76,13 @@ export function renderSystemMessage(msg) {
 
 export function renderChatMessage(nickname, message, isSelf = false) {
   clearLine();
+  const time = new Date().toLocaleTimeString();
   if (isSelf) {
-    console.log(chalk.green(`[我(${nickname})] ${message}`));
+    const colorFn = isValidHexColor(sendColor) ? chalk.hex(sendColor) : (chalk[sendColor] || chalk.green);
+    console.log(colorFn(`[我(${nickname})] ${message} `) + chalk.gray(`[${time}]`));
   } else {
-    console.log(chalk.blue(`[${nickname}] ${message}`));
+    const colorFn = isValidHexColor(recvColor) ? chalk.hex(recvColor) : (chalk[recvColor] || chalk.cyan);
+    console.log(colorFn(`[${nickname}] ${message} `) + chalk.gray(`[${time}]`));
   }
   if (rl) rl.prompt(true);
 }

package/{test-xx-chat.js → test-erase-input.js}

@@ -1,10 +1,16 @@
 import { exec } from 'child_process';
-const child = exec('xx-chat --role server --nickname Host');
+const child = exec('xx-chat');
 child.stdout.on('data', d => console.log('OUT:', JSON.stringify(d)));
 child.stderr.on('data', d => console.log('ERR:', JSON.stringify(d)));
 setTimeout(() => {
-  child.stdin.write('hello\r');
+  child.stdin.write('\r'); // Select server
+}, 500);
+setTimeout(() => {
+  child.stdin.write('Host\r'); // Type nickname
 }, 1000);
 setTimeout(() => {
-  child.kill();
+  child.stdin.write('hello test erase\r'); // Chat message
 }, 2000);
+setTimeout(() => {
+  child.kill();
+}, 3000);

package/{test-xx-chat-interactive.js → test-manual.js}

@@ -9,7 +9,7 @@ setTimeout(() => {
   child.stdin.write('Host\r'); // Type nickname
 }, 1000);
 setTimeout(() => {
-  child.stdin.write('hello\r'); // Chat message
+  child.stdin.write('hello world\r'); // Chat message
 }, 2000);
 setTimeout(() => {
   child.kill();

package/test-send.js

@@ -0,0 +1,16 @@
+import { exec } from 'child_process';
+const child = exec('node index.js');
+child.stdout.on('data', d => console.log('OUT:', JSON.stringify(d)));
+child.stderr.on('data', d => console.log('ERR:', JSON.stringify(d)));
+setTimeout(() => {
+  child.stdin.write('\r'); // Select server
+}, 500);
+setTimeout(() => {
+  child.stdin.write('Host\r'); // Type nickname
+}, 1000);
+setTimeout(() => {
+  child.stdin.write('hello world\r'); // Chat message
+}, 2000);
+setTimeout(() => {
+  child.kill();
+}, 3000);

package/test-up-run.js

@@ -0,0 +1,9 @@
+import { exec } from 'child_process';
+const child = exec('node test-up.js');
+child.stdout.on('data', d => console.log('OUT:', JSON.stringify(d)));
+setTimeout(() => {
+  child.stdin.write('hello\r\n');
+}, 500);
+setTimeout(() => {
+  child.kill();
+}, 1000);

package/test-up.js

@@ -0,0 +1,13 @@
+import readline from 'readline';
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+  prompt: '> '
+});
+rl.prompt();
+rl.on('line', (line) => {
+  // Move up one line and clear it
+  process.stdout.write('\x1B[1A\x1B[2K\x1B[0G');
+  console.log(`[ME] ${line}`);
+  rl.prompt();
+});

package/test-inquirer.js

@@ -1,17 +0,0 @@
-import inquirer from 'inquirer';
-import readline from 'readline';
-
-async function run() {
-  await inquirer.prompt([{ type: 'input', name: 'test', message: 'test' }]);
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-    prompt: '> '
-  });
-  rl.prompt();
-  rl.on('line', (line) => {
-    console.log('You entered:', line);
-    rl.prompt();
-  });
-}
-run();

package/test-search.js

@@ -1 +0,0 @@
-console.log("Searching for similar issues");