@ldsg/cli 0.1.0-alpha.8 → 0.3.18

package/README.md

@@ -1,3 +1,201 @@
-# Ldsg CLI
+# @ldsg/cli
 
-落地生根命令行
+命令行工具，用于生成和部署 ldsg 应用。
+
+## 安装
+
+```bash
+npm install -g @ldsg/cli
+```
+
+或者在 monorepo 中本地使用：
+
+```bash
+cd libs/cli
+npm link
+```
+
+## 使用
+
+### Generate 命令
+
+根据 `LDSG_APP_DATA_URI` 环境变量获取应用数据，在指定目录生成 ldsg 应用。如果未指定目录，则在当前目录生成：
+
+```bash
+ldsg generate /path/to/target
+```
+
+或者使用缩写：
+
+```bash
+ldsg g /path/to/target
+```
+
+在当前目录生成：
+
+```bash
+ldsg g
+```
+
+#### 参数
+
+- `<targetDir>` - 目标目录路径（可选，默认为当前目录）
+
+#### 选项
+
+- `--confirm` - 跳过确认提示，直接生成
+- `--build` - 生成后构建应用
+- `--verbose` - 启用详细输出
+
+#### 示例
+
+##### 基本生成
+
+```bash
+export LDSG_APP_DATA_URI="http://example.com/app-data"
+ldsg generate ./my-app
+```
+
+##### 生成并构建
+
+```bash
+ldsg generate ./my-app --build
+```
+
+##### 启用详细输出
+
+```bash
+ldsg generate ./my-app --verbose
+```
+
+### Deploy 命令
+
+将 ldsg 应用部署到目标目录：
+
+```bash
+ldsg deploy /path/to/target
+```
+
+### 命令行参数
+
+`ldsg deploy <targetDir> [options]`
+
+#### 参数
+
+- `<targetDir>` - 目标目录路径（必需）
+
+#### 选项
+
+- `--confirm` - 跳过确认提示，直接部署
+- `--dry-run` - 预览模式，显示将要执行的操作但不实际更改文件
+- `--verbose` - 启用详细输出
+
+### 示例
+
+#### 基本部署
+
+```bash
+ldsg deploy ./dist/my-app
+```
+
+#### 部署到已存在的目录（需要确认）
+
+```bash
+ldsg deploy ./existing-dir
+# 输出：Target directory ./existing-dir already exists.
+#       Use --confirm flag to proceed without prompting.
+```
+
+#### 强制覆盖已存在的目录
+
+```bash
+ldsg deploy ./existing-dir --confirm
+```
+
+#### 预览将要执行的操作
+
+```bash
+ldsg deploy ./preview-dir --dry-run
+# 输出：Dry run mode - no changes will be made
+#       Would deploy to: /absolute/path/to/preview-dir
+```
+
+#### 启用详细输出
+
+```bash
+ldsg deploy ./verbose-dir --verbose
+# 输出：Starting deployment...
+#       Target directory: /absolute/path/to/verbose-dir
+#       Starting build process...
+#       Build completed successfully
+#       Copying files from /path/to/dist to /absolute/path/to/verbose-dir...
+#       Files copied successfully
+#       Deployment completed successfully!
+```
+
+## 工作流程
+
+部署命令执行以下步骤：
+
+1. 验证目标目录（如果存在且未提供 --confirm，则提示确认）
+2. 执行构建过程（`rush build`）
+3. 复制构建产物到目标目录
+4. 生成部署元数据文件（`deployment.json`）
+
+## 部署元数据
+
+成功部署后，目标目录将包含 `deployment.json` 文件：
+
+```json
+{
+  "timestamp": "2024-03-09T12:00:00.000Z",
+  "version": "0.1.0",
+  "targetDir": "/absolute/path/to/target"
+}
+```
+
+## 错误处理
+
+CLI 会提供清晰的错误消息：
+
+- **缺少目标目录**：提示必须提供目标目录参数
+- **缺少 LDSG_APP_DATA_URI**：提示必须设置环境变量
+- **构建失败**：显示构建错误详情并退出
+- **文件操作错误**：显示权限或其他文件系统错误
+- **目标目录已存在**：提示使用 --confirm 或 --dry-run
+
+## 退出码
+
+- `0` - 部署成功
+- `1` - 部署失败（构建错误、文件错误、验证失败等）
+
+## 开发
+
+### 构建项目
+
+```bash
+cd libs/cli
+npm run build
+```
+
+### 运行测试
+
+```bash
+cd libs/cli
+npm test
+```
+
+### 清理构建产物
+
+```bash
+cd libs/cli
+npm run clean
+```
+
+## 贡献
+
+欢迎贡献！请确保：
+
+1. 代码遵循项目风格指南
+2. 添加适当的测试
+3. 更新文档

package/dist/generate.d.ts

@@ -0,0 +1,13 @@
+export interface GenerateOptions {
+    targetDir: string;
+    appDataUri: string;
+    confirm?: boolean;
+    verbose?: boolean;
+    build?: boolean;
+}
+export declare function checkLdsgAppDataUri(uri: string): void;
+export declare function copyTemplateFiles(targetDir: string, verbose?: boolean): Promise<void>;
+export declare function installDependencies(targetDir: string, verbose?: boolean): Promise<void>;
+export declare function buildApplication(targetDir: string, verbose?: boolean): Promise<void>;
+export declare function generate(options: GenerateOptions): Promise<void>;
+//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAIrD;AAuBD,wBAAsB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAgClG;AAED,wBAAsB,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBpG;AAED,wBAAsB,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBjG;AAED,wBAAsB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DtE"}

package/dist/generate.js

@@ -0,0 +1,187 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkLdsgAppDataUri = checkLdsgAppDataUri;
+exports.copyTemplateFiles = copyTemplateFiles;
+exports.installDependencies = installDependencies;
+exports.buildApplication = buildApplication;
+exports.generate = generate;
+const child_process_1 = require("child_process");
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const app_builder_1 = require("@ldsg/app-builder");
+const app_builder_2 = require("@ldsg/app-builder");
+const constants_1 = require("@ldsg/constants");
+const LOCKSTEP_VERSION = '0.3.24';
+function checkLdsgAppDataUri(uri) {
+    if (!uri) {
+        throw new Error('appDataUri is required. Use --data-uri <uri>');
+    }
+}
+async function replaceWorkspaceDependencies(packageJsonPath, verbose = false) {
+    const packageJson = await fs.readJson(packageJsonPath);
+    let modified = false;
+    if (packageJson.dependencies) {
+        for (const key of Object.keys(packageJson.dependencies)) {
+            if (packageJson.dependencies[key] === 'workspace:*' && key.startsWith('@ldsg/')) {
+                packageJson.dependencies[key] = LOCKSTEP_VERSION;
+                modified = true;
+                if (verbose) {
+                    console.log(`    Changed ${key}: workspace:* -> ${LOCKSTEP_VERSION}`);
+                }
+            }
+        }
+    }
+    if (modified) {
+        await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+    }
+}
+async function copyTemplateFiles(targetDir, verbose = false) {
+    if (verbose) {
+        console.log('Copying template files to target directory...');
+    }
+    try {
+        await fs.ensureDir(targetDir);
+        for (const file of constants_1.FILES_IN_APP_TEMPLATE_MODULE) {
+            const { path: filename, data } = file;
+            if (filename === 'index.ts')
+                continue;
+            const targetPath = path.join(targetDir, filename);
+            if (verbose) {
+                console.log(`  - ${filename}`);
+            }
+            if (typeof data === 'object') {
+                await fs.writeJson(targetPath, data, { spaces: 2 });
+            }
+            else {
+                await fs.writeFile(targetPath, data);
+            }
+        }
+        if (verbose) {
+            console.log('Template files copied successfully');
+        }
+    }
+    catch (error) {
+        throw new Error(`Failed to copy template files: ${error}`);
+    }
+}
+async function installDependencies(targetDir, verbose = false) {
+    if (verbose) {
+        console.log('Installing dependencies...');
+    }
+    try {
+        await replaceWorkspaceDependencies(path.join(targetDir, 'package.json'), verbose);
+        (0, child_process_1.execSync)('npm install', {
+            cwd: targetDir,
+            stdio: verbose ? 'inherit' : 'pipe'
+        });
+        if (verbose) {
+            console.log('Dependencies installed successfully');
+        }
+    }
+    catch (error) {
+        throw new Error(`Failed to install dependencies: ${error}`);
+    }
+}
+async function buildApplication(targetDir, verbose = false) {
+    if (verbose) {
+        console.log('Building application...');
+    }
+    try {
+        (0, child_process_1.execSync)('npm run build', {
+            cwd: targetDir,
+            stdio: verbose ? 'inherit' : 'pipe'
+        });
+        if (verbose) {
+            console.log('Application built successfully');
+        }
+    }
+    catch (error) {
+        throw new Error(`Failed to build application: ${error}`);
+    }
+}
+async function generate(options) {
+    const { targetDir, appDataUri, confirm = false, verbose = false, build = false } = options;
+    if (verbose) {
+        console.log('Starting application generation...');
+        console.log(`Target directory: ${targetDir}`);
+        console.log(`App data URI: ${appDataUri}`);
+    }
+    try {
+        await checkLdsgAppDataUri(appDataUri);
+        const targetExists = await fs.pathExists(targetDir);
+        if (targetExists) {
+            if (!confirm) {
+                console.log(`Target directory ${targetDir} already exists.`);
+                console.log('Use --confirm flag to proceed without prompting.');
+                process.exit(1);
+            }
+            if (verbose) {
+                console.log(`Overwriting existing directory: ${targetDir}`);
+            }
+            await fs.emptyDir(targetDir);
+        }
+        else {
+            await fs.ensureDir(targetDir);
+        }
+        if (verbose) {
+            console.log('Fetching application data...');
+        }
+        const appData = await (0, app_builder_1.fetchAppDataFromUri)({ appDataUri, outputPath: undefined });
+        if (verbose) {
+            console.log('Preparing application structure...');
+        }
+        await (0, app_builder_2.prepareApp)({ appData, outputPath: targetDir });
+        if (verbose) {
+            console.log('Copying template files...');
+        }
+        await copyTemplateFiles(targetDir, verbose);
+        if (verbose) {
+            console.log('Installing dependencies...');
+        }
+        await installDependencies(targetDir, verbose);
+        if (build) {
+            if (verbose) {
+                console.log('Building application...');
+            }
+            await buildApplication(targetDir, verbose);
+        }
+        console.log('Application generation completed successfully!');
+    }
+    catch (error) {
+        console.error('Generation failed:', error);
+        process.exit(1);
+    }
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+#!/usr/bin/env node
 export {};
 //# sourceMappingURL=index.d.ts.map