comp-hub 0.47.1 → 1.0.3

package/README.md

@@ -7,7 +7,7 @@ CLI for comp-hub — a component sharing platform supporting Vue and React. Star
 
 > **Languages**: Full docs are also available in [简体中文 · 繁體中文](https://docs.comphub.cn) on our documentation site.
 >
-> **Website:** <https://www.comphub.cn> &nbsp;·&nbsp; **Docs:** <https://docs.comphub.cn>
+> **Website:** <https://www.comphub.cn> &nbsp;·&nbsp; **Studio:** <https://studio.comphub.cn> &nbsp;·&nbsp; **Docs:** <https://docs.comphub.cn>
 
 ## Requirements
 
@@ -74,6 +74,8 @@ comphub -d ./src         # Custom component directory
 | `comphub status` | List all running projects |
 | `comphub stop <hash>` | Stop a specific project |
 | `comphub stop --all` | Stop all projects |
+| `comphub login` | Sign in via browser authorization |
+| `comphub logout` | Sign out and remove stored credentials |
 | `comphub kill` | Shut down all services |
 
 Examples:
@@ -124,10 +126,43 @@ module.exports = {
 |--------|------|---------|-------------|
 | `dir` | string | `"./"` | Component root directory |
 | `allowDebug` | boolean | false | Enable debug mode |
-| `proxy` | object | — | Custom proxy rules |
+| `proxy` | object | — | Proxy rules for the preview server — see [Proxy rules](#proxy-rules) |
 
 **Priority**: CLI flags > config file > defaults
 
+### Proxy rules
+
+Component demos run inside an iframe and can only talk to the local dev server. `proxy` forwards
+requests matching a path to another server — the same idea as `server.proxy` in Vite or
+`devServer.proxy` in webpack. Use it when a demo needs an API the browser cannot reach directly:
+an internal backend, a third-party API without CORS headers, or another local service.
+
+```json
+{
+  "dir": "./src",
+  "proxy": {
+    "/api": {
+      "target": "http://10.0.0.5:8080",
+      "changeOrigin": true,
+      "pathRewrite": { "^/api": "" }
+    }
+  }
+}
+```
+
+With the config above, `fetch("/__proxy__/api/users")` inside a component demo is forwarded to
+`http://10.0.0.5:8080/users`.
+
+- Request the **absolute** path `/__proxy__/...` from the preview page — the page itself is served
+  under `/{hash}/main/`, and the master routes the request back to your project.
+- The key (`/api` above) is matched against the path that follows `/__proxy__` — prefix match, or a
+  regular expression.
+- The value is passed straight to [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware);
+  `target` is required, everything else is optional.
+- `pathRewrite` is applied after the `/__proxy__` prefix is stripped.
+- Requests matching no rule get `404 {"message":"Proxy not found"}`.
+- Rules are per project: only the project whose `.comphub.json` declares them gets them.
+
 ## Component Specs
 
 - Upload components as **folders** — folder name is the component name
@@ -139,6 +174,7 @@ module.exports = {
 ## Links
 
 - Website: <https://www.comphub.cn>
+- Studio (browser-based component workspace): <https://studio.comphub.cn>
 - Docs (English · 简体中文 · 繁體中文): <https://docs.comphub.cn>
 
 ## License