env-plugin 0.5.6

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "env-plugin",
+  "version": "0.5.6",
+  "type": "module",
+  "description": "A dev env plugin that integrates an Express server with request proxying capabilities.",
+  "keywords": [
+    "proxy",
+    "devServer",
+    "Development environment management",
+    "webpack-plugin",
+    "rollup-plugin",
+    "vite-plugin"
+  ],
+  "bin": {
+    "envm": "bin/index.js"
+  },
+  "main": "./dist/Plugin.js",
+  "exports": {
+    ".": {
+      "import": "./dist/Plugin.js"
+    }
+  },
+  "author": "lcn",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^13.1.0",
+    "cookie": "^1.0.2",
+    "dotenv": "^17.1.0",
+    "express": "^4.21.2",
+    "express-static-gzip": "^2.2.0",
+    "http-proxy-middleware": "^3.0.3",
+    "lokijs": "^1.5.12",
+    "minimatch": "^10.2.4",
+    "pino": "^9.9.0",
+    "pino-pretty": "^13.1.1",
+    "portfinder": "^1.0.35",
+    "set-cookie-parser": "^2.7.1",
+    "tslib": "^2.8.1",
+    "unplugin": "^2.2.0",
+    "uuid": "^10.0.0",
+    "ws": "^8.18.3",
+    "zod": "^4.0.16"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.23",
+    "@types/lokijs": "^1.5.14",
+    "@types/set-cookie-parser": "^2.4.10",
+    "@types/uuid": "^10.0.0",
+    "@types/ws": "^8.18.0",
+    "globals": "^17.3.0",
+    "nodemon": "^3.1.9",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.2"
+  },
+  "bugs": {
+    "url": "https://github.com/lumos934/env-plugin/issues"
+  },
+  "homepage": "https://github.com/lumos934/env-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lumos934/env-plugin.git"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "bin/index.js",
+    "dist",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development tsx watch --tsconfig tsconfig.dev.json -- ./bin/index.ts",
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint ./src"
+  }
+}

package/readme.md

@@ -0,0 +1,214 @@
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+![npm](https://img.shields.io/npm/dw/env-plugin.svg)
+
+# EnvManage - 环境管理工具
+
+`EnvManage` 是一款强大的环境管理工具，专为管理和代理多个开发环境而设计，特别适用于需要同时运行多个开发环境的场景。无论是小型项目还是大型企业级应用，`EnvManage` 都能极大地提升开发效率，简化环境管理流程。
+
+```mermaid
+graph LR
+    A[前置转发服务1<br>端口 3000] --> B[开发服务器（webpack等）<br>端口 8080]
+    C[前置转发服务2<br>端口 3001] --> B
+    B --> D[后置转发服务<br>端口 3099]
+    D --> E[API 服务器1]
+    D --> F[API 服务器2]
+```
+
+## 🌟 功能特性
+
+- **请求代理**
+
+  通过前置和后置代理，确保请求准确无误地转发到指定的开发服务器。代理服务器会依据配置的目标服务器地址，将请求精准转发到对应的 API 服务器，保障数据交互顺畅。
+
+- **多服务器管理**
+
+  轻松实现同时启动和管理多个开发服务器，并通过管理页面查看代理服务运行状态，同时可灵活启动或停止某个环境对应的服务器。
+
+## 🚀 快速上手
+
+### 安装
+
+```bash
+npm i -D env-plugin
+```
+
+或者全局安装
+
+```bash
+npm i -g env-plugin
+```
+
+### 启动
+
+运行以下命令启动：
+
+```bash
+npx envm
+```
+
+访问管理页面 [http://localhost:3099/](http://localhost:3099/) 对各个代理服务进行管理。
+
+1.  添加 `Dev Server`；
+2.  添加 `API Server`;
+3.  启动代理服务
+
+### 开发服务器配置
+
+调整开发服务器，将需要代理到 API 服务器的请求，转发到 后置代理服务器。
+
+**webpack-dev-server**
+
+```js
+// webpack.config.js
+
+module.exports = {
+  devServer: {
+    proxy: {
+      "/api/test": "http://localhost:3099",
+    },
+  },
+};
+```
+
+**vite**
+
+```js
+// vite.config.js
+import { defineConfig } from "vite";
+
+// https://vite.dev/config/
+export default defineConfig({
+  server: {
+    proxy: {
+      "/api/test": {
+        target: "http://localhost:3099",
+        changeOrigin: true,
+      },
+    },
+  },
+});
+```
+
+### 配置
+
+#### 支持的配置项
+
+| 配置项       | 类型   | 描述                                                             | 默认值          |
+| ------------ | ------ | ---------------------------------------------------------------- | --------------- |
+| port         | number | 服务启动端口                                                     | 3099            |
+| apiPrefix    | string | 管理页面 API 接口前缀（如果与 API URL 冲突可调整，一般无需调整） | /dev-manage-api |
+| cookieSuffix | string | Cookie 名称后缀                                                  | envm            |
+| logLevel     | string | 日志级别（debug/info/warn/error）                                | info            |
+
+#### 配置方式（按优先级从高到低）
+
+1. 动态传入参数
+
+在初始化时通过代码传入，优先级最高：
+
+> 可以通过 npx envm -h 查看参数详情
+
+```cmd
+npx envm -p 3000
+```
+
+2. 环境变量
+
+在 `.env` 文件中配置，优先级次之：
+
+> 为了防止与其它应用配置冲突，增加了 envm\_ 前缀
+
+```env
+// .env
+# 示例：设置端口
+envm_port=3000
+envm_apiPrefix=/api
+envm_cookieSuffix=envm
+envm_logLevel=info
+```
+
+3. package.json 配置
+
+在项目 package.json 中添加 envm 字段，优先级最低：
+
+```json
+{
+  "envm": {
+    "port": 5000
+  }
+}
+```
+
+### 作为插件启动
+
+`env-plugin` 使用 [Unplugin](https://unplugin.unjs.io) 为各种构建工具提供统一插件，作为插件启动。
+
+#### webpack
+
+```js
+// webpack.config.js
+import { envmWebpackPlugin } from "env-plugin";
+
+export default {
+  plugins: [
+    envmWebpackPlugin({
+      port: 3000,
+    }),
+  ],
+  // .... 其它配置
+};
+```
+
+#### vite
+
+```js
+// vite.config.js
+import { defineConfig } from "vite";
+import { envmVitePlugin } from "env-plugin";
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [envmVitePlugin()],
+  // ... 其它配置
+});
+```
+
+> 支持工具 vite,rollup,rolldown,webpack,rspack,esbuild,farm
+
+### Cookie 代理
+
+由于 `Cookie` 在同主机的不同端口会进行共享，从而导致不同环境的登录失效，故支持 `Cookie` 代理功能。
+
+例如： 在 `localhost:3001` 端口登录 `环境A`，然后在 `localhost:3002` 登录 `环境B`；第二次登录的 `set-cookie` 操作，会覆盖 `环境A` 的登录操作设置的 `Cookie`。导致 `3001` 端口对 `环境A` 的登录失效。故设置此功能，将不同端口的登录 `Cookie` 分开存储，并在请求时替换成对应环境的 `Cookie`。
+
+其它：
+
+1. 通过管理页面的 `清除所有代理 Cookie` 按钮可以清除所有保存的代理`Cookie`。
+
+建议：
+
+1. 建议将生成的环境数据文件 .envm.data.json 加入 .gitignore，无需提交版本控制
+
+## 许可证
+
+本项目采用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request。请在提交之前阅读 [贡献指南](CONTRIBUTING.md)。
+
+## 作者
+
+- [lumos934](https://github.com/lumos934)
+
+---
+
+感谢使用 `EnvManage`！如果你有任何问题或建议，请随时联系我们。
+
+[npm]: https://img.shields.io/npm/v/env-plugin.svg?logo=npm
+[npm-url]: https://npmjs.com/package/env-plugin
+[node]: https://img.shields.io/node/v/env-plugin.svg?logo=node.js
+[node-url]: https://nodejs.org
+
+这个怎么样？