comp-hub 0.27.19 → 0.28.1

package/README.md

@@ -1,147 +1,132 @@
 # comp-hub
 
-A Vue-based component preview and sharing platform that makes component reuse simple and efficient.
+CLI for comp-hub — a Vue component sharing platform. Start a local dev server to preview, manage, and share components.
 
-## 📖 Introduction
+[![npm version](https://img.shields.io/npm/v/comp-hub)](https://www.npmjs.com/package/comp-hub)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
 
-comp-hub is a component management platform designed for frontend developers, dedicated to solving pain points such as component reuse, missing documentation, and low standardization. By providing real-time preview, dependency management, and version control, it makes component sharing and usage simple and efficient.
-
-## 🚀 Core Features
-
-- **Real-time Preview & Dependency Management**: Online real-time component preview with automatic dependency version matching, ensuring what you see is what you get after download
-- **Lightweight Component Architecture**: Components contain only minimal runtime units, seamlessly integrating into existing project environments
-- **Simple Upload Process**: Complete component publishing in three steps, supporting preview configuration, documentation, and version management
-- **Documentation Support**: Standard Markdown documentation support to help users quickly understand and use components
-- **Version Management**: Semantic versioning with multi-version coexistence and switching
-- **Cross-project Reuse**: Standardized component structure ensures high compatibility and portability across different projects
-
-## 📦 Supported Frameworks
-
-| Framework | Version | Status |
-|-----------|---------|--------|
-| Vue | 2.x | ✅ Supported |
-| Vue | 3.x | ✅ Supported |
-| React | - | ⏳ Planned |
-
-## 💻 Installation & Usage
-
-### Requirements
+## Requirements
 
 - Node.js >= 16.0.0
 - npm >= 8.0.0
 
-### Installation
+## Installation
 
-#### Method 1: Global Installation (Recommended)
-
-Install comp-hub CLI globally:
+**Global (recommended)**
 
 ```bash
 npm install comp-hub@latest -g
 ```
 
-#### Method 2: Local Dev Dependency Installation
-
-Install only in the current project:
+**Local**
 
 ```bash
 npm install comp-hub@latest -D
 ```
 
-### Start Service
+## Quick Start
 
-#### Global Installation
-
-Execute in the project directory:
+Run in your project directory:
 
 ```bash
 comphub
 ```
 
-#### Local Installation
+Once started, open the URL shown in the terminal (default `http://localhost:5478`).
 
-If installed locally with `-D`, use `npx`:
+### CLI Options
 
 ```bash
-npx comphub
+comphub [options]
 ```
 
-After successful startup, access the platform at:
+| Option | Alias | Type | Default | Description |
+|--------|-------|------|---------|-------------|
+| `--port` | `-p` | number | 5478 | Server port |
+| `--dir` | `-d` | path | `"./"` | Component directory |
+| `--version` | `-v` | — | — | Show version |
+| `--help` | `-h` | — | — | Show help |
+
+Examples:
 
-```
-http://localhost:5000
+```bash
+comphub -p 8080          # Custom port
+comphub -d ./src         # Custom component directory
 ```
 
-### CLI Options
+### Management Commands
+
+| Command | Description |
+|---------|-------------|
+| `comphub` | Start dev server |
+| `comphub status` | List all running projects |
+| `comphub stop <hash>` | Stop a specific project |
+| `comphub stop --all` | Stop all projects |
+| `comphub kill` | Shut down all services |
+
+Examples:
 
 ```bash
-comphub [options]
+# Check running projects
+comphub status
+
+# Stop a specific project
+comphub stop 94525912
+
+# Stop all projects
+comphub stop --all
+
+# Shut down everything
+comphub kill
 ```
 
-| Option | Short | Type | Default | Description |
-|--------|-------|------|---------|-------------|
-| `--port` | `-p` | number | 5000 | Service port |
-| `--dir` | `-d` | path | "./" | Resource directory relative path |
-| `--log` | `-l` | level | "info" | Log level |
-| `--version` | `-v` | - | - | Show version number |
-| `--help` | `-h` | - | - | Show help information |
+### Multi-Project
+
+Run multiple projects simultaneously on separate ports:
 
-### Configuration File
+```bash
+cd /path/to/project-a && comphub
+cd /path/to/project-b && comphub
+comphub status             # List all
+```
 
-Create `.comphub.json` or `.comphub.js` in the project root:
+## Configuration
 
-**JSON Format:**
+Create `.comphub.json` or `.comphub.js` in your project root:
 
 ```json
 {
-  "port": 5000,
   "dir": "./src",
-  "log": "info"
+  "allowDebug": false
 }
 ```
 
-**JS Format:**
-
 ```javascript
 module.exports = {
-  port: 5000,
   dir: './src',
-  log: 'info'
+  allowDebug: false
 }
 ```
 
-| Config | Type | Default | Description |
+| Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `port` | number | 5000 | Service startup port |
-| `dir` | string | "./" | Component code root directory path |
-| `log` | string | "info" | Log level: "debug", "info", "warn", "error" |
-
-## 📚 Documentation
-
-Complete usage guide and API documentation:
-
-**[comp-hub Official Documentation](https://docs.comphub.cn/en/)**
-
-## 🔧 Component Specifications
-
-- Components must be uploaded as **folders**, with the folder name as the component name
-- Component folder must contain `index.vue` as the entry file
-- Recommended to provide `README.md` describing component functionality and usage
-- Support `comp.json` file for component metadata configuration
+| `dir` | string | `"./"` | Component root directory |
+| `allowDebug` | boolean | false | Enable debug mode |
+| `proxy` | object | — | Custom proxy rules |
 
-## 🎯 Version Management
+**Priority**: CLI flags > config file > defaults
 
-comp-hub supports semantic versioning:
+## Component Specs
 
-- `X.Y.Z` format (e.g., 1.2.3)
-- `X`: Major version, incompatible API changes
-- `Y`: Minor version, backward-compatible functionality additions
-- `Z`: Patch version, backward-compatible bug fixes
+- Upload components as **folders** — folder name is the component name
+- Must include `index.vue` as entry point
+- Include a `README.md` describing usage
+- Optional `demo/` directory for preview configs
 
-## 🤝 Contributing
+## Documentation
 
-Contributions and suggestions are welcome!
+[comp-hub Docs](https://docs.comphub.cn/)
 
-## 📝 License
+## License
 
-[MIT License](LICENSE)
+[MIT](LICENSE)

package/bin/cli.js

@@ -1,85 +1,51 @@
 #!/usr/bin/env node
-const { program, Option } = require('commander');
-const path = require('path');
-const { spawn } = require('child_process');
-const fs = require('fs');
+const { program, Option } = require("commander");
+const { getLocalPkgInfo } = require("./lib/utils");
+const { statusCommand, stopCommand, killCommand } = require("./lib/commands");
+const { main } = require("./lib/startup");
 
-const projectRoot = path.resolve(__dirname, '..');
+const { pkg } = getLocalPkgInfo();
 
-const readJson = (p) => JSON.parse(fs.readFileSync(p, 'utf8'));
-
-//读取包信息
-function getLocalPkgInfo() {
-    const pkgPath = path.join(projectRoot, 'package.json');
-    const pkg = readJson(pkgPath);
-    const entry = path.join(projectRoot, pkg.main || 'dist/index.js');
-    return { pkg, entry };
+function portArg(v) {
+  return parseInt(v, 10);
 }
 
+// Global options
+program
+  .name("comphub")
+  .option("-p, --port <number>", "Startup port", portArg)
+  .option("-d, --dir <path>", "Resource directory relative path")
+  .version(pkg.version, "-v, --version", "Show version")
+  .addOption(new Option("--allow-debug", "Enable debug mode").hideHelp())
+  .addOption(new Option("--api <url>", "API URL").hideHelp())
+  .helpOption("-h, --help", "Show help");
+
+// status subcommand: view master status and all projects
+program
+  .command("status")
+  .description("View master service status and all running projects")
+  .addOption(new Option("-p, --port <number>", "Master port").argParser(portArg).hideHelp())
+  .action(statusCommand);
 
-const { pkg, entry } = getLocalPkgInfo();
-
-//命令行
+// stop subcommand: stop projects
 program
-    .option('-p, --port <number>', '启动端口', (v) => parseInt(v, 10), 5000)
-    .option('-d, --dir <path>', '资源目录相对路径', './')
-    .option('-l, --log <level>', '日志等级', (v) => {
-        const ok = ['debug', 'info', 'warn', 'error'];
-        if (!ok.includes(v)) throw new Error(`日志等级必须是 ${ok.join(', ')}`);
-        return v;
-    }, 'info')
-    .version(pkg.version, '-v, --version', '显示版本号')
-    .addOption(new Option('--allow-debug', '是否允许调试模式').hideHelp())
-    .addOption(new Option('--api <url>', 'API地址').hideHelp())
-    .helpOption('-h, --help', '显示帮助信息');
+  .command("stop [hash]")
+  .description("Stop a specific project (by hash) or stop all projects (--all)")
+  .addOption(new Option("-p, --port <number>", "Master port").argParser(portArg).hideHelp())
+  .option("-a, --all", "Stop all projects")
+  .action(stopCommand);
+
+// kill subcommand: shutdown master process
+program.command("kill").description("Shutdown master process").addOption(new Option("-p, --port <number>", "Master port").argParser(portArg).hideHelp()).action(killCommand);
+
+// Default startup command
+program.action(async () => {
+  try {
+    await main(pkg, program.opts());
+  } catch (e) {
+    console.error(`✗ Startup failed: ${e.message}`);
+    process.exit(1);
+  }
+});
 
 program.parse();
-
-
-//主流程
-function main() {
-    //检查当前工作目录是否是node项目
-    if (!fs.existsSync(path.join(process.cwd(), 'package.json'))) {
-        console.error('❌ 当前工作目录不是node工程，无法启动');
-        process.exit(1);
-    }
-
-    const opts = program.opts();
-
-    console.log(`✅ ${pkg.name} v${pkg.version}`);
-
-    //忽略传递的参数配置
-    const ignoreArgs = ['-v', '--version', '-h', '--help'];
-    const userArgs = process.argv.slice(2).filter((a) => !ignoreArgs.includes(a));
-
-    const env = {
-        ...process.env,
-        COMP_HUB_VERSION: pkg.version,
-        COMP_HUB_CONFIG: JSON.stringify(opts),
-        MIDWAY_TS_MODE: 'false',
-    };
-
-    if (!fs.existsSync(entry)) {
-        console.log('\nℹ️  入口文件不存在，启动失败');
-        return;
-    }
-
-    const child = spawn(process.execPath, [entry, ...userArgs], {
-        stdio: 'inherit',
-        cwd: process.cwd(),
-        env,
-        shell: process.platform === 'win32',
-    });
-
-    child.on('exit', (code) => process.exit(code ?? 0));
-    child.on('error', (e) => (console.error(`❌ 启动失败：${e.message}`), process.exit(1)));
-
-    ['SIGINT', 'SIGTERM'].forEach((sig) =>
-        process.on(sig, () => {
-            console.log('\n⚠️  终止进程...');
-            child.kill(sig);
-        })
-    );
-}
-
-main();

package/bin/lib/commands.js

@@ -0,0 +1,147 @@
+const { httpGet, httpPost } = require("./http");
+const { ADMIN_API, DEFAULT_PORT } = require("./constants");
+const { readMasterRuntime, colors, apiUrl } = require("./utils");
+const { green, yellow, cyan, white, red } = colors;
+
+function formatUptime(seconds) {
+  const UNITS = [
+    { label: "d", divisor: 86400 },
+    { label: "h", divisor: 3600 },
+    { label: "m", divisor: 60 },
+    { label: "s", divisor: 1 }
+  ];
+
+  let remaining = Math.floor(seconds);
+  const parts = [];
+
+  for (const { label, divisor } of UNITS) {
+    if (remaining >= divisor) {
+      const value = Math.floor(remaining / divisor);
+      remaining = remaining % divisor;
+      parts.push(`${value}${label}`);
+    }
+  }
+
+  return parts.length > 0 ? parts.join(" ") : "0s";
+}
+
+function resolveMasterPort(opts) {
+  // 用户明确指定了端口，直接使用
+  if (opts.port != null) {
+    return opts.port;
+  }
+  // 从 runtime 文件读取 master 实际端口
+  const runtime = readMasterRuntime();
+  if (runtime) {
+    return runtime.managementPort;
+  }
+  // 兜底：默认端口
+  return DEFAULT_PORT;
+}
+
+async function statusCommand(opts) {
+  const masterPort = resolveMasterPort(opts);
+  const runtime = readMasterRuntime();
+  const displayPort = runtime ? runtime.publicPort : masterPort;
+
+  console.log(`\n${yellow("●")} Master Status\n`);
+
+  const health = await httpGet(apiUrl(masterPort, ADMIN_API.HEALTH));
+  if (!health.ok || !health.body || typeof health.body.status !== "string") {
+    console.error(`${red("✗")} Master service is not running`);
+    process.exit(1);
+  }
+
+  const info = health.body;
+  const statusIcon = info.status === "running" ? green("●") : cyan("●");
+
+  console.log(`  ${green("Status")}      ${statusIcon} ${info.status}`);
+  console.log(`  ${green("Version")}     ${white(info.version)}`);
+  console.log(`  ${green("Uptime")}      ${white(formatUptime(info.uptime))}`);
+  console.log(`  ${green("Projects")}    ${white(info.projects)}`);
+  console.log("");
+
+  const projects = await httpGet(apiUrl(masterPort, ADMIN_API.PROJECTS));
+  if (projects.ok && projects.body) {
+    const list = projects.body.projects;
+    if (Array.isArray(list) && list.length > 0) {
+      console.log(`  ${yellow("▸")} Registered Projects (${list.length}):`);
+      console.log("  " + white("─".repeat(56)));
+      for (const p of list) {
+        console.log(`    ${green("hash")}     ${white(p.hash)}`);
+        console.log(`    ${green("path")}     ${white(p.cwd)}`);
+        // console.log(`    ${green('port')}     ${p.port}`);
+        // if (p.subPort) console.log(`    ${green('subPort')}  ${p.subPort}`);
+        console.log(`    ${green("url")}      ${cyan(`http://localhost:${displayPort}/${p.hash}/main/`)}`);
+        console.log("  " + white("─".repeat(56)));
+      }
+    } else {
+      console.log(`  ${white("─".repeat(58))}`);
+      console.log(`      ${white("(No registered projects)")}`);
+      console.log(`  ${white("─".repeat(58))}`);
+    }
+  }
+  console.log("");
+  process.exit(0);
+}
+
+async function stopCommand(hash, opts) {
+  const masterPort = resolveMasterPort(opts);
+
+  if (opts.all) {
+    const projects = await httpGet(apiUrl(masterPort, ADMIN_API.PROJECTS));
+    if (!projects.ok || !projects.body) {
+      console.error(`${red("✗")} Cannot connect to master service`);
+      process.exit(1);
+    }
+    const list = projects.body.projects;
+    if (!Array.isArray(list) || list.length === 0) {
+      console.log(`${yellow("ℹ")} No running projects`);
+      process.exit(0);
+    }
+    console.log(`\n${yellow("▸")} Stopping all ${list.length} projects...\n`);
+    for (const p of list) {
+      const res = await httpPost(apiUrl(masterPort, ADMIN_API.DEREGISTER), { hash: p.hash });
+      if (res.ok) {
+        console.log(`  ${green("✓")} Stopped: ${p.hash} (${p.cwd})`);
+      } else {
+        console.error(`  ${red("✗")} Failed to stop: ${p.hash} - ${res.error}`);
+      }
+    }
+    console.log("");
+    process.exit(0);
+  }
+
+  if (!hash) {
+    console.error(`${red("✗")} Please specify project hash or use --all to stop all projects`);
+    console.error(`   Usage: comphub stop <hash>`);
+    console.error(`   Usage: comphub stop --all`);
+    process.exit(1);
+  }
+
+  console.log(`\n${yellow("▸")} Stopping project ${hash}...`);
+  const res = await httpPost(apiUrl(masterPort, ADMIN_API.DEREGISTER), { hash });
+  if (res.ok) {
+    console.log(`  ${green("✓")} Stopped: ${hash}\n`);
+  } else {
+    console.error(`  ${red("✗")} Failed to stop: ${res.error}\n`);
+    process.exit(1);
+  }
+  process.exit(0);
+}
+
+async function killCommand(opts) {
+  const masterPort = resolveMasterPort(opts);
+  console.log(`\n${yellow("▸")} Shutting down master process...\n`);
+
+  const res = await httpPost(apiUrl(masterPort, ADMIN_API.SHUTDOWN), {});
+  if (res.ok) {
+    console.log(`${green("✓")} Master process has been shut down\n`);
+  } else {
+    console.error(`${red("✗")} Shutdown failed: ${res.error}\n`);
+    process.exit(1);
+  }
+  process.exit(0);
+}
+
+module.exports = { statusCommand, stopCommand, killCommand };

package/bin/lib/constants.js

@@ -0,0 +1,22 @@
+const path = require("path");
+const os = require("os");
+
+const DEFAULT_PORT = 5478;
+
+const MASTER_RUNTIME_FILE = path.join(os.tmpdir(), ".comphub", "master.json");
+
+const ADMIN_API = {
+  PREFIX: "/__master__",
+  HEALTH: "/__master__/health",
+  REGISTER: "/__master__/register",
+  DEREGISTER: "/__master__/deregister",
+  PROJECTS: "/__master__/projects",
+  SHUTDOWN: "/__master__/shutdown"
+};
+
+const POLL_INTERVAL = 500;
+const MAX_RETRIES = 40;
+const HTTP_TIMEOUT_GET = 2000;
+const HTTP_TIMEOUT_POST = 5000;
+
+module.exports = { DEFAULT_PORT, MASTER_RUNTIME_FILE, ADMIN_API, POLL_INTERVAL, MAX_RETRIES, HTTP_TIMEOUT_GET, HTTP_TIMEOUT_POST };

package/bin/lib/http.js

@@ -0,0 +1,62 @@
+const http = require("http");
+const { HTTP_TIMEOUT_GET, HTTP_TIMEOUT_POST } = require("./constants");
+
+function parseBody(raw) {
+  try {
+    return JSON.parse(raw);
+  } catch {
+    return raw;
+  }
+}
+
+function httpGet(url) {
+  return new Promise(resolve => {
+    const req = http.get(url, res => {
+      let body = "";
+      res.on("data", chunk => (body += chunk));
+      res.on("end", () => resolve({ ok: true, status: res.statusCode, body: parseBody(body) }));
+    });
+    req.on("error", err => resolve({ ok: false, error: err.message }));
+    req.setTimeout(HTTP_TIMEOUT_GET, () => {
+      req.destroy();
+      resolve({ ok: false, error: "请求超时" });
+    });
+  });
+}
+
+function httpPost(url, data) {
+  return new Promise(resolve => {
+    const postData = JSON.stringify(data);
+    const urlObj = new URL(url);
+    const options = {
+      hostname: urlObj.hostname,
+      port: urlObj.port,
+      path: urlObj.pathname,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "Content-Length": Buffer.byteLength(postData)
+      }
+    };
+    const req = http.request(options, res => {
+      let body = "";
+      res.on("data", chunk => (body += chunk));
+      res.on("end", () => {
+        try {
+          resolve({ ok: true, body: JSON.parse(body) });
+        } catch {
+          resolve({ ok: false, error: "Invalid JSON response" });
+        }
+      });
+    });
+    req.on("error", err => resolve({ ok: false, error: err.message }));
+    req.setTimeout(HTTP_TIMEOUT_POST, () => {
+      req.destroy();
+      resolve({ ok: false, error: "请求超时" });
+    });
+    req.write(postData);
+    req.end();
+  });
+}
+
+module.exports = { httpGet, httpPost };