フォルダ構造を出力してプロジェクト全体を把握しよう！

./
├── docs
├── eslint.config.js
├── index.html
├── package.json
├── public
│   └── vite.svg
├── README.md
├── src
│   ├── App.css
│   ├── App.tsx
│   ├── assets … 画像などを格納する
│   │   ├── images
│   │   └── pdfs
│   ├── components … コンポーネントファイルを格納する
│   │   ├── atoms
│   │   ├── molecules
│   │   ├── organisms
│   │   ├── pages
│   │   └── templates
│   ├── hooks … カスタムフックを格納する
│   ├── libs … 外部ライブラリ関連の処理を格納する
│   ├── mocks … モックファイルを格納する
│   ├── stores … グローバルストア関連を格納する
│   ├── styles … CSS を格納する
│   ├── utils … 汎用的に処理を格納する … etc
│   ├── index.css
│   ├── main.tsx
│   └── vite-env.d.ts
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.ts

.
├── app
│   ├── favicon.ico
│   ├── globals.css
│   ├── layout.tsx
│   └── page.tsx
├── eslint.config.mjs
├── next-env.d.ts
├── next.config.ts
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── public
│   ├── file.svg
│   ├── globe.svg
│   ├── next.svg
│   ├── vercel.svg
│   └── window.svg
├── README.md
└── tsconfig.json

import fs from "fs";
import path from "path";

/**
 * フォルダ構造をツリー形式で表示する関数。
 *
 * @param {string} dir - ルートとなるフォルダのパス。デフォルトはカレントフォルダ。
 * @param {string} prefix - ツリー表示用の接頭辞。
 * @param {string[]} excludeDirs - 除外対象のフォルダ名。
 * @returns {void}
 */
const showTree = (
  dir = ".",
  prefix = "",
  excludeDirs = ["node_modules", ".git", ".next"]
) => {
  try {
    const items = fs
      .readdirSync(dir, { withFileTypes: true })
      .filter((item) => !excludeDirs.includes(item.name))
      .sort((a, b) => {
        // フォルダを先に配置する
        // その後、ファイルをアルファベット順にソートする
        if (a.isDirectory() && !b.isDirectory()) return -1;
        if (!a.isDirectory() && b.isDirectory()) return 1;
        return a.name.localeCompare(b.name);
      });

    // パス記号を接頭辞として付与
    items.forEach((item, index) => {
      const isLast = index === items.length - 1;
      const currentPrefix = isLast ? "└── " : "├── ";
      const nextPrefix = isLast ? "    " : "│   ";

      console.log(prefix + currentPrefix + item.name);

      // フォルダの場合は再帰的に実行する
      if (item.isDirectory()) {
        const fullPath = path.join(dir, item.name);
        showTree(fullPath, prefix + nextPrefix, excludeDirs);
      }
    });
  } catch (error) {
    console.error(`Error reading directory ${dir}:`, error.message);
  }
};

/**
 * コマンドライン引数を解析する関数。
 *
 * @returns {{ targetDir: string, excludeDirs: string[] } | null} - 対象フォルダと除外フォルダの設定を含むオブジェクト。ヘルプ表示時は null を返す。
 */
const parseArgs = () => {
  const args = process.argv.slice(2);
  let targetDir = ".";
  let excludeDirs = ["node_modules", ".git", ".next"];

  for (let i = 0; i < args.length; i++) {
    const arg = args[i];

    if (arg === "--exclude" || arg === "-e") {
      // 次の引数を除外フォルダとして取得
      if (i + 1 < args.length) {
        excludeDirs = args[i + 1].split(",").map((dir) => dir.trim());
        i++; // 次の引数をスキップ
      }
    } else if (arg === "--help" || arg === "-h") {
      console.log(`使用方法: node tree.js [フォルダ] [オプション]

オプション:
  --exclude, -e <dirs>  除外するフォルダをカンマ区切りで指定
  --help, -h           このヘルプを表示

例:
  node ファイル.js                                    # カレントフォルダを表示
  node ファイル.js ./src                              # srcフォルダを表示
  node ファイル.js --exclude node_modules,dist        # node_modulesとdistを除外
  node ファイル.js ./src --exclude .git,build         # srcフォルダから.gitとbuildを除外`);
      return null;
    } else if (!arg.startsWith("-")) {
      // オプションでない場合はフォルダとして扱う
      targetDir = arg;
    }
  }

  return { targetDir, excludeDirs };
};

// 実行
const config = parseArgs();
if (config) {
  console.log(`${config.targetDir}`);
  console.log(`除外フォルダ: ${config.excludeDirs.join(", ")}`);
  console.log("");
  showTree(config.targetDir, "", config.excludeDirs);
}