dolly-mls-cli 1.0.0

package/README.md

@@ -0,0 +1,109 @@
+# mls-cli
+
+一个命令行脚手架工具，用于从远程 Git 仓库拉取模板并生成新项目结构。
+
+## 功能特性
+
+- 从 GitHub/GitLab 等远程仓库下载项目模板
+- 支持模板变量替换
+- 交互式项目配置引导
+- 快速初始化项目目录结构
+
+## 环境要求
+
+- Node.js >= 14.0.0
+- npm 或 yarn
+
+## 安装
+
+### 全局安装（推荐）
+
+```bash
+npm install -g mls-cli
+或
+npm install -g mls-cli --registry=https://packages.aliyun.com/688f46a99eda9d4e3ee46b62/npm/npm-registry/
+```
+
+### 本地使用
+
+```bash
+npx mls-cli <project-name>
+```
+
+## 源码运行说明
+
+### 1. 克隆仓库
+
+```bash
+git clone https://codeup.aliyun.com/688f46a99eda9d4e3ee46b62/mls-cli.git
+cd mls-cli
+```
+
+### 2. 安装依赖
+
+```bash
+npm install
+```
+
+### 3. 本地运行
+
+```bash
+# 使用 node 直接运行
+node bin/cli.js <project-name>
+
+# 或者创建软链接进行测试
+npm link
+mls <project-name>
+```
+
+### 4. 运行测试
+
+```bash
+npm test
+```
+
+## 使用示例
+
+```bash
+# 创建新项目
+mls my-project https://codeup.aliyun.com/688f46a99eda9d4e3ee46b62/mls-template.git
+
+- 上面地址为可用脚手架模板地址
+
+# 按照提示选择模板和配置
+```
+
+## 项目结构
+
+```
+mls-cli/
+├── bin/
+│   └── cli.js          # 命令行入口
+├── lib/
+│   ├── create.js       # 项目创建逻辑
+│   ├── download.js     # 模板下载逻辑
+│   └── replace.js      # 变量替换逻辑
+├── test/
+│   └── test.js         # 测试文件
+├── package.json        # 项目配置
+└── README.md           # 说明文档
+```
+
+## 依赖说明
+
+- **commander**: 命令行参数解析
+- **download-git-repo**: Git 仓库下载
+- **chalk**: 命令行颜色输出
+- **ora**: 加载动画
+- **fs-extra**: 文件系统扩展
+- **glob**: 文件匹配
+
+## 开发计划
+
+- [ ] 支持更多模板源
+- [ ] 添加配置文件支持
+- [ ] 优化交互体验
+
+## License
+
+ISC

