agent-publish-server 1.0.22 → 1.0.23

package/README.md

@@ -1,166 +1,22 @@
-# agent-publish-server
+# Agent Publish Server
 
-[English](#english) | [中文](#chinese)
+[![npm version](https://badge.fury.io/js/agent-publish-server.svg)](https://badge.fury.io/js/agent-publish-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
----
+基于 Node.js + Express + http-proxy-middleware 的前端服务启动插件，提供强大的代理和静态文件服务能力。
 
-## <a id="english"></a>English
+[English](./README_EN.md) | 中文
 
-> A frontend service startup plugin based on nodejs+express+http-proxy-middleware with proxy support
+## 功能特性
 
-### Features
-
-- 🚀 **Quick Start**: One-command startup for development server
-- 🔄 **Proxy Support**: Built-in proxy middleware for API forwarding
-- 📁 **Static File Serving**: Serve static files from any directory
-- ⚙️ **Interactive Configuration**: Easy setup with interactive CLI
-- 📝 **Access Logging**: Optional request logging with timestamps
-- 🛡️ **Path Validation**: Automatic project path validation
-- 🎯 **SPA Support**: Single Page Application routing support
-
-### Installation
-
-```bash
-npm install agent-publish-server -g
-```
-
-### Quick Start
-
-#### Method 1: Interactive Configuration (Recommended)
-
-```bash
-agent-publish-server -wp
-```
-
-This will guide you through an interactive setup:
-
-1. Enter port number
-2. Enter project directory (after build)
-3. Enter proxy configuration (format: `/api:http://localhost:3000`)
-4. Choose to continue adding proxies (1: continue, 0: finish)
-5. Generate `agent_config.json` and get startup command
-
-#### Method 2: Manual Configuration
-
-1. **Initialize configuration file:**
-
-```bash
-agent-publish-server init
-```
-
-2. **Edit the generated `agent_config.json`:**
-
-```json
-{
-  "port": 8080,
-  "dir": "./",
-  "log": true,
-  "proxy": {
-    "/api": {
-      "target": "http://localhost:3000",
-      "changeOrigin": true,
-      "pathRewrite": {
-        "^/api": ""
-      }
-    }
-  },
-  "staticProxy": {
-    "/sub_page": {
-      "target": "http://localhost:3000",
-      "changeOrigin": true
-    }
-  }
-}
-```
-
-3. **Start the server:**
-
-```bash
-agent-publish-server -c ./agent_config.json
-```
-
-### Command Line Options
-
-| Option                | Description                     | Example                                 |
-| --------------------- | ------------------------------- | --------------------------------------- |
-| `-wp, --write-proxy`  | Interactive proxy configuration | `agent-publish-server -wp`              |
-| `-c, --config <path>` | Specify configuration file path | `agent-publish-server -c ./config.json` |
-| `-p, --port <number>` | Override port number            | `agent-publish-server -p 3000`          |
-| `-d, --dir <path>`    | Override static directory       | `agent-publish-server -d ./dist`        |
-| `--log <boolean>`     | Enable/disable access logging   | `agent-publish-server --log false`      |
-| `-v, --version`       | Show version                    | `agent-publish-server -v`               |
-| `init`                | Initialize configuration file   | `agent-publish-server init`             |
-
-### Configuration Schema
-
-```typescript
-interface AgentConfig {
-  port?: number; // Server port (default: 8080)
-  dir?: string; // Static files directory (default: "./")
-  log?: boolean; // Enable access logging (default: true)
-  proxy?: {
-    // Proxy configurations
-    [path: string]: {
-      target: string; // Target URL
-      changeOrigin?: boolean; // Change origin header
-      pathRewrite?: {
-        // Path rewrite rules
-        [pattern: string]: string;
-      };
-    };
-  };
-}
-```
-
-### Access Logging
-
-Access logging is enabled by default and shows:
-
-- Timestamp (ISO format)
-- Client IP address
-- HTTP method and URL
-- User agent string
-
-Example log output:
-
-```
-[2025-08-27T11:02:48.854Z] ::1 "GET /" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
-```
-
-To disable logging:
-
-```bash
-agent-publish-server --log false
-```
-
-### Error Handling
-
-- **Invalid project path**: Shows "项目路径错误" (Project path error) and exits
-- **Invalid port**: Validates port numbers (1-65535)
-- **Missing configuration**: Falls back to defaults
-
-### Use Cases
-
-- **React/Vue Development**: Serve built applications with API proxying
-- **Frontend Testing**: Quick static file serving with CORS handling
-- **Local Development**: Proxy API calls to backend services
-- **SPA Deployment**: Proper routing support for single-page applications
-
----
-
-## <a id="chinese"></a>中文
-
-> 这是一个基于 nodejs+express+http-proxy-middleware 的一款可支持代理的前端服务启动插件
-
-### 功能特性
-
-- 🚀 **快速启动**: 一键启动开发服务器
-- 🔄 **代理支持**: 内置代理中间件，支持 API 转发
-- 📁 **静态文件服务**: 支持任意目录的静态文件托管
-- ⚙️ **交互式配置**: 通过问答方式轻松配置
-- 📝 **访问日志**: 可选的请求日志记录功能
-- 🛡️ **路径验证**: 自动验证项目路径有效性
-- 🎯 **SPA 支持**: 单页应用路由支持
+- 🚀 **快速启动**：一键启动，支持交互式配置
+- 🔄 **API 代理**：灵活的 API 请求代理，支持跨域处理
+- 📁 **静态代理**：支持静态文件服务和 HTTP 服务代理两种模式
+- 🌐 **双重模式**：静态文件代理和 HTTP 服务代理可同时使用
+- 📝 **访问日志**：实时请求日志记录和监控
+- ⚡ **路径验证**：自动路径存在性检查和验证
+- 🛠️ **CLI 支持**：命令行工具，易于集成到构建流程
+- 📋 **配置文件**：支持 JSON 配置文件，灵活配置各种代理规则
 
 ### 安装
 
@@ -372,9 +228,10 @@ agent-publish-server --log false
 
 ### 版本历史
 
-- **v1.0.22**: 优化和完善staticProxy功能，提升稳定性
-- **v1.0.18**: 增强staticProxy功能，支持静态文件代理和HTTP服务代理两种模式
-- **v1.0.17**: 新增静态网页代理功能（staticProxy），支持与API代理同时使用
+- **v1.0.23**: 完善双语文档支持，优化package.json关键词，提升npm包曝光度
+- **v1.0.22**: 优化和完善 staticProxy 功能，提升稳定性
+- **v1.0.18**: 增强 staticProxy 功能，支持静态文件代理和 HTTP 服务代理两种模式
+- **v1.0.17**: 新增静态网页代理功能（staticProxy），支持与 API 代理同时使用
 - **v1.0.16**: 新增交互式配置、访问日志、路径验证功能
 - **v1.0.15**: 基础代理和静态文件服务功能
 

package/README_EN.md

@@ -0,0 +1,248 @@
+# Agent Publish Server
+
+[![npm version](https://badge.fury.io/js/agent-publish-server.svg)](https://badge.fury.io/js/agent-publish-server)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A frontend service startup plugin based on Node.js + Express + http-proxy-middleware, providing powerful proxy and static file serving capabilities.
+
+English | [中文](./README.md)
+
+## Features
+
+- 🚀 **Quick Start**: One-click startup with interactive configuration
+- 🔄 **API Proxy**: Flexible API request proxying with CORS support
+- 📁 **Static Proxy**: Support for both static file serving and HTTP service proxying
+- 🌐 **Dual Mode**: Static file proxy and HTTP service proxy can be used simultaneously
+- 📝 **Access Logging**: Real-time request logging and monitoring
+- ⚡ **Path Validation**: Automatic path existence checking and validation
+- 🛠️ **CLI Support**: Command-line interface for easy integration
+- 📋 **Configuration Files**: Support for JSON configuration files
+
+## Installation
+
+```bash
+npm install -g agent-publish-server
+```
+
+## Quick Start
+
+### Interactive Mode
+
+```bash
+agent-publish-server
+```
+
+Follow the interactive prompts to configure your server.
+
+### Configuration File Mode
+
+```bash
+agent-publish-server -c config.json
+```
+
+## Configuration
+
+### Basic Configuration Example
+
+```json
+{
+  "port": 3000,
+  "dir": "./dist",
+  "proxy": {
+    "/api": {
+      "target": "http://localhost:8080",
+      "changeOrigin": true,
+      "pathRewrite": {
+        "^/api": ""
+      }
+    }
+  },
+  "staticProxy": {
+    "/assets": {
+      "target": "./static",
+      "type": "static"
+    },
+    "/app": {
+      "target": "http://localhost:4000",
+      "type": "http",
+      "changeOrigin": true
+    }
+  }
+}
+```
+
+### Configuration Options
+
+#### Server Configuration
+
+- **port**: Server port (default: 3000)
+- **dir**: Static file directory (default: current directory)
+- **proxy**: API proxy configuration
+- **staticProxy**: Static proxy configuration
+
+#### API Proxy Configuration (ProxyConfig)
+
+```typescript
+interface ProxyConfig {
+  target: string; // Target server URL
+  changeOrigin?: boolean; // Change origin header
+  pathRewrite?: Record<string, string>; // Path rewriting rules
+}
+```
+
+#### Static Proxy Configuration (StaticProxyConfig)
+
+```typescript
+interface StaticProxyConfig {
+  target: string; // Target URL or local file path
+  type?: "http" | "static"; // Proxy type: http service or static files
+  changeOrigin?: boolean; // Change origin header (only effective for http type)
+}
+```
+
+## Static Proxy
+
+The static proxy feature supports two modes:
+
+### 1. Static File Proxy
+
+Proxy requests to local file system directories:
+
+```json
+{
+  "staticProxy": {
+    "/assets": {
+      "target": "./dist",
+      "type": "static"
+    }
+  }
+}
+```
+
+**Access**: `http://localhost:3000/assets/index.html` → `./dist/index.html`
+
+### 2. HTTP Service Proxy
+
+Proxy requests to remote HTTP services:
+
+```json
+{
+  "staticProxy": {
+    "/app": {
+      "target": "http://localhost:4000",
+      "type": "http",
+      "changeOrigin": true
+    }
+  }
+}
+```
+
+**Access**: `http://localhost:3000/app/page` → `http://localhost:4000/page`
+
+### Features
+
+- **Dual Proxy Mode**: Static file proxy + HTTP service proxy
+- **Path Validation**: Automatic checking of static file path existence
+- **Automatic Path Rewriting**: Smart path processing and forwarding
+- **Priority Handling**: Static proxy takes precedence over default static file serving
+- **Backward Compatibility**: Fully compatible with previous versions
+
+## Combined Usage with API Proxy
+
+```json
+{
+  "port": 3000,
+  "dir": "./public",
+  "proxy": {
+    "/api": {
+      "target": "http://localhost:8080",
+      "changeOrigin": true,
+      "pathRewrite": {
+        "^/api": ""
+      }
+    }
+  },
+  "staticProxy": {
+    "/admin": {
+      "target": "./admin-dist",
+      "type": "static"
+    },
+    "/mobile": {
+      "target": "http://localhost:4000",
+      "type": "http",
+      "changeOrigin": true
+    }
+  }
+}
+```
+
+**Access Examples**:
+
+- API requests: `http://localhost:3000/api/users` → `http://localhost:8080/users`
+- Admin panel: `http://localhost:3000/admin/index.html` → `./admin-dist/index.html`
+- Mobile app: `http://localhost:3000/mobile/page` → `http://localhost:4000/page`
+- Default static: `http://localhost:3000/index.html` → `./public/index.html`
+
+## Use Cases
+
+- **Single Page Applications**: Serve SPA with API proxy configuration
+- **Micro-frontend Architecture**: Integrate multiple frontend applications through static proxy
+- **Development Environment Integration**: Unify access to multiple local services through one port
+- **Static Resource Management**: Flexible static file serving and routing
+- **Cross-origin Request Handling**: Solve CORS issues in development
+- **Multi-service Integration**: Combine different backend services and frontend applications
+
+## Command Line Options
+
+```bash
+agent-publish-server [options]
+
+Options:
+  -c, --config <file>    Configuration file path
+  -p, --port <port>      Server port
+  -d, --dir <directory>  Static file directory
+  -h, --help            Display help information
+  -V, --version         Display version number
+```
+
+## API
+
+### Programmatic Usage
+
+```javascript
+const { createServer, startServer } = require("agent-publish-server");
+
+const config = {
+  port: 3000,
+  dir: "./dist",
+  proxy: {
+    "/api": {
+      target: "http://localhost:8080",
+      changeOrigin: true,
+    },
+  },
+};
+
+const app = createServer(config);
+startServer(app, config.port);
+```
+
+## Version History
+
+- **v1.0.22**: Optimized and improved staticProxy functionality, enhanced stability
+- **v1.0.18**: Enhanced staticProxy functionality, supporting both static file proxy and HTTP service proxy modes
+- **v1.0.17**: Added static web proxy functionality (staticProxy), supports simultaneous use with API proxy
+- **v1.0.16**: Added interactive configuration, access logging, and path validation features
+- **v1.0.15**: Basic proxy and static file serving functionality
+
+## License
+
+MIT © [qghs](https://github.com/qg-hs)
+
+## Contributing
+
+Welcome to submit Issues and Pull Requests!
+
+## Support
+
+If you encounter any problems during use, please submit an Issue on [GitHub](https://github.com/qg-hs/agent-publish-server/issues).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "agent-publish-server",
-  "version": "1.0.22",
-  "description": "基于 nodejs+express+http-proxy-middleware 的前端服务启动插件",
+  "version": "1.0.23",
+  "description": "A powerful frontend development server with API proxy, static file serving, and dual-mode static proxy support. Built with Node.js + Express + http-proxy-middleware. 基于 Node.js + Express + http-proxy-middleware 的强大前端开发服务器，支持API代理、静态文件服务和双模式静态代理。",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -17,7 +17,28 @@
     "express",
     "proxy",
     "server",
-    "development"
+    "development",
+    "http-proxy-middleware",
+    "static-server",
+    "dev-server",
+    "frontend",
+    "nodejs",
+    "cli",
+    "web-server",
+    "local-server",
+    "api-proxy",
+    "static-proxy",
+    "cors",
+    "middleware",
+    "reverse-proxy",
+    "micro-frontend",
+    "spa",
+    "build-tool",
+    "webpack-dev-server",
+    "vite",
+    "react",
+    "vue",
+    "angular"
   ],
   "author": {
     "name": "qghs",