使用 Node.js 实现目录树打印工具：简化项目结构可视化

摘要

在日常开发中，我们经常需要快速查看项目的目录结构，尤其是在处理复杂项目时。手动遍历目录不仅耗时，还容易出错。本文介绍如何使用 Node.js 实现一个轻量级的目录树打印工具，支持忽略指定目录，并输出清晰的可视化结构。通过这个工具，开发者可以更高效地了解项目结构，提升开发体验。

1. 背景与需求

• 为什么需要目录树打印工具？
  • 项目结构复杂时，手动查看目录效率低下。
  • 需要快速了解项目的文件和文件夹分布。
  • 忽略不必要的目录（如 node_modules、.git 等）以减少干扰。
• 工具的目标
  • 提供一种简单、快速的方式可视化目录结构。
  • 支持自定义忽略目录，提升灵活性。

2. 实现原理

• 核心模块
  • 使用 Node.js 的 fs 模块读取目录内容。
  • 使用 path 模块处理文件路径。
• 递归遍历
  • 通过递归函数遍历目录及其子目录。
  • 使用前缀字符（├──、└──、│ ）实现树形结构。
• 忽略目录
  • 通过参数 ignoreDirs 动态忽略指定目录。

3. 代码解析

• 核心函数 printTree
  • 参数说明：
    • dir：当前目录路径。
    • prefix：前缀字符，用于生成树形结构。
    • ignoreDirs：需要忽略的目录列表。
  • 实现细节：
    • 使用 fs.readdirSync 读取目录内容。
    • 使用 fs.statSync 判断文件类型（文件或目录）。
    • 递归调用 printTree 处理子目录。
• 使用示例
  • 打印当前工作目录的树形结构，忽略 node_modules、logs 和 .git 目录。

4. 功能优势与应用场景

• 优势
  • 轻量级：无需额外依赖，直接使用 Node.js 原生模块。
  • 灵活性：支持自定义忽略目录，适应不同项目需求。
  • 可视化：清晰的树形结构输出，便于快速理解项目布局。
• 应用场景
  • 项目初始化时快速了解目录结构。
  • 分享项目结构时生成可读性强的目录树。
  • 调试时检查文件分布情况。

代码实现

import fs from 'fs';
import path from 'path';

function printTree(dir, prefix = '', ignoreDirs = []) {
  const files = fs.readdirSync(dir);

  files.forEach((file, index) => {
    const filePath = path.join(dir, file);
    const isLast = index === files.length - 1;
    const stat = fs.statSync(filePath);

    if (ignoreDirs.includes(file)) {
      return;
    }

    console.log(prefix + (isLast ? '└── ' : '├── ') + file);

    if (stat.isDirectory()) {
      printTree(filePath, prefix + (isLast ? '    ' : '│   '), ignoreDirs);
    }
  });
}

// 使用示例
printTree(process.cwd(), '', ['node_modules', 'logs', '.git']);