@ldsg/cli 0.3.18 → 0.3.25

package/src/utils/get-extend-app-data-params-using-workspace-ldsg-module/index.ts

@@ -0,0 +1,130 @@
+import { FILES_IN_APP_TEMPLATE_MODULE } from '@ldsg/constants';
+import { ExtendAppDataParams } from '@ldsg/utils';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import { GetExtendAppDataParams } from '../../types/get-extend-app-data-params';
+import { RUSH_JSON_PATH } from './constants';
+
+const DEBUG_APP_PACKAGE_NAME = '@ldsg/app';
+
+/**
+ * 主函数，用于准备调试应用环境
+ *
+ * 主要功能包括：
+ * 1. 清理并重建应用目录
+ * 2. 配置workspace模式的ldsg模块依赖
+ * 3. 更新rush.json中的项目配置
+ * 4. 生成调试应用的package.json和入口文件
+ *
+ * @async
+ * @function main
+ * @throws {Error} 当文件读写操作失败时抛出错误
+ */
+export const getExtendAppDataParamsUsingWorkspaceLdsgModule: GetExtendAppDataParams = async (params) => {
+  const { appData: paramsAppData } = params;
+
+  let appData = paramsAppData;
+
+  /**
+   * 相对于普通应用准备，增加了如下操作
+   * 1. ldsg 模块使用 workspace 模式
+   * 2. 在 rush.json 中增加 projects
+   */
+  {
+    const { resourceRecords: appDataResourceRecords } = appData;
+
+    const subspaceProjects: {
+      packageName: string;
+      projectFolder: string;
+    }[] = [
+      {
+        packageName: DEBUG_APP_PACKAGE_NAME,
+        projectFolder: 'generated/app'
+      }
+    ];
+
+    /**
+     * 替换资源记录中的依赖
+     */
+    const resourceRecords = appDataResourceRecords.map((resourceRecord) => {
+      const { id, kind } = resourceRecord;
+
+      if (kind === 'handler') {
+        subspaceProjects.push({
+          packageName: `${id}`,
+          projectFolder: `generated/${id}`
+        });
+
+        let dependencies = resourceRecord.settings.dependencies.map((dependency) => {
+          const res = dependency;
+
+          if (_.startsWith(dependency.name, '@ldsg/')) {
+            return {
+              ...dependency,
+              version: 'workspace:*'
+            };
+          }
+
+          return res;
+        });
+
+        dependencies = dependencies.concat([
+          {
+            name: '@types/node',
+            version: '^24.1.0'
+          },
+          {
+            name: 'typescript',
+            version: '^5.3.3'
+          }
+        ]);
+
+        return {
+          ...resourceRecord,
+          settings: {
+            ...resourceRecord.settings,
+            dependencies
+          }
+        };
+      }
+
+      return resourceRecord;
+    });
+
+    appData = {
+      ...appData,
+      resourceRecords
+    };
+
+    const debugProjects = subspaceProjects.map((item) => {
+      const res = {
+        ...item
+      };
+
+      return res;
+    });
+
+    const rushJson = await fs.readJson(RUSH_JSON_PATH);
+
+    const newRushJson = {
+      ...rushJson,
+      projects: _.sortBy(_.uniqBy(rushJson.projects.concat(debugProjects), 'projectFolder'), 'projectFolder')
+    };
+
+    await fs.writeJson(RUSH_JSON_PATH, newRushJson, { spaces: 2 });
+  }
+
+  const packageJsonFile = FILES_IN_APP_TEMPLATE_MODULE.find((file) => file.path === 'package.json');
+
+  _.set(packageJsonFile, 'data.name', DEBUG_APP_PACKAGE_NAME);
+
+  const res: ExtendAppDataParams = {
+    appData,
+    extraAppData: {
+      // reuseMainAppDependencies: ['graphql', 'graphql-middleware', 'graphql-shield'],
+      filesInAppModele: [...FILES_IN_APP_TEMPLATE_MODULE, packageJsonFile]
+    }
+  };
+
+  return res;
+};

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "types": ["jest", "node"]
+  }
+}

package/dist/generate.d.ts

@@ -1,13 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,187 +0,0 @@
-"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,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -1,78 +0,0 @@
-#!/usr/bin/env node
-"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 });
-const commander_1 = require("commander");
-const path = __importStar(require("path"));
-const generate_1 = require("./generate");
-const start_1 = require("./start");
-const program = new commander_1.Command();
-program
-    .name('ldsg')
-    .description('CLI tool for generating and starting ldsg applications')
-    .version('0.1.0');
-program
-    .command('generate')
-    .alias('g')
-    .description('Generate ldsg application in target directory')
-    .argument('<targetDir>', 'Target directory for application generation')
-    .requiredOption('--data-uri <uri>', 'Application data URI (HTTP URL or file path)')
-    .option('--confirm', 'Skip confirmation prompts')
-    .option('--build', 'Build application after generation')
-    .option('--verbose', 'Enable verbose output')
-    .action(async (targetDir, options) => {
-    const generateOptions = {
-        targetDir: path.resolve(targetDir),
-        appDataUri: options.dataUri,
-        confirm: options.confirm,
-        build: options.build,
-        verbose: options.verbose
-    };
-    await (0, generate_1.generate)(generateOptions);
-});
-program
-    .command('start')
-    .alias('s')
-    .description('Start generated ldsg application in target directory')
-    .argument('<targetDir>', 'Target directory containing the application')
-    .option('--verbose', 'Enable verbose output')
-    .action(async (targetDir, options) => {
-    const startOptions = {
-        targetDir: path.resolve(targetDir),
-        verbose: options.verbose
-    };
-    await (0, start_1.start)(startOptions);
-});
-program.parse();

package/dist/start.d.ts

@@ -1,7 +0,0 @@
-export interface StartOptions {
-    targetDir: string;
-    verbose?: boolean;
-}
-export declare function validateTargetDir(targetDir: string): Promise<void>;
-export declare function start(options: StartOptions): Promise<void>;
-//# sourceMappingURL=start.d.ts.map

package/dist/start.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAsB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBxE;AAED,wBAAsB,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBhE"}

package/dist/start.js

@@ -1,76 +0,0 @@
-"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.validateTargetDir = validateTargetDir;
-exports.start = start;
-const child_process_1 = require("child_process");
-const fs = __importStar(require("fs-extra"));
-const path = __importStar(require("path"));
-async function validateTargetDir(targetDir) {
-    const exists = await fs.pathExists(targetDir);
-    if (!exists) {
-        throw new Error(`Target directory does not exist: ${targetDir}`);
-    }
-    const packageJsonPath = path.join(targetDir, 'package.json');
-    const packageJsonExists = await fs.pathExists(packageJsonPath);
-    if (!packageJsonExists) {
-        throw new Error(`package.json not found in target directory. Is this a valid application?`);
-    }
-    const packageJson = await fs.readJson(packageJsonPath);
-    if (!packageJson.scripts || !packageJson.scripts.start) {
-        throw new Error(`No "start" script found in package.json`);
-    }
-}
-async function start(options) {
-    const { targetDir, verbose = false } = options;
-    if (verbose) {
-        console.log('Starting application...');
-        console.log(`Target directory: ${targetDir}`);
-    }
-    try {
-        await validateTargetDir(targetDir);
-        if (verbose) {
-            console.log('Running npm start...');
-        }
-        (0, child_process_1.execSync)('npm start', {
-            cwd: targetDir,
-            stdio: 'inherit'
-        });
-    }
-    catch (error) {
-        console.error('Start failed:', error);
-        process.exit(1);
-    }
-}