xw-devtool-cli 1.0.38 → 1.0.39

package/README.md

@@ -4,7 +4,7 @@
 
 一个基于 Node.js 的开发者命令行工具箱，旨在提供开箱即用的常用开发工具，帮助开发者快速处理日常任务。
 
-主要功能包括：Base64 编解码、图片格式转换、图片与 Base64 互转、Mock 数据生成、时间戳/日期格式化、时间计算、URL 编解码、UUID 生成、汉字转拼音、颜色转换、变量格式转换、哈希计算、二维码生成、特殊符号大全、Markdown 语法工具、VS Code 代码段生成等。所有结果均自动复制到剪贴板，极大提升开发效率。
+主要功能包括：Base64 编解码、图片格式转换、图片与 Base64 互转、Mock 数据生成、时间戳/日期格式化、时间计算、URL 编解码、UUID 生成、汉字转拼音、颜色转换、变量格式转换、哈希计算、二维码生成、特殊符号大全、Markdown 语法工具、VS Code 代码段生成、当前目录树生成等。所有结果均自动复制到剪贴板，极大提升开发效率。
 
 ## ✨ 功能特性
 
@@ -51,6 +51,7 @@
   - **Markdown 语法工具**：提供常用 Markdown 语法模板 (Headers, Lists, Tables, Code 等)，一键复制。
   - **VS Code 代码段生成器**：将代码转换为 VS Code Snippet JSON，自动生成语法速查表注释。
   - **Git 助手**: 标准化生成 Git 分支名 (feature/bugfix/custom) 和 Conventional Commits 提交日志。
+  - **当前目录树生成**：生成当前目录的文件树结构，支持指定层级，默认输出全部层级并自动复制到剪贴板。
   - **占位图生成**：自定义尺寸、背景色、文字颜色和格式生成占位图。
 - **便捷操作**：
   - 支持文件选择对话框 (Windows)。
@@ -132,7 +133,8 @@ s. Emoji 选择器
 t. Markdown 片段
 u. VS Code 代码片段生成
 v. Git 助手 (分支/提交模板)
-w. 设置 / 语言 (Settings)
+w. 当前目录树生成
+x. 设置 / 语言 (Settings)
 0. 退出
 =================================
 ```
@@ -169,6 +171,13 @@ w. 设置 / 语言 (Settings)
   - 默认输出到源目录下的 `compressed_YYYYMMDD_HHmmss` 文件夹。
   - 自动复制输出目录路径。
   - 完成后可选直接打开输出目录。
+
+### 当前目录树生成
+- 选择 `w` 进入。
+- 先选择层级模式：
+  - **所有层级**：从当前目录递归到最深层。
+  - **指定层级**：输入层级数字（`0` 表示仅根目录，`1` 表示包含第一层子项）。
+- 生成后的目录树会自动复制到剪贴板，便于粘贴到文档或 Issue 中。
 
 ### 3. 占位图生成 (Placeholder Image)
 - 选择 `3` 进入。

package/README_EN.md

@@ -4,7 +4,7 @@
 
 A Node.js-based developer command-line toolbox designed to provide out-of-the-box common development tools to help developers handle daily tasks quickly.
 
-Key features include: Base64 encoding/decoding, image format conversion, image <-> Base64, Mock data generation, timestamp/date formatting, time calculation, URL encoding/decoding, UUID generation, Chinese pinyin conversion, color conversion, variable format conversion, hash calculation, QR code generation, special symbols, Markdown snippets, VS Code snippet generation, etc. All results are automatically copied to the clipboard, greatly improving development efficiency.
+Key features include: Base64 encoding/decoding, image format conversion, image <-> Base64, Mock data generation, timestamp/date formatting, time calculation, URL encoding/decoding, UUID generation, Chinese pinyin conversion, color conversion, variable format conversion, hash calculation, QR code generation, special symbols, Markdown snippets, VS Code snippet generation, current directory tree generation, etc. All results are automatically copied to the clipboard, greatly improving development efficiency.
 
 ## ✨ Features
 
@@ -45,6 +45,7 @@ Key features include: Base64 encoding/decoding, image format conversion, image <
   - **Markdown Snippets**: Common Markdown templates.
   - **VS Code Snippets**: Generate VS Code snippet JSON from code.
   - **Git Helper**: Generate standardized Git branch names (feature/bugfix) and Conventional Commits messages.
+  - **Current Directory Tree**: Generate the file tree for the current directory, with optional depth limit (default: all levels), and copy result to clipboard.
 - **Convenience**:
   - File selection dialog (Windows).
   - Auto-copy results to clipboard.
@@ -119,6 +120,7 @@ i. Special Characters (Symbols)
 j. Emoji Picker
 k. Markdown Snippets
 l. VS Code Snippet Generator
+m. Current Directory Tree
 s. Settings (Language)
 0. Exit
 =================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xw-devtool-cli",
-  "version": "1.0.38",
+  "version": "1.0.39",
   "type": "module",
   "description": "基于node的开发者助手cli",
   "main": "index.js",
@@ -59,7 +59,9 @@
     "git",
     "git-branch",
     "commit-message",
-    "conventional-commits"
+    "conventional-commits",
+    "directory-tree",
+    "file-tree"
   ],
   "author": "npmxw",
   "license": "ISC",

package/src/commands/fileTree.js

@@ -0,0 +1,90 @@
+import fs from 'fs';
+import path from 'path';
+import inquirer from 'inquirer';
+import i18next from '../i18n.js';
+import { selectFromMenu } from '../utils/menu.js';
+import { copy } from '../utils/clipboard.js';
+
+export async function fileTreeHandler() {
+    const mode = await selectFromMenu(
+        i18next.t('fileTree.depthMode'),
+        [
+            { name: i18next.t('fileTree.allDepth'), value: 'all' },
+            { name: i18next.t('fileTree.customDepth'), value: 'custom' }
+        ],
+        true,
+        i18next.t('common.back')
+    );
+
+    if (mode === '__BACK__') {
+        return;
+    }
+
+    let maxDepth = Infinity;
+    if (mode === 'custom') {
+        const { depth } = await inquirer.prompt([
+            {
+                type: 'input',
+                name: 'depth',
+                message: i18next.t('fileTree.depthPrompt'),
+                validate: (input) => {
+                    const value = Number.parseInt(input, 10);
+                    if (!Number.isInteger(value) || value < 0) {
+                        return i18next.t('fileTree.depthInvalid');
+                    }
+                    return true;
+                }
+            }
+        ]);
+        maxDepth = Number.parseInt(depth, 10);
+    }
+
+    const cwd = process.cwd();
+    const tree = buildTree(cwd, maxDepth);
+    const depthText = Number.isFinite(maxDepth) ? String(maxDepth) : i18next.t('fileTree.allDepth');
+
+    console.log(i18next.t('fileTree.generated', { path: cwd, depth: depthText }));
+    const preview = tree.length > 2000 ? `${tree.slice(0, 1000)}\n...\n${tree.slice(-800)}` : tree;
+    console.log(`\n${preview}\n`);
+    await copy(tree);
+}
+
+export function buildTree(rootPath, maxDepth) {
+    const rootName = path.basename(rootPath) || rootPath;
+    const lines = [rootName];
+
+    walkDir(rootPath, '', 0, maxDepth, lines);
+
+    return lines.join('\n');
+}
+
+function walkDir(currentPath, prefix, depth, maxDepth, lines) {
+    if (depth >= maxDepth) {
+        return;
+    }
+
+    let entries = [];
+    try {
+        entries = fs.readdirSync(currentPath, { withFileTypes: true });
+    } catch (error) {
+        lines.push(`${prefix}└── [${i18next.t('fileTree.readFailed')}: ${error.message}]`);
+        return;
+    }
+
+    entries.sort((a, b) => {
+        if (a.isDirectory() && !b.isDirectory()) return -1;
+        if (!a.isDirectory() && b.isDirectory()) return 1;
+        return a.name.localeCompare(b.name, undefined, { sensitivity: 'base' });
+    });
+
+    entries.forEach((entry, index) => {
+        const isLast = index === entries.length - 1;
+        const connector = isLast ? '└── ' : '├── ';
+        lines.push(`${prefix}${connector}${entry.name}`);
+
+        if (entry.isDirectory()) {
+            const nextPrefix = `${prefix}${isLast ? '    ' : '│   '}`;
+            walkDir(path.join(currentPath, entry.name), nextPrefix, depth + 1, maxDepth, lines);
+        }
+    });
+}

package/src/index.js

@@ -35,6 +35,7 @@ import { pixelDistanceHandler } from './commands/pixelDistance.js';
 import { screenMarkHandler } from './commands/screenMark.js';
 import { gitHelperHandler } from './commands/gitHelper.js';
 import { imgCompressHandler } from './commands/imgCompress.js';
+import { fileTreeHandler } from './commands/fileTree.js';
 
 process.on('SIGINT', () => {
     console.log(`\n${i18next.t('menu.bye')}`);
@@ -91,6 +92,7 @@ function getFeatures() {
         { name: i18next.t('menu.features.markdown'), value: 'markdown' },
         { name: i18next.t('menu.features.vscodeSnippet'), value: 'vscodeSnippet' },
         { name: i18next.t('menu.features.gitHelper'), value: 'gitHelper' },
+        { name: i18next.t('menu.features.fileTree'), value: 'fileTree' },
         
         // Settings
         { name: i18next.t('menu.features.settings'), value: 'settings' }
@@ -293,6 +295,9 @@ async function handleAction(action) {
         case 'gitHelper':
             await gitHelperHandler();
             break;
+        case 'fileTree':
+            await fileTreeHandler();
+            break;
         case 'settings':
             await handleSettings();
             break;

package/src/locales/en.js

@@ -64,6 +64,7 @@ export default {
             markdown: 'Markdown Snippets',
             vscodeSnippet: 'VS Code Snippet Generator',
             gitHelper: 'Git Helper (Branch/Commit Template)',
+            fileTree: 'Current Directory Tree',
             settings: 'Settings / Language'
         }
     },
@@ -157,5 +158,14 @@ export default {
         scanResult: 'Images found',
         preservePrompt: 'Preserve original directory structure in output?',
         suffixPrompt: 'Append filename suffix (compressed + timestamp)?'
+    },
+    fileTree: {
+        depthMode: 'Select tree depth mode',
+        allDepth: 'All levels',
+        customDepth: 'Specify depth',
+        depthPrompt: 'Enter depth (0 means root only):',
+        depthInvalid: 'Please enter an integer greater than or equal to 0',
+        generated: 'Directory tree generated (path: {{path}}, depth: {{depth}}) and copied to clipboard',
+        readFailed: 'Failed to read directory'
     }
 };

package/src/locales/zh.js

@@ -64,6 +64,7 @@ export default {
             markdown: 'Markdown 片段',
             vscodeSnippet: 'VS Code 代码片段生成',
             gitHelper: 'Git 助手 (分支/提交模板)',
+            fileTree: '当前目录树生成',
             settings: '设置 / 语言 (Settings)'
         }
     },
@@ -158,5 +159,14 @@ export default {
         preservePrompt: '递归时是否按原始目录结构输出'
         ,
         suffixPrompt: '是否在文件名添加后缀（compressed+时间戳）'
+    },
+    fileTree: {
+        depthMode: '请选择目录树生成层级',
+        allDepth: '所有层级',
+        customDepth: '指定层级',
+        depthPrompt: '请输入层级（0 表示仅根目录）:',
+        depthInvalid: '请输入大于等于 0 的整数',
+        generated: '目录树已生成（路径: {{path}}，层级: {{depth}}），已复制到剪贴板',
+        readFailed: '读取目录失败'
     }
 };