comp-hub 0.24.11 → 0.24.12

package/README.md

@@ -0,0 +1,147 @@
+# comp-hub
+
+A Vue-based component preview and sharing platform that makes component reuse simple and efficient.
+
+## 📖 Introduction
+
+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
+
+- Node.js >= 16.0.0
+- npm >= 8.0.0
+
+### Installation
+
+#### Method 1: Global Installation (Recommended)
+
+Install comp-hub CLI globally:
+
+```bash
+npm install comp-hub@latest -g
+```
+
+#### Method 2: Local Dev Dependency Installation
+
+Install only in the current project:
+
+```bash
+npm install comp-hub@latest -D
+```
+
+### Start Service
+
+#### Global Installation
+
+Execute in the project directory:
+
+```bash
+comphub
+```
+
+#### Local Installation
+
+If installed locally with `-D`, use `npx`:
+
+```bash
+npx comphub
+```
+
+After successful startup, access the platform at:
+
+```
+http://localhost:5000
+```
+
+### CLI Options
+
+```bash
+comphub [options]
+```
+
+| 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 |
+
+### Configuration File
+
+Create `.comphub.json` or `.comphub.js` in the project root:
+
+**JSON Format:**
+
+```json
+{
+  "port": 5000,
+  "dir": "./src",
+  "log": "info"
+}
+```
+
+**JS Format:**
+
+```javascript
+module.exports = {
+  port: 5000,
+  dir: './src',
+  log: 'info'
+}
+```
+
+| Config | 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
+
+## 🎯 Version Management
+
+comp-hub supports semantic versioning:
+
+- `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
+
+## 🤝 Contributing
+
+Contributions and suggestions are welcome!
+
+## 📝 License
+
+[MIT License](LICENSE)

package/bin/cli.js

@@ -1,86 +1,86 @@
 #!/usr/bin/env node
-const { program, Option } = require('commander');
-const path = require('path');
-const { spawn } = require('child_process');
-const fs = require('fs');
-
-const projectRoot = path.resolve(__dirname, '..');
-
-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 };
-}
-
-
-const { pkg, entry } = getLocalPkgInfo();
-
-//命令行
-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('--dir-absolute <path>', '资源目录绝对路径').hideHelp())
-    .addOption(new Option('--api <url>', 'API地址').hideHelp())
-    .addOption(new Option('--cwd-relative <path>', '当前工作目录相对路径').hideHelp())
-    .helpOption('-h, --help', '显示帮助信息');
-
-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),
-    };
-
-    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();
+const { program, Option } = require('commander');
+const path = require('path');
+const { spawn } = require('child_process');
+const fs = require('fs');
+
+const projectRoot = path.resolve(__dirname, '..');
+
+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 };
+}
+
+
+const { pkg, entry } = getLocalPkgInfo();
+
+//命令行
+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('--dir-absolute <path>', '资源目录绝对路径').hideHelp())
+    .addOption(new Option('--api <url>', 'API地址').hideHelp())
+    .addOption(new Option('--cwd-relative <path>', '当前工作目录相对路径').hideHelp())
+    .helpOption('-h, --help', '显示帮助信息');
+
+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),
+    };
+
+    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();