@gylautorun/dev-proxy-cookie 1.0.1 → 1.0.3

package/README.md

@@ -1,15 +1,15 @@
 # dev-proxy-cookie
 
-开发环境代理 Cookie 注入工具，支持文件监听自动重载和自动代理。
+开发环境代理 Cookie 注入工具，支持文件监听自动重载和自动代理。兼容 Vue CLI 和所有版本的 Vite。
 
 ## 功能特性
 
 - 🚀 **Vue CLI 兼容**：提供 `createVueProxyConfig`，完美兼容 vue.config.js 的代理配置方式
-- ⚡ **Vite 插件支持**：开箱即用的 Vite 插件，支持自动代理所有请求
+- ⚡ **Vite 插件支持**：开箱即用的 Vite 中间件插件，兼容所有 Vite 版本（2.x/3.x/4.x/5.x）
 - 📁 **Cookie 文件监听**：监听 Cookie 文件变化，实时更新请求，无需重启服务器
 - 🎯 **自动代理**：可选的自动代理所有请求功能，无需手动配置每个路径
 - 🔄 **双向模式**：支持白名单模式（`includePaths`）和黑名单模式（`ignorePaths`）
-- 🔌 **钩子函数**：支持 `onProxyReq`、`onProxyRes`、`onError`、`onWsError` 等钩子
+- 🔌 **钩子函数**：支持 `onProxyReq`、`onProxyRes`、`onError` 等钩子
 - ⚙️ **代理配置**：支持 `ws`、`changeOrigin`、`secure`、`followRedirects` 等完整代理选项
 - 🛠️ **工具类**：提供 `CookieReader` 和 `CookieWatcher` 基础工具类
 
@@ -69,13 +69,13 @@ module.exports = {
       ws: true,
       changeOrigin: true,
       secure: false,
-  
+
       // 白名单模式 - 只代理这些路径
       // includePaths: ['/api/', '/cas/', '/examine/'],
-  
+
       // 黑名单模式 - 忽略这些路径
       ignorePaths: ['/assets/', '/img/', '/public/', '/favicon.ico'],
-  
+
       // 额外的代理配置（优先级最高）
       additionalProxies: {
         '/mock/': {
@@ -83,13 +83,13 @@ module.exports = {
           changeOrigin: true,
         },
       },
-  
+
       // 自定义请求头
       headers: {
         host: '10.17.33.33',
         origin: 'http://10.17.33.33',
       },
-  
+
       // 钩子函数
       hooks: {
         onProxyReq: (proxyReq, req, res) => {
@@ -107,39 +107,48 @@ module.exports = {
 };
 ```
 
-### Vite 项目 (vite.config.js) - 自动代理
+### Vite 项目 (vite.config.js) - 自动代理（推荐）
+
+使用 `viteMiddlewareProxy` 插件，兼容所有 Vite 版本：
 
 ```javascript
 import { defineConfig } from 'vite';
-import { viteAutoProxyCookie } from 'dev-proxy-cookie';
+import { viteMiddlewareProxy } from 'dev-proxy-cookie';
 
 export default defineConfig({
   plugins: [
-    viteAutoProxyCookie({
+    viteMiddlewareProxy({
       // 必需配置
       cookieFile: './cookie.txt',
       target: 'http://10.17.33.33',
-  
+
       // 调试模式
       debug: true,
-  
-      // Cookie变化时自动重启开发服务器（需要外部脚本配合）
-      autoRestart: true,
-  
+
       // WebSocket 支持
       ws: true,
       changeOrigin: true,
       secure: false,
       followRedirects: true,
-  
-      // 自定义代理映射
+
+      // 自定义代理映射（优先级最高）
       proxyMap: {
-        '/mock/': 'http://localhost:3000',
+        '/digital-platform': 'http://223.4.72.251:8816/',
+        '/robot': 'https://oapi.dingtalk.com/',
+        '/irs-assessments/api/zbdf': 'http://10.249.160.193:8003',
       },
-  
-      // 忽略的路径
-      ignorePaths: ['/assets/', '/img/', '/public/'],
-  
+
+      // 默认代理路径（代理到 target）
+      proxyPaths: [
+        '/irs-assessments/api',
+        '/irs-file/api',
+        '/irs-admin/api',
+        '/api',
+      ],
+
+      // 忽略的路径（不代理）
+      ignorePaths: ['/assets/', '/img/', '/public/', '/src/'],
+
       // 钩子函数
       hooks: {
         onProxyReq: (proxyReq, req, res) => {
@@ -151,29 +160,28 @@ export default defineConfig({
         onError: (err, req, res) => {
           console.error('[Proxy] Error:', err.message);
         },
-        onWsError: (err, req, socket) => {
-          console.error('[Proxy] WebSocket Error:', err.message);
-        },
       },
     }),
   ],
 });
 ```
 
-### Vite 项目 (vite.config.js) - 基础 Cookie 注入
+### 使用账号密码登录（禁用 Cookie 注入）
+
+当需要使用账号密码登录时，设置 `useCookie: false`，避免覆盖浏览器的登录 Cookie：
 
 ```javascript
 import { defineConfig } from 'vite';
-import { viteDevProxyCookie } from 'dev-proxy-cookie';
+import { viteMiddlewareProxy } from 'dev-proxy-cookie';
 
 export default defineConfig({
   plugins: [
-    viteDevProxyCookie({
+    viteMiddlewareProxy({
       cookieFile: './cookie.txt',
+      target: 'http://10.17.33.33',
+      useCookie: false,  // 禁用 Cookie 注入，使用浏览器发送的 Cookie
       debug: true,
-      onCookieChange: (cookie) => {
-        console.log('Cookie updated:', cookie);
-      },
+      proxyPaths: ['/api'],
     }),
   ],
 });
@@ -267,47 +275,31 @@ isDev (最高) → watch (中等) → 智能检测 (最低)
 
 ### Vite 相关
 
-#### viteAutoProxyCookie(options)
-
-Vite 插件，自动配置代理和 Cookie 注入。
-
-**选项：**
-
-- `cookieFile` (string): Cookie 文件路径（必需）
-- `target` (string): 默认代理目标（必需）
-- `debug` (boolean): 是否开启调试日志，默认 `false`
-- `autoRestart` (boolean): 是否启用自动重启标记，默认 `true`
-- `restartMarkerFile` (string): 重启标记文件路径，默认 `.cookie-restart-marker`
-- `ws` (boolean): WebSocket 支持，默认 `true`
-- `changeOrigin` (boolean): 是否改变请求来源，默认 `true`
-- `secure` (boolean): 是否验证 SSL 证书，默认 `false`
-- `followRedirects` (boolean): 是否跟随重定向，默认 `true`
-- `proxyMap` (object): 特定路径映射
-- `includePaths` (string[]): 只代理这些路径
-- `ignorePaths` (array): 忽略的路径
-- `hooks` (object): 钩子函数配置
-- `isDev` (boolean): 是否为开发环境（优先级最高）
-  - 设置此参数后，将直接决定是否启用文件监听
-  - `true`: 启用监听（开发模式）
-  - `false`: 禁用监听（生产模式）
-
-#### viteDevProxyCookie(options)
+#### viteMiddlewareProxy(options)
 
-Vite 插件，基础 Cookie 注入功能。
+Vite 中间件插件，自动配置代理和 Cookie 注入，兼容所有 Vite 版本。
 
 **选项：**
 
-- `cookieFile` (string): Cookie 文件路径（必需）
-- `debug` (boolean): 是否开启调试日志，默认 `false`
-- `onCookieChange` ((cookie: string) => void): Cookie 变化回调
-- `watch` (boolean | 'auto'): 是否监听文件变化，默认 `'auto'`
-  - `true`: 始终监听
-  - `false`: 从不监听
-  - `'auto'`: 根据环境自动判断（默认）
-- `isDev` (boolean): 是否为开发环境（优先级最高）
-  - 设置此参数后，将直接决定是否启用文件监听
-  - `true`: 启用监听（开发模式）
-  - `false`: 禁用监听（生产模式）
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `cookieFile` | string | - | Cookie 文件路径（必需） |
+| `target` | string | - | 默认代理目标（必需） |
+| `debug` | boolean | false | 是否开启调试日志 |
+| `ws` | boolean | true | WebSocket 支持 |
+| `changeOrigin` | boolean | true | 是否改变请求来源 |
+| `secure` | boolean | false | 是否验证 SSL 证书 |
+| `followRedirects` | boolean | true | 是否跟随重定向 |
+| `proxyMap` | object | {} | 特定路径映射（优先级最高） |
+| `proxyPaths` | string[] | [] | 默认代理路径列表 |
+| `ignorePaths` | string[] | [] | 忽略的路径 |
+| `hooks` | object | {} | 钩子函数配置 |
+
+**路径匹配优先级：**
+
+1. `proxyMap` - 自定义路径映射（最高优先级）
+2. `proxyPaths` - 默认代理路径
+3. `ignorePaths` - 忽略路径（不代理）
 
 ### 工具类
 
@@ -384,12 +376,6 @@ hooks: {
     res.writeHead(503, { 'Content-Type': 'text/plain' });
     res.end('Proxy error');
   },
-  
-  // WebSocket 错误时触发
-  onWsError: (err, req, socket) => {
-    console.error('[Proxy] WebSocket Error:', err.message);
-    socket.close();
-  },
 }
 ```
 
@@ -433,61 +419,150 @@ dos-session-id=YWQxMWUwMTktZjI4Yi00NzNmLTkzOTItMWFmMzBiZTYzZTBm
 ## 项目结构
 
 ```
-src/
-├── proxy/              # 代理模块
-│   ├── core.ts         # 代理核心逻辑
-│   ├── vite-plugin.ts  # Vite自动代理插件
-│   ├── vite-cookie-plugin.ts  # Vite Cookie插件
-│   └── webpack-plugin.ts      # Webpack代理配置
-├── utils/              # 工具模块
-│   ├── cookie-reader.ts   # Cookie读取器（支持注释过滤）
-│   └── cookie-watcher.ts  # Cookie文件监听
-└── index.ts            # 主导出
+dev-proxy-cookie/
+├── src/
+│   ├── proxy/
+│   │   ├── core.ts              # 代理核心逻辑
+│   │   ├── vite-middleware-plugin.ts  # Vite 中间件插件（兼容所有版本）
+│   │   ├── vue-proxy-config.ts  # Vue CLI 代理配置
+│   │   └── index.ts             # 代理模块导出
+│   ├── utils/
+│   │   ├── cookie-reader.ts     # Cookie 文件读取器
+│   │   ├── cookie-watcher.ts    # Cookie 文件监听器
+│   │   ├── env-detector.ts      # 环境检测工具
+│   │   └── index.ts             # 工具模块导出
+│   └── index.ts                 # 主导出
+├── scripts/                     # 脚本工具
+│   ├── publish.sh               # 自动化发布脚本（含版本升级）
+│   ├── publish-check.sh         # 检查构建发布脚本（不修改版本）
+│   └── bump-version.js          # 版本升级工具
+├── demo/                        # 示例项目
+│   └── vite-demo/               # Vite 示例
+├── docs/                        # 文档
+├── __tests__/                   # 测试用例
+└── package.json
+```
+
+## 脚本工具
+
+### scripts/publish.sh
+
+**功能**：自动化发布脚本，包含版本升级功能
+
+**特点**：
+- 完整的前置检查（npm 登录、git 分支、依赖、测试、构建）
+- 支持多种版本升级类型（patch/minor/major/beta/alpha/自定义）
+- 支持测试环境和正式环境发布
+- 自动创建 git tag
+
+**使用方式**：
+
+```bash
+# 直接运行，按提示操作
+bash scripts/publish.sh
+
+# 流程：
+# 1. 检查命令 → 检查 npm 登录 → 检查 git 分支 → 检查 git 状态
+# 2. 检查依赖 → 运行类型检查 → 运行测试
+# 3. 选择版本升级类型 → 执行构建 → 确认发布
+# 4. 可选：先发布到测试环境 → 发布到正式环境
+```
+
+**版本升级选项**：
+
+| 选项 | 说明 | 示例 |
+|------|------|------|
+| 1) patch | 修复 bug | 1.0.1 → 1.0.2 |
+| 2) minor | 添加新功能 | 1.0.1 → 1.1.0 |
+| 3) major | 重大变更/不兼容 | 1.0.1 → 2.0.0 |
+| 4) beta | Beta 测试版 | 1.0.1 → 1.0.2-beta.1 |
+| 5) alpha | Alpha 测试版 | 1.0.1 → 1.0.2-alpha.1 |
+| 6) 自定义 | 手动指定版本号 | 任意格式 |
+
+### scripts/publish-check.sh
+
+**功能**：检查构建发布脚本，**不修改版本号**
+
+**适用场景**：
+- 重新发布已有版本
+- 测试环境验证
+- CI/CD 自动化流程
+
+**使用方式**：
+
+```bash
+# 默认发布到 latest 标签
+bash scripts/publish-check.sh
+
+# 指定发布标签
+bash scripts/publish-check.sh beta
+bash scripts/publish-check.sh test
+```
+
+**流程**：
+
+```
+检查命令 → 检查 npm 登录 → 检查 git 分支 → 检查 git 状态
+    → 检查依赖 → 运行类型检查 → 运行测试 → 执行构建 → 确认发布
+```
+
+### scripts/bump-version.js
+
+**功能**：独立的版本升级工具
+
+**使用方式**：
+
+```bash
+# 使用 npm 脚本
+npm run bump:patch    # 升级 patch 版本
+npm run bump:minor    # 升级 minor 版本
+npm run bump:major    # 升级 major 版本
+npm run bump:beta     # 升级 beta 版本
+npm run bump:alpha    # 升级 alpha 版本
 ```
 
 ## 配置选项汇总
 
 ### 代理服务器配置
 
-| 选项                    | 类型                  | 默认值 | 说明                   |
-| ----------------------- | --------------------- | ------ | ---------------------- |
-| `ws`                  | boolean               | false  | WebSocket 支持         |
-| `changeOrigin`        | boolean               | true   | 是否改变请求来源       |
-| `secure`              | boolean               | false  | 是否验证 SSL 证书      |
-| `followRedirects`     | boolean               | true   | 是否跟随重定向         |
-| `autoRewrite`         | boolean               | false  | 自动重写路径           |
-| `protocolRewrite`     | string                | -      | 协议重写（http/https） |
-| `cookieDomainRewrite` | boolean/string/object | -      | Cookie 域名重写        |
-| `cookiePathRewrite`   | boolean/string/object | -      | Cookie 路径重写        |
-| `headers`             | object                | -      | 自定义请求头           |
-| `logLevel`            | string                | 'info' | 日志级别               |
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `ws` | boolean | false | WebSocket 支持 |
+| `changeOrigin` | boolean | true | 是否改变请求来源 |
+| `secure` | boolean | false | 是否验证 SSL 证书 |
+| `followRedirects` | boolean | true | 是否跟随重定向 |
+| `autoRewrite` | boolean | false | 自动重写路径 |
+| `protocolRewrite` | string | - | 协议重写（http/https） |
+| `cookieDomainRewrite` | boolean/string/object | - | Cookie 域名重写 |
+| `cookiePathRewrite` | boolean/string/object | - | Cookie 路径重写 |
+| `headers` | object | - | 自定义请求头 |
+| `logLevel` | string | 'info' | 日志级别 |
 
 ### 路径过滤配置
 
-| 选项                                 | 类型     | 说明                       |
-| ------------------------------------ | -------- | -------------------------- |
-| `includePaths`                     | string[] | 白名单模式，只代理这些路径 |
-| `ignorePaths`                      | string[] | 黑名单模式，忽略这些路径   |
-| `proxyMap` / `additionalProxies` | object   | 额外代理配置，优先级最高   |
+| 选项 | 类型 | 说明 |
+|------|------|------|
+| `includePaths` | string[] | 白名单模式，只代理这些路径 |
+| `ignorePaths` | string[] | 黑名单模式，忽略这些路径 |
+| `proxyMap` / `additionalProxies` | object | 额外代理配置，优先级最高 |
 
 ### Cookie 配置
 
-| 选项           | 类型     | 默认值 | 说明             |
-| -------------- | -------- | ------ | ---------------- |
-| `cookieFile` | string   | -      | Cookie 文件路径  |
-| `getCookie`  | function | -      | Cookie 获取函数  |
-| `watch`      | boolean  | false  | 是否监听文件变化 |
-| `debug`      | boolean  | false  | 是否输出调试日志 |
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `cookieFile` | string | - | Cookie 文件路径 |
+| `getCookie` | function | - | Cookie 获取函数 |
+| `watch` | boolean | false | 是否监听文件变化 |
+| `debug` | boolean | false | 是否输出调试日志 |
 
 ## 注意事项
 
 1. **Cookie 文件变化**：Cookie 文件变化后，代理会立即使用新的 Cookie，无需重启服务器
 2. **Git 忽略**：建议将 Cookie 文件添加到 `.gitignore`
-3. **Vue CLI vs Vite**：Vue CLI 项目建议使用 `createVueProxyConfig` 或 `createAutoProxyConfig`，Vite 项目建议使用 `viteAutoProxyCookie`
-4. **自动重启**：`autoRestart` 选项会在 Cookie 变化时写入标记文件，需要外部脚本配合检测重启
-5. **路径优先级**：`includePaths` 和 `ignorePaths` 不能同时生效，`includePaths` 优先
-6. **代理映射优先级**：`proxyMap`（Vite）或 `additionalProxies`（Vue CLI）中的路径不受 `includePaths`/`ignorePaths` 限制
-7. **Cookie 格式**：支持单行和多行格式，多行格式支持注释（以 `#` 开头）
+3. **Vue CLI vs Vite**：Vue CLI 项目建议使用 `createVueProxyConfig` 或 `createAutoProxyConfig`，Vite 项目建议使用 `viteMiddlewareProxy`
+4. **路径优先级**：`includePaths` 和 `ignorePaths` 不能同时生效，`includePaths` 优先
+5. **代理映射优先级**：`proxyMap`（Vite）或 `additionalProxies`（Vue CLI）中的路径不受 `includePaths`/`ignorePaths` 限制
+6. **Cookie 格式**：支持单行和多行格式，多行格式支持注释（以 `#` 开头）
 
 ## 最佳实践
 
@@ -501,7 +576,6 @@ xxx-session-id=def456
 
 // .gitignore - 忽略敏感文件
 cookie.txt
-.cookie-restart-marker
 
 // vue.config.js - Vue CLI 项目配置
 const { createAutoProxyConfig, createFileCookieGetter } = require('dev-proxy-cookie');
@@ -520,14 +594,14 @@ module.exports = {
 };
 
 // vite.config.js - Vite 项目配置
-import { viteAutoProxyCookie } from 'dev-proxy-cookie';
+import { viteMiddlewareProxy } from 'dev-proxy-cookie';
 
 export default defineConfig({
   plugins: [
-    viteAutoProxyCookie({
+    viteMiddlewareProxy({
       cookieFile: './cookie.txt',
       target: 'http://localhost:3000',
-      isDev: process.env.NODE_ENV === 'development',  // 显式指定环境
+      proxyPaths: ['/api', '/cas'],
       ignorePaths: ['/assets/', '/public/'],
     }),
   ],
@@ -563,15 +637,6 @@ const getCookie = createFileCookieGetter('./cookie.txt', {
 });
 ```
 
-**自动检测（默认行为）**
-
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  watch: 'auto',  // 默认值，自动判断环境
-  debug: true,
-});
-```
-
 ## 常见问题
 
 ### Q: Cookie 文件修改后没有生效？
@@ -606,20 +671,8 @@ A: 这是由于文件监听器在生产环境下仍然运行导致的。解决
 **方案一：使用 `isDev` 参数（推荐）**
 
 ```javascript
-// Vue CLI 项目
 const getCookie = createFileCookieGetter('./cookie.txt', {
   isDev: process.env.NODE_ENV === 'development',
-  debug: true,
-});
-
-// Vite 项目
-export default defineConfig({
-  plugins: [
-    viteDevProxyCookie({
-      cookieFile: './cookie.txt',
-      isDev: process.env.NODE_ENV === 'development',
-    }),
-  ],
 });
 ```
 
@@ -627,117 +680,40 @@ export default defineConfig({
 
 ```javascript
 const getCookie = createFileCookieGetter('./cookie.txt', {
-  watch: false,  // 禁用文件监听
-});
-```
-
-**方案三：使用智能检测（默认行为）**
-
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  watch: 'auto',  // 默认值，自动判断环境
-});
-```
-
-智能检测会检查以下环境变量：
-
-- `NODE_ENV`、`BUILD_MODE`、`VUE_APP_ENV`、`VITE_NODE_ENV` 等
-- CI/CD 环境标识（`CI`）
-- npm 生命周期事件（如 `build`）
-- 进程参数（如 `--mode=production`）
-
-### Q: 如何在预发布环境（staging/uat）启用文件监听？
-
-A: 预发布环境通常需要调试，建议显式设置 `isDev: true`：
-
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  isDev: true,  // 强制启用监听
-  debug: true,
-});
-```
-
-或者使用 `watch: true`：
-
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  watch: true,  // 始终监听
-  debug: true,
+  watch: false,
 });
 ```
 
-### Q: `isDev`、`watch` 和智能检测的优先级是什么？
-
-A: 优先级从高到低：
-
-```
-isDev (最高) → watch (中等) → 智能检测 (最低)
-```
-
-- 如果设置了 `isDev`，直接使用该值
-- 如果 `isDev` 未设置但 `watch` 为 `true` 或 `false`，使用 `watch` 值
-- 如果都未设置或 `watch` 为 `'auto'`，使用智能检测
-
-### Q: 如何自定义生产环境检测？
-
-A: 使用 `productionEnvs` 参数：
-
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  productionEnvs: ['MY_APP_ENV', 'BUILD_TYPE'],  // 自定义环境变量
-  debug: true,
-});
-```
+## 发布流程
 
-### Q: ESLint 报错 `import/no-extraneous-dependencies`？
+### 使用脚本发布（推荐）
 
-A: 确保在 `.eslintrc.js` 中正确配置：
+```bash
+# 自动化发布（含版本升级）
+bash scripts/publish.sh
 
-```javascript
-module.exports = {
-  // ...
-  rules: {
-    'import/no-extraneous-dependencies': ['error', {
-      devDependencies: true,
-      optionalDependencies: false,
-    }],
-  },
-};
+# 检查构建发布（不修改版本）
+bash scripts/publish-check.sh [tag]
 ```
 
-### Q: 如何查看当前环境检测的详细信息？
+### 手动发布流程
 
-A: 启用 `debug: true` 选项：
+```bash
+# 1. 检查依赖和测试
+npm install
+npm run lint
+npm test
 
-```javascript
-const getCookie = createFileCookieGetter('./cookie.txt', {
-  watch: 'auto',
-  debug: true,  // 输出环境检测日志
-});
-```
+# 2. 升级版本
+npm version patch   # 或 minor/major
 
-控制台会输出类似信息：
+# 3. 构建
+npm run build
 
+# 4. 发布
+npm publish
 ```
-[env-detector] Auto-detected production mode - disabling watch
-```
-
-或
-
-```
-[env-detector] Auto-detected development mode - enabling watch
-```
-
-## 发布流程
-
-完整的发布流程文档请查看：[docs/release.md](docs/release.md)
-
-## 问题排查
-
-### 构建进程不退出问题
-
-如果遇到构建完成后进程不退出的问题，请查看详细解决方案：[docs/build-hang-issue.md](docs/build-hang-issue.md)
 
 ## License
 
-MIT License
+MIT License