@linyjs/plugin-docs 0.1.0

package/src/cli.ts

@@ -0,0 +1,321 @@
+#!/usr/bin/env node
+
+/**
+ * @linyjs/plugin-docs CLI 工具
+ * 
+ * 提供快速访问文档和示例项目的功能
+ */
+
+import { Command } from 'commander';
+import { readFileSync, existsSync, readdirSync, copyFileSync, mkdirSync } from 'fs';
+import { join, resolve, dirname } from 'path';
+import { execSync } from 'child_process';
+
+const program = new Command();
+
+// 获取插件根目录
+function getPluginRoot(): string {
+  return resolve(__dirname, '..');
+}
+
+// 获取文档目录
+function getDocsDir(): string {
+  return join(getPluginRoot(), 'docs');
+}
+
+// 获取示例目录
+function getExamplesDir(): string {
+  return join(getPluginRoot(), 'examples');
+}
+
+// 打开URL（跨平台）
+function openUrl(url: string): void {
+  const command = process.platform === 'win32'
+    ? `start "" "${url}"`
+    : process.platform === 'darwin'
+    ? `open "${url}"`
+    : `xdg-open "${url}"`;
+
+  try {
+    execSync(command, { stdio: 'inherit' });
+  } catch (error) {
+    console.error(`Failed to open URL: ${url}`);
+    console.error('Please open it manually.');
+  }
+}
+
+// 显示文档列表
+function displayDocsList(): void {
+  const docsDir = getDocsDir();
+
+  console.log('📚 linyjs Plugin Documentation\n');
+  console.log('Available documentation sections:\n');
+
+  const sections = [
+    { name: '入门教程', path: 'getting-started', description: '从零开始的插件开发教程' },
+    { name: '进阶指南', path: 'guides', description: '深入理解各种开发细节' },
+    { name: 'API参考', path: 'api-reference', description: '完整的接口文档' },
+    { name: '最佳实践', path: 'best-practices', description: '开发规范和推荐做法' },
+    { name: '常见问题', path: 'faq.md', description: 'FAQ 和故障排除' }
+  ];
+
+  sections.forEach((section, index) => {
+    console.log(`${index + 1}. ${section.name.padEnd(8)} - ${section.description}`);
+  });
+
+  console.log('\n💡 使用命令:');
+  console.log('  docs --open              在浏览器中打开在线文档');
+  console.log('  docs search <keyword>    搜索文档');
+  console.log('  docs list-examples       列出所有示例项目');
+  console.log('  docs help                显示详细帮助');
+}
+
+// 搜索文档
+function searchDocs(keyword: string): void {
+  const docsDir = getDocsDir();
+  const results: Array<{ file: string; line: number; content: string }> = [];
+
+  function searchInDirectory(dir: string, basePath: string = '') {
+    try {
+      const items = readdirSync(dir, { withFileTypes: true });
+
+      for (const item of items) {
+        const fullPath = join(dir, item.name);
+        const relativePath = join(basePath, item.name);
+
+        if (item.isDirectory()) {
+          searchInDirectory(fullPath, relativePath);
+        } else if (item.isFile() && item.name.endsWith('.md')) {
+          try {
+            const content = readFileSync(fullPath, 'utf-8');
+            const lines = content.split('\n');
+
+            lines.forEach((line, index) => {
+              if (line.toLowerCase().includes(keyword.toLowerCase())) {
+                results.push({
+                  file: relativePath,
+                  line: index + 1,
+                  content: line.trim()
+                });
+              }
+            });
+          } catch (error) {
+            // 忽略读取错误的文件
+          }
+        }
+      }
+    } catch (error) {
+      console.error(`Error searching in directory ${dir}:`, error);
+    }
+  }
+
+  searchInDirectory(docsDir);
+
+  if (results.length === 0) {
+    console.log(`❌ 未找到包含 "${keyword}" 的文档`);
+    return;
+  }
+
+  console.log(`\n🔍 找到 ${results.length} 个包含 "${keyword}" 的结果:\n`);
+
+  results.forEach(result => {
+    const preview = result.content.length > 100
+      ? result.content.substring(0, 97) + '...'
+      : result.content;
+
+    console.log(`📄 ${result.file}:${result.line}`);
+    console.log(`   ${preview}`);
+    console.log('');
+  });
+}
+
+// 列出示例项目
+function listExamples(): void {
+  const examplesDir = getExamplesDir();
+
+  try {
+    const examples = readdirSync(examplesDir, { withFileTypes: true })
+      .filter(dirent => dirent.isDirectory())
+      .map(dirent => dirent.name);
+
+    if (examples.length === 0) {
+      console.log('❌ 暂无可用的示例项目');
+      return;
+    }
+
+    console.log('📂 可用的示例项目:\n');
+
+    examples.forEach((example, index) => {
+      const examplePath = join(examplesDir, example);
+      const packageJsonPath = join(examplePath, 'package.json');
+
+      let description = '示例项目';
+
+      try {
+        if (existsSync(packageJsonPath)) {
+          const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+          description = packageJson.description || description;
+        }
+      } catch (error) {
+        // 忽略解析错误
+      }
+
+      console.log(`${index + 1}. ${example}`);
+      console.log(`   ${description}`);
+    });
+
+    console.log('\n💡 使用命令:');
+    console.log('  example <name>            生成示例到当前目录');
+    console.log('  example <name> -o <dir>   生成示例到指定目录');
+  } catch (error) {
+    console.error('❌ 读取示例列表失败:', error.message);
+  }
+}
+
+// 生成示例项目
+async function generateExample(name: string, outputDir?: string): Promise<void> {
+  const examplesDir = getExamplesDir();
+  const examplePath = join(examplesDir, name);
+
+  // 检查示例是否存在
+  if (!existsSync(examplePath)) {
+    console.error(`❌ 示例 "${name}" 不存在`);
+    listExamples();
+    process.exit(1);
+  }
+
+  // 确定输出目录
+  const targetDir = outputDir ? resolve(process.cwd(), outputDir) : resolve(process.cwd(), name);
+
+  // 创建目标目录
+  mkdirSync(targetDir, { recursive: true });
+
+  console.log(`📦 正在生成示例 "${name}" 到 ${targetDir}...`);
+
+  // 复制示例文件
+  await copyDirectory(examplePath, targetDir);
+
+  // 安装依赖
+  console.log('📦 正在安装依赖...');
+  try {
+    execSync('npm install', { cwd: targetDir, stdio: 'inherit' });
+  } catch (error) {
+    console.log('⚠️  自动安装依赖失败，请手动运行:');
+    console.log(`   cd ${targetDir} && npm install`);
+  }
+
+  console.log(`✅ 示例 "${name}" 生成成功!`);
+  console.log('');
+  console.log('🚀 下一步:');
+  console.log(`   cd ${name}`);
+  console.log('   npm run dev     # 启动开发服务器');
+  console.log('   npm run build   # 构建插件');
+  console.log('');
+  console.log('📖 查看详细说明:');
+  console.log(`   ${join(targetDir, 'README.md')}`);
+}
+
+// 复制目录递归函数
+async function copyDirectory(source: string, target: string): Promise<void> {
+  mkdirSync(target, { recursive: true });
+
+  try {
+    const items = readdirSync(source, { withFileTypes: true });
+
+    for (const item of items) {
+      const sourcePath = join(source, item.name);
+      const targetPath = join(target, item.name);
+
+      if (item.isDirectory()) {
+        await copyDirectory(sourcePath, targetPath);
+      } else {
+        // 过滤掉不需要的文件
+        if (!['.DS_Store', 'Thumbs.db'].includes(item.name)) {
+          copyFileSync(sourcePath, targetPath);
+        }
+      }
+    }
+  } catch (error) {
+    throw new Error(`复制目录失败: ${error.message}`);
+  }
+}
+
+// 设置CLI命令
+program
+  .name('@linyjs/plugin-docs')
+  .description('linyjs 插件文档和示例CLI工具')
+  .version('0.1.0');
+
+// docs 命令
+program
+  .command('docs')
+  .description('访问插件开发文档')
+  .option('--open', '在浏览器中打开在线文档')
+  .option('--list', '列出所有文档分类')
+  .argument('[keyword]', '搜索关键词')
+  .action((keyword, options) => {
+    if (options.open) {
+      console.log('🌐 正在打开在线文档...');
+      const docsUrl = 'https://github.com/linyjs/linyjs/tree/main/packages/plugin-docs/docs';
+      openUrl(docsUrl);
+    } else if (keyword) {
+      searchDocs(keyword);
+    } else {
+      displayDocsList();
+    }
+  });
+
+// example 命令
+program
+  .command('example <name>')
+  .description('生成示例项目')
+  .option('-o, --output <directory>', '指定输出目录')
+  .action(async (name, options) => {
+    try {
+      await generateExample(name, options.output);
+    } catch (error) {
+      console.error('❌ 生成示例失败:', error.message);
+      process.exit(1);
+    }
+  });
+
+// list-examples 命令
+program
+  .command('list-examples')
+  .description('列出所有可用示例')
+  .action(() => {
+    listExamples();
+  });
+
+// 显示帮助信息
+program
+  .command('help')
+  .description('显示详细帮助信息')
+  .action(() => {
+    console.log('\n📖 @linyjs/plugin-docs CLI 工具\n');
+    console.log('使用方法:');
+    console.log('  npx @linyjs/plugin-docs <command> [options]\n');
+    console.log('命令:');
+    console.log('  docs [keyword]            显示文档列表或搜索文档');
+    console.log('  docs --open              在浏览器中打开在线文档');
+    console.log('  example <name>           生成指定示例项目');
+    console.log('  example <name> -o <dir>  生成示例到指定目录');
+    console.log('  list-examples            列出所有可用示例');
+    console.log('  help                     显示详细帮助\n');
+    console.log('示例:');
+    console.log('  npx @linyjs/plugin-docs docs');
+    console.log('  npx @linyjs/plugin-docs docs --open');
+    console.log('  npx @linyjs/plugin-docs docs "权限管理"');
+    console.log('  npx @linyjs/plugin-docs example hello-world');
+    console.log('  npx @linyjs/plugin-docs example blog-plugin -o ./my-blog');
+    console.log('  npx @linyjs/plugin-docs list-examples\n');
+  });
+
+// 如果没有提供命令，显示主帮助
+if (process.argv.length === 2) {
+  program.outputHelp();
+  console.log('');
+  console.log('💡 获取更多信息: npx @linyjs/plugin-docs help');
+} else {
+  program.parse();
+}