package/bin/cli.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const create = require('../lib/create');
+const pkg = require('../package.json');
+
+program
+  .name('mls')
+  .version(pkg.version)
+  .description('A CLI scaffold tool for creating projects from remote templates');
+
+program
+  .command('create <projectName> <url>')
+  .description('Create a new project from a remote template')
+  .option('-p, --placeholder <placeholder>', 'Custom placeholder pattern to replace', '{{PROJECT_NAME}}')
+  .action(async (projectName, url, options) => {
+    console.log(chalk.blue(`\nCreating project: ${projectName}`));
+    console.log(chalk.gray(`Template URL: ${url}\n`));
+    
+    try {
+      await create(projectName, url, options);
+      console.log(chalk.green(`\nProject ${projectName} created successfully!`));
+      console.log(chalk.cyan(`\nNext steps:`));
+      console.log(chalk.white(`  cd ${projectName}`));
+      console.log(chalk.white(`  npm install`));
+      console.log(chalk.white(`  npm start\n`));
+    } catch (error) {
+      console.error(chalk.red(`\nError: ${error.message}`));
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/lib/create.js

@@ -0,0 +1,49 @@
+const path = require('path');
+const fs = require('fs-extra');
+const ora = require('ora');
+const chalk = require('chalk');
+const download = require('./download');
+const replace = require('./replace');
+
+/**
+ * Create a new project from a remote template
+ * @param {string} projectName - The name of the project to create
+ * @param {string} url - The URL of the template (git repo or zip file)
+ * @param {object} options - Options including placeholder pattern
+ */
+async function create(projectName, url, options = {}) {
+  const targetDir = path.resolve(process.cwd(), projectName);
+  const placeholder = options.placeholder || '{{PROJECT_NAME}}';
+
+  // Check if target directory already exists
+  if (fs.existsSync(targetDir)) {
+    throw new Error(`Directory "${projectName}" already exists. Please choose a different name or remove the existing directory.`);
+  }
+
+  // Create target directory
+  fs.ensureDirSync(targetDir);
+
+  const downloadSpinner = ora('Downloading template...').start();
+
+  try {
+    // Download template
+    await download(url, targetDir);
+    downloadSpinner.succeed('Template downloaded successfully');
+
+    // Replace placeholders
+    const replaceSpinner = ora('Replacing placeholders...').start();
+    const replacedCount = await replace(targetDir, placeholder, projectName);
+    replaceSpinner.succeed(`Replaced ${replacedCount} occurrences in template files`);
+
+    return targetDir;
+  } catch (error) {
+    downloadSpinner.fail('Failed to download template');
+    // Clean up on failure
+    if (fs.existsSync(targetDir)) {
+      fs.removeSync(targetDir);
+    }
+    throw error;
+  }
+}
+
+module.exports = create;

package/lib/download.js

@@ -0,0 +1,200 @@
+const fs = require('fs-extra');
+const path = require('path');
+const https = require('https');
+const http = require('http');
+const { execSync } = require('child_process');
+const { URL } = require('url');
+
+/**
+ * Download template from URL
+ * Supports: git repositories, zip files, tar.gz files
+ * @param {string} url - The URL to download from
+ * @param {string} targetDir - The target directory
+ */
+async function download(url, targetDir) {
+  // Determine download type based on URL
+  if (isGitUrl(url)) {
+    return downloadFromGit(url, targetDir);
+  } else if (url.endsWith('.zip') || url.endsWith('.tar.gz') || url.endsWith('.tgz')) {
+    return downloadArchive(url, targetDir);
+  } else {
+    // Try git clone first, fallback to archive download
+    try {
+      return await downloadFromGit(url, targetDir);
+    } catch {
+      throw new Error('Unable to download template. Please provide a valid git URL or archive URL (.zip, .tar.gz)');
+    }
+  }
+}
+
+/**
+ * Check if URL is a git repository URL
+ */
+function isGitUrl(url) {
+  return url.endsWith('.git') ||
+         url.includes('github.com') ||
+         url.includes('gitlab.com') ||
+         url.includes('gitee.com') ||
+         url.includes('bitbucket.org');
+}
+
+/**
+ * Download from git repository
+ */
+async function downloadFromGit(url, targetDir) {
+  // Normalize git URL
+  let gitUrl = url;
+  
+  // Handle GitHub shorthand (user/repo)
+  if (/^[\w-]+\/[\w-]+$/.test(url)) {
+    gitUrl = `https://github.com/${url}.git`;
+  }
+  
+  // Ensure .git extension for proper cloning
+  if (!gitUrl.endsWith('.git') && !gitUrl.includes('?')) {
+    gitUrl = gitUrl + '.git';
+  }
+
+  try {
+    // Clone to temp directory first, then move contents
+    const tempDir = targetDir + '_temp';
+    execSync(`git clone --depth 1 "${gitUrl}" "${tempDir}"`, {
+      stdio: 'pipe'
+    });
+
+    // Remove .git folder
+    fs.removeSync(path.join(tempDir, '.git'));
+
+    // Move contents to target directory
+    const files = fs.readdirSync(tempDir);
+    for (const file of files) {
+      fs.moveSync(path.join(tempDir, file), path.join(targetDir, file));
+    }
+
+    // Clean up temp directory
+    fs.removeSync(tempDir);
+  } catch (error) {
+    throw new Error(`Git clone failed: ${error.message}`);
+  }
+}
+
+/**
+ * Download archive file (zip, tar.gz)
+ */
+async function downloadArchive(url, targetDir) {
+  const tempFile = path.join(targetDir, 'temp_archive');
+  
+  try {
+    // Download file
+    await downloadFile(url, tempFile);
+
+    // Extract based on file type
+    if (url.endsWith('.zip')) {
+      await extractZip(tempFile, targetDir);
+    } else {
+      await extractTarGz(tempFile, targetDir);
+    }
+
+    // Clean up temp file
+    fs.removeSync(tempFile);
+  } catch (error) {
+    throw new Error(`Archive download failed: ${error.message}`);
+  }
+}
+
+/**
+ * Download a file from URL
+ */
+function downloadFile(url, dest) {
+  return new Promise((resolve, reject) => {
+    const parsedUrl = new URL(url);
+    const protocol = parsedUrl.protocol === 'https:' ? https : http;
+    
+    const file = fs.createWriteStream(dest);
+    
+    const request = protocol.get(url, (response) => {
+      // Handle redirects
+      if (response.statusCode >= 300 && response.statusCode < 400 && response.headers.location) {
+        file.close();
+        fs.unlinkSync(dest);
+        return downloadFile(response.headers.location, dest).then(resolve).catch(reject);
+      }
+
+      if (response.statusCode !== 200) {
+        file.close();
+        fs.unlinkSync(dest);
+        return reject(new Error(`HTTP ${response.statusCode}`));
+      }
+
+      response.pipe(file);
+      
+      file.on('finish', () => {
+        file.close();
+        resolve();
+      });
+    });
+
+    request.on('error', (err) => {
+      fs.unlink(dest, () => {});
+      reject(err);
+    });
+
+    file.on('error', (err) => {
+      fs.unlink(dest, () => {});
+      reject(err);
+    });
+  });
+}
+
+/**
+ * Extract zip file
+ */
+async function extractZip(zipPath, targetDir) {
+  // Use built-in unzip on Unix or PowerShell on Windows
+  const isWindows = process.platform === 'win32';
+  
+  if (isWindows) {
+    execSync(`powershell -Command "Expand-Archive -Path '${zipPath}' -DestinationPath '${targetDir}' -Force"`, {
+      stdio: 'pipe'
+    });
+  } else {
+    execSync(`unzip -o "${zipPath}" -d "${targetDir}"`, {
+      stdio: 'pipe'
+    });
+  }
+
+  // If extracted to a single subdirectory, move contents up
+  await flattenSingleSubdir(targetDir);
+}
+
+/**
+ * Extract tar.gz file
+ */
+async function extractTarGz(tarPath, targetDir) {
+  execSync(`tar -xzf "${tarPath}" -C "${targetDir}"`, {
+    stdio: 'pipe'
+  });
+
+  // If extracted to a single subdirectory, move contents up
+  await flattenSingleSubdir(targetDir);
+}
+
+/**
+ * If directory contains only one subdirectory, move its contents up
+ */
+async function flattenSingleSubdir(dir) {
+  const items = fs.readdirSync(dir).filter(item => !item.startsWith('temp_'));
+  
+  if (items.length === 1) {
+    const subdir = path.join(dir, items[0]);
+    if (fs.statSync(subdir).isDirectory()) {
+      const files = fs.readdirSync(subdir);
+      for (const file of files) {
+        fs.moveSync(path.join(subdir, file), path.join(dir, file), { overwrite: true });
+      }
+      fs.removeSync(subdir);
+    }
+  }
+}
+
+module.exports = download;

package/lib/replace.js

@@ -0,0 +1,204 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { glob } = require('glob');
+
+// File extensions to process for placeholder replacement
+const TEXT_EXTENSIONS = [
+  '.json', '.yaml', '.yml', '.html', '.htm', '.xml', 
+  '.md', 'Dockerfile', 'Makefile', 'Rakefile'
+];
+
+// Files to always check (regardless of extension)
+const ALWAYS_CHECK_FILES = [
+  'package.json',
+  'package-lock.json',
+  'README.md',
+  'README',
+  'LICENSE',
+  '.gitignore',
+  '.npmrc',
+  '.nvmrc',
+  'Dockerfile',
+  'docker-compose.yml',
+  'docker-compose.yaml'
+];
+
+// Directories to skip
+const SKIP_DIRS = [
+  'node_modules',
+  '.git',
+  '.svn',
+  '.hg',
+  'dist',
+  'build',
+  '.next',
+  '.nuxt',
+  '__pycache__',
+  '.pytest_cache',
+  'vendor',
+  '.idea',
+  '.vscode'
+];
+
+/**
+ * Replace placeholder in all text files within a directory
+ * @param {string} dir - The directory to process
+ * @param {string} placeholder - The placeholder pattern to replace
+ * @param {string} replacement - The replacement value (project name)
+ * @returns {number} - Number of replacements made
+ */
+async function replace(dir, placeholder, replacement) {
+  let totalReplacements = 0;
+
+  // Get all files recursively
+  const files = await glob('**/*', {
+    cwd: dir,
+    nodir: true,
+    dot: true,
+    ignore: SKIP_DIRS.map(d => `**/${d}/**`)
+  });
+
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    const fileName = path.basename(file);
+    const ext = path.extname(file).toLowerCase();
+
+    // Check if file should be processed
+    const shouldProcess = TEXT_EXTENSIONS.includes(ext) ||
+                         TEXT_EXTENSIONS.includes(fileName) ||
+                         ALWAYS_CHECK_FILES.includes(fileName) ||
+                         !ext; // Files without extension
+
+    if (shouldProcess) {
+      try {
+        const count = await replaceInFile(filePath, placeholder, replacement);
+        totalReplacements += count;
+      } catch {
+        // Skip files that can't be read (binary files, etc.)
+      }
+    }
+  }
+
+  // Also handle file/directory renaming if placeholder is in the name
+  await renameWithPlaceholder(dir, placeholder, replacement);
+
+  return totalReplacements;
+}
+
+/**
+ * Replace placeholder in a single file
+ * @param {string} filePath - Path to the file
+ * @param {string} placeholder - The placeholder pattern
+ * @param {string} replacement - The replacement value
+ * @returns {number} - Number of replacements made
+ */
+async function replaceInFile(filePath, placeholder, replacement) {
+  const content = await fs.readFile(filePath, 'utf8');
+  
+  // Check if file is binary
+  if (isBinary(content)) {
+    return 0;
+  }
+
+  // Create regex for the placeholder (escape special characters)
+  const escapedPlaceholder = escapeRegExp(placeholder);
+  const regex = new RegExp(escapedPlaceholder, 'g');
+  
+  // Count matches
+  const matches = content.match(regex);
+  const count = matches ? matches.length : 0;
+
+  if (count > 0) {
+    const newContent = content.replace(regex, replacement);
+    await fs.writeFile(filePath, newContent, 'utf8');
+  }
+
+  return count;
+}
+
+/**
+ * Rename files and directories containing the placeholder using recursive approach
+ * This ensures nested directories are handled correctly
+ */
+async function renameWithPlaceholder(dir, placeholder, replacement) {
+  await renameRecursive(dir, placeholder, replacement);
+}
+
+/**
+ * Recursively rename files and directories
+ * Process order: files first, then recurse into subdirs, finally rename current dir items
+ */
+async function renameRecursive(dir, placeholder, replacement) {
+  if (!fs.existsSync(dir)) return;
+  
+  const items = fs.readdirSync(dir);
+  const files = [];
+  const dirs = [];
+  
+  // Separate files and directories
+  for (const item of items) {
+    if (SKIP_DIRS.includes(item)) continue;
+    
+    const itemPath = path.join(dir, item);
+    try {
+      if (fs.statSync(itemPath).isDirectory()) {
+        dirs.push(item);
+      } else {
+        files.push(item);
+      }
+    } catch {
+      // Skip items that can't be accessed
+    }
+  }
+  
+  // 1. Rename files in current directory
+  for (const file of files) {
+    if (file.includes(placeholder)) {
+      const filePath = path.join(dir, file);
+      const newName = file.replace(new RegExp(escapeRegExp(placeholder), 'g'), replacement);
+      const newPath = path.join(dir, newName);
+      await fs.move(filePath, newPath, { overwrite: true });
+    }
+  }
+  
+  // 2. Recurse into subdirectories (process children before renaming parent)
+  for (const subdir of dirs) {
+    const subdirPath = path.join(dir, subdir);
+    await renameRecursive(subdirPath, placeholder, replacement);
+  }
+  
+  // 3. Rename subdirectories in current directory (after their contents are processed)
+  // Re-read directory as some items may have been renamed in recursion
+  const updatedItems = fs.readdirSync(dir);
+  for (const item of updatedItems) {
+    if (SKIP_DIRS.includes(item)) continue;
+    
+    const itemPath = path.join(dir, item);
+    try {
+      if (fs.statSync(itemPath).isDirectory() && item.includes(placeholder)) {
+        const newName = item.replace(new RegExp(escapeRegExp(placeholder), 'g'), replacement);
+        const newPath = path.join(dir, newName);
+        await fs.move(itemPath, newPath, { overwrite: true });
+      }
+    } catch {
+      // Skip items that can't be accessed
+    }
+  }
+}
+
+/**
+ * Check if content appears to be binary
+ */
+function isBinary(content) {
+  // Check for null bytes which indicate binary content
+  return content.includes('\0');
+}
+
+/**
+ * Escape special regex characters in a string
+ */
+function escapeRegExp(string) {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+module.exports = replace;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "dolly-mls-cli",
+  "version": "1.0.0",
+  "description": "A CLI scaffold tool for creating projects from remote templates",
+  "main": "index.js",
+  "bin": {
+    "mls": "./bin/cli.js"
+  },
+  "scripts": {
+    "test": "node test/test.js"
+  },
+  "keywords": [
+    "cli",
+    "scaffold",
+    "template",
+    "generator"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^12.0.0",
+    "download-git-repo": "^3.0.2",
+    "fs-extra": "^11.2.0",
+    "glob": "^13.0.6",
+    "ora": "^5.4.1"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}