README

Simple and elegant PHP library for visualizing directory tree structure

Render directory structures as tree views in PHP — ideal for CLI tools, logging, or documentation.

✨ 特性

支持类 Unix 的 tree 结构输出（含图标）
自动识别文件与目录并排序
支持递归遍历子目录
返回纯文本字符串，适合 CLI 或日志输出
可集成进脚手架、构建流程、项目分析等场景

📦 安装

composer require hizpark/directory-tree-viewer

📂 目录结构

📂 directory-tree-viewer
├── 📂 src
│   └── 📄 DirectoryTreeViewer.php
├── 📂 tests
│   └── 📄 DirectoryTreeViewerTest.php
├── 📄 composer.json
└── 📄 README.md

🚀 用法示例

示例：渲染指定目录结构

use Hizpark\DirectoryTreeViewer\DirectoryTreeViewer;

$viewer = new DirectoryTreeViewer();
echo $viewer->render(__DIR__);

📐 接口说明

render(string $directory): string

渲染指定目录的树状结构，返回字符串形式的表示

public function render(string $directory): string

🎯 代码风格

使用 PHP-CS-Fixer 工具检查代码风格：

composer cs:chk

使用 PHP-CS-Fixer 工具自动修复代码风格问题：

composer cs:fix

🔍 静态分析

使用 PHPStan 工具进行静态分析，确保代码的质量和一致性：

composer stan

✅ 单元测试

执行 PHPUnit 单元测试：

composer test

执行 PHPUnit 单元测试并生成代码覆盖率报告：

composer test:coverage

🤝 贡献指南

欢迎 Issue 与 PR，建议遵循以下流程：

Fork 仓库
创建新分支进行开发
提交 PR 前请确保测试通过、风格一致
提交详细描述

📝 License

MIT License. See the LICENSE file for details.

hizpark / directory-tree-viewer

Maintainers

Details