@coze-arch/cli 0.0.1-alpha.f91253 → 0.0.1-alpha.fd3d56

package/lib/cli.js

@@ -1105,7 +1105,7 @@ const executeRun = async (
     logger.info(`Running ${commandName} command...`);
 
     // 1. 对于 build 命令，先执行 fix 以确保项目配置正确
-    if (commandName === 'build') {
+    if (['dev', 'build'].includes(commandName)) {
       logger.info('\n🔧 Running fix command before build...\n');
       try {
         await executeFix();
@@ -1437,6 +1437,11 @@ const shouldIgnoreFile = (filePath) => {
   return directoryPatterns.some(dir => pathParts.includes(dir));
 };
 
+// ABOUTME: File system utilities for template file processing
+// ABOUTME: Provides directory scanning, file path conversion, and node_modules copying
+
+
+// start_aigc
 /**
  * 递归获取目录中的所有文件
  *
@@ -1507,6 +1512,58 @@ const convertDotfileName = (filePath) => {
   return filePath;
 };
 
+/**
+ * 复制 node_modules 目录（如果存在）
+ *
+ * @param sourceNodeModules - 源 node_modules 路径
+ * @param targetNodeModules - 目标 node_modules 路径
+ */
+const copyNodeModules = (
+  sourceNodeModules,
+  targetNodeModules,
+) => {
+  if (!fs.existsSync(sourceNodeModules)) {
+    return;
+  }
+
+  logger.info('\nCopying node_modules from pre-warmed template...');
+  logger.verbose(`  From: ${sourceNodeModules}`);
+  logger.verbose(`  To: ${targetNodeModules}`);
+
+  const result = shelljs.exec(`cp -R "${sourceNodeModules}" "${targetNodeModules}"`, {
+    silent: true,
+  });
+
+  if (result.stdout) {
+    process.stdout.write(result.stdout);
+  }
+
+  if (result.stderr) {
+    process.stderr.write(result.stderr);
+  }
+
+  if (result.code === 0) {
+    logger.success('✓ node_modules copied successfully');
+  } else {
+    logger.warn(
+      `Failed to copy node_modules: ${result.stderr || 'unknown error'}`,
+    );
+    logger.info('Will need to run pnpm install manually');
+  }
+};
+// end_aigc
+
+// ABOUTME: File rendering utilities for template processing
+// ABOUTME: Handles file content rendering, hook execution, and file writing
+
+
+
+
+
+
+
+
+// start_aigc
 /**
  * 执行文件渲染钩子
  *
@@ -1552,22 +1609,25 @@ const executeFileRenderHook = async (
 };
 
 /**
- * 处理单个文件
+ * 准备单个文件的渲染信息（不实际写入）
+ * 用于 dry-run 阶段，收集所有将要写入的文件信息
+ *
+ * @param options - 准备选项
+ * @returns 文件渲染信息，或 null 表示该文件被跳过
  */
-const processSingleFile = async (options
-
+const prepareFileInfo = async (options
 
 
 
 
 ) => {
-  const { file, templatePath, outputPath, context, templateConfig } = options;
+  const { file, templatePath, context, templateConfig } = options;
 
   const srcPath = path.join(templatePath, file);
   const destFile = convertDotfileName(file);
 
   logger.verbose(
-    `  - Processing: ${file}${destFile !== file ? ` -> ${destFile}` : ''}`,
+    `  - Preparing: ${file}${destFile !== file ? ` -> ${destFile}` : ''}`,
   );
 
   // 判断是否为二进制文件
@@ -1601,38 +1661,195 @@ const processSingleFile = async (options
     context,
   );
 
-  // 如果返回 null，跳过该文件
+  // 如果返回 null，表示该文件被 hook 跳过
   if (processedFileInfo === null) {
     logger.verbose('    ⊘ Skipped by onFileRender hook');
-    return;
+    return null;
   }
 
-  // 使用处理后的目标路径
-  const finalDestPath = path.join(outputPath, processedFileInfo.destPath);
+  return processedFileInfo;
+};
+
+/**
+ * 写入渲染后的文件到目标路径
+ *
+ * @param options - 写入选项
+ */
+const writeRenderedFile = async (options
+
+
+
+) => {
+  const { fileInfo, srcPath, destPath } = options;
+
+  logger.verbose(`  - Writing: ${fileInfo.destPath}`);
 
   // 确保目标目录存在
-  await ensureDir(path.dirname(finalDestPath));
+  await ensureDir(path.dirname(destPath));
 
   // 写入文件
-  if (processedFileInfo.isBinary) {
-    // 二进制文件：如果内容没变，直接复制；否则从 base64 解码写入
-    if (processedFileInfo.content === content) {
-      await fs$1.copyFile(srcPath, finalDestPath);
+  if (fileInfo.isBinary) {
+    // 二进制文件：如果内容是原始 base64（未被 hook 修改），直接复制；否则从 base64 解码写入
+    const buffer = await fs$1.readFile(srcPath);
+    const originalContent = buffer.toString('base64');
+
+    if (fileInfo.content === originalContent) {
+      await fs$1.copyFile(srcPath, destPath);
       logger.verbose('    ✓ Copied (binary)');
     } else {
-      const buffer = Buffer.from(processedFileInfo.content, 'base64');
-      await fs$1.writeFile(finalDestPath, buffer);
+      const modifiedBuffer = Buffer.from(fileInfo.content, 'base64');
+      await fs$1.writeFile(destPath, modifiedBuffer);
       logger.verbose('    ✓ Written (binary, modified by hook)');
     }
   } else {
     // 文本文件
-    await fs$1.writeFile(finalDestPath, processedFileInfo.content, 'utf-8');
+    await fs$1.writeFile(destPath, fileInfo.content, 'utf-8');
     logger.verbose('    ✓ Rendered and written');
   }
 };
+// end_aigc
+
+// ABOUTME: File conflict detection utilities for template processing
+// ABOUTME: Provides dry-run file collection and conflict checking
+
+
+
+
+
+
+
+// start_aigc
+/**
+ * 收集所有将要写入的文件路径（dry-run 阶段）
+ *
+ * @param options - 收集选项
+ * @returns 将要写入的文件路径列表
+ */
+const collectFilesToRender = async (options
+
+
+
+
+) => {
+  const { files, templatePath, context, templateConfig } = options;
+
+  logger.verbose('\nDry-run: Collecting files to render...');
+
+  const fileInfos = await Promise.all(
+    files.map(file =>
+      prepareFileInfo({
+        file,
+        templatePath,
+        context,
+        templateConfig,
+      }),
+    ),
+  );
+
+  // 过滤掉被 hook 跳过的文件，收集 destPath
+  const filesToWrite = fileInfos
+    .filter((info) => info !== null)
+    .map(info => info.destPath);
+
+  logger.verbose(`  - ${filesToWrite.length} files will be written`);
+  logger.verbose(
+    `  - ${fileInfos.length - filesToWrite.length} files skipped by hooks`,
+  );
+
+  return filesToWrite;
+};
+
+/**
+ * 检测文件冲突
+ *
+ * @param outputPath - 输出目录路径
+ * @param filesToWrite - 将要写入的文件路径列表
+ * @returns 冲突的文件路径列表
+ */
+const detectFileConflicts = (
+  outputPath,
+  filesToWrite,
+) => {
+  logger.verbose('\nChecking for file conflicts...');
+
+  const conflicts = [];
+
+  for (const file of filesToWrite) {
+    const fullPath = path.join(outputPath, file);
+    if (fs.existsSync(fullPath)) {
+      conflicts.push(file);
+      logger.verbose(`  ⚠ Conflict detected: ${file}`);
+    }
+  }
+
+  if (conflicts.length === 0) {
+    logger.verbose('  ✓ No conflicts detected');
+  } else {
+    logger.verbose(`  ⚠ ${conflicts.length} conflicts detected`);
+  }
+
+  return conflicts;
+};
+// end_aigc
+
+// ABOUTME: Main file processing orchestration for template rendering
+// ABOUTME: Coordinates file system, rendering, and conflict detection layers
+
+
+
+// start_aigc
+/**
+ * 处理单个文件（准备 + 写入）
+ *
+ * @param options - 处理选项
+ */
+const processSingleFile = async (options
+
+
+
+
+
+) => {
+  const { file, templatePath, outputPath, context, templateConfig } = options;
+
+  const srcPath = path.join(templatePath, file);
+
+  // 准备文件信息
+  const processedFileInfo = await prepareFileInfo({
+    file,
+    templatePath,
+    context,
+    templateConfig,
+  });
+
+  // 如果返回 null，跳过该文件
+  if (processedFileInfo === null) {
+    return;
+  }
+
+  // 使用处理后的目标路径
+  const finalDestPath = path.join(outputPath, processedFileInfo.destPath);
+
+  // 写入文件
+  await writeRenderedFile({
+    fileInfo: processedFileInfo,
+    srcPath,
+    destPath: finalDestPath,
+  });
+};
 
 /**
  * 复制并处理模板文件到目标目录
+ *
+ * 流程：
+ * 1. 验证模板目录
+ * 2. 扫描所有模板文件
+ * 3. Dry-run：收集将要写入的文件列表（考虑 hooks 影响）
+ * 4. 冲突检测：检查是否有文件会被覆盖
+ * 5. 实际写入：渲染并写入所有文件
+ * 6. 复制 node_modules（如果存在）
+ *
+ * @param options - 处理选项
  */
 const processTemplateFiles = async (options
 
@@ -1645,7 +1862,7 @@ const processTemplateFiles = async (options
   logger.verbose(`  - Template path: ${templatePath}`);
   logger.verbose(`  - Output path: ${outputPath}`);
 
-  // 验证模板目录是否存在
+  // 阶段 0: 验证模板目录是否存在
   try {
     const stat = await fs$1.stat(templatePath);
     logger.verbose(
@@ -1661,6 +1878,7 @@ const processTemplateFiles = async (options
     throw error;
   }
 
+  // 阶段 1: 扫描所有模板文件
   const files = await getAllFiles(templatePath);
 
   logger.verbose(`  - Found ${files.length} files to process`);
@@ -1670,6 +1888,29 @@ const processTemplateFiles = async (options
     return;
   }
 
+  // 阶段 2: Dry-run - 收集所有将要写入的文件
+  const filesToWrite = await collectFilesToRender({
+    files,
+    templatePath,
+    context,
+    templateConfig,
+  });
+
+  // 阶段 3: 冲突检测
+  const conflicts = detectFileConflicts(outputPath, filesToWrite);
+
+  if (conflicts.length > 0) {
+    // 有冲突，抛出详细的错误信息
+    const conflictList = conflicts.map(f => `  - ${f}`).join('\n');
+    throw new Error(
+      `File conflicts detected in output directory: ${outputPath}\n\n` +
+        `The following files already exist and would be overwritten:\n${conflictList}\n\n` +
+        'Please remove these files or use a different output directory.',
+    );
+  }
+
+  // 阶段 4: 实际写入文件
+  logger.verbose('\nWriting files...');
   await Promise.all(
     files.map(file =>
       processSingleFile({
@@ -1684,74 +1925,13 @@ const processTemplateFiles = async (options
 
   logger.verbose('✓ All files processed successfully');
 
-  // 单独处理 node_modules 目录（如果存在）
+  // 阶段 5: 单独处理 node_modules 目录（如果存在）
   const sourceNodeModules = path.join(templatePath, 'node_modules');
   const targetNodeModules = path.join(outputPath, 'node_modules');
 
-  if (fs.existsSync(sourceNodeModules)) {
-    logger.info('\nCopying node_modules from pre-warmed template...');
-    logger.verbose(`  From: ${sourceNodeModules}`);
-    logger.verbose(`  To: ${targetNodeModules}`);
-
-    const result = shelljs.exec(`cp -R "${sourceNodeModules}" "${targetNodeModules}"`, {
-      silent: true,
-    });
-
-    if (result.stdout) {
-      process.stdout.write(result.stdout);
-    }
-
-    if (result.stderr) {
-      process.stderr.write(result.stderr);
-    }
-
-    if (result.code === 0) {
-      logger.success('✓ node_modules copied successfully');
-    } else {
-      logger.warn(
-        `Failed to copy node_modules: ${result.stderr || 'unknown error'}`,
-      );
-      logger.info('Will need to run pnpm install manually');
-    }
-  }
-};
-
-/**
- * 检查输出目录是否为空
- * 注意:.git 目录会被忽略,允许在已初始化 git 的目录中创建项目
- *
- * @param outputPath - 输出目录路径
- * @returns 是否为空
- */
-const isOutputDirEmpty = async (
-  outputPath,
-) => {
-  try {
-    const entries = await fs$1.readdir(outputPath);
-    // 过滤掉 .git 目录,允许在已初始化 git 的目录中创建项目
-    const filteredEntries = entries.filter(entry => entry !== '.git');
-    return filteredEntries.length === 0;
-  } catch (e) {
-    // 目录不存在，视为空
-    return true;
-  }
-};
-
-/**
- * 验证输出目录
- *
- * @param outputPath - 输出目录路径
- * @throws 如果目录不为空则抛出错误
- */
-const validateOutputDir = async (outputPath) => {
-  const isEmpty = await isOutputDirEmpty(outputPath);
-  if (!isEmpty) {
-    throw new Error(
-      `Output directory is not empty: ${outputPath}\n` +
-        'Please use an empty directory or remove existing files.',
-    );
-  }
+  copyNodeModules(sourceNodeModules, targetNodeModules);
 };
+// end_aigc
 
 /**
  * 模板引擎执行选项
@@ -1834,9 +2014,9 @@ const executeAfterRenderHook = async (
 /**
  * 准备输出目录
  */
-const prepareOutputDirectory = async (outputPath) => {
+const prepareOutputDirectory = (outputPath) => {
   const absolutePath = path.resolve(process.cwd(), outputPath);
-  await validateOutputDir(absolutePath);
+  // 不再在这里验证目录是否为空，冲突检测已移至 processTemplateFiles 中
   return absolutePath;
 };
 
@@ -1863,7 +2043,7 @@ const execute = async (
   });
 
   // 5. 准备输出目录
-  const absoluteOutputPath = await prepareOutputDirectory(outputPath);
+  const absoluteOutputPath = prepareOutputDirectory(outputPath);
 
   // 6. 处理模板文件
   await processTemplateFiles({
@@ -2121,7 +2301,7 @@ const registerCommand = program => {
     });
 };
 
-var version = "0.0.1-alpha.f91253";
+var version = "0.0.1-alpha.fd3d56";
 var packageJson = {
 	version: version};
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coze-arch/cli",
-  "version": "0.0.1-alpha.f91253",
+  "version": "0.0.1-alpha.fd3d56",
   "private": false,
   "description": "coze coding devtools cli",
   "license": "MIT",