Skip to content

Latest commit

 

History

History
131 lines (92 loc) · 5.46 KB

README.md

File metadata and controls

131 lines (92 loc) · 5.46 KB

Project Tree Viewer

Удобное WinForms-приложение на .NET 9 для создания наглядного ASCII‑дерева структуры любого проекта. Позволяет быстро отфильтровать ненужные папки и типы файлов, выбрать шрифт и скопировать результат в буфер для документации или передачи ИИ.

🚀 Возможности

  • Открытие папки в один клик Быстрый выбор корневого каталога проекта через стандартный диалог.

  • Живой просмотр ASCII‑дерева Автоматическая генерация дерева со стилем Git: ├──, └── и отступами.

  • Фильтрация папок верхнего уровня Динамический список подпапок корня (включая bin, obj и скрытые), где можно включать или исключать каждую.

  • Фильтрация по расширениям Сбор всех расширений файлов проекта и отображение в виде списка с чекбоксами — по умолчанию отмечены .cs, .sln, .csproj, .designer.

  • Скрытые файлы и папки Возможность игнорировать все элементы, начинающиеся с точки (например, .git, .vs).

  • Выбор шрифта Шесть вариантов для максимальной читабельности:

    • Consolas
    • Courier New
    • Lucida Console
    • Fira Code
    • Times New Roman
    • Tahoma

  • Копирование в буфер Одним кликом копируется всё дерево в буфер для вставки в тикеты, документацию или чат.

📦 Установка

  1. Клонировать репозиторий

    git clone https://github.com/Avazbek22/ProjectTreeViewer.git
cd project-tree-viewer

  2. Открыть в Visual Studio 2022+ или JetBrains Rider Убедитесь, что установлен .NET 9 SDK.

  3. Сборка и запуск Нажмите F5 или Start Debugging.

📝 Использование

  1. Настройки Нажмите Настройки, чтобы открыть панель фильтров и выбор шрифта.

  2. Выбор папки Нажмите Открыть папку и укажите корень проекта.

  3. Настройка фильтров

    • В Папки верхнего уровня отмечайте или убирайте подпапки для включения/исключения.
    • В Типы файлов отмечайте нужные расширения.
    • Переключите Игнорировать скрытые для скрытия файлов/папок с точкой в начале.

  4. Применить и обновить Нажмите Применить настройки для обновления дерева.

  5. Копирование Нажмите Скопировать всё для копирования ASCII‑дерева.

💡 Сценарии использования

  • Код‑ревью и описания PR Вставьте дерево в описание PR, чтобы ревьюерам было проще ориентироваться.

  • Регистрация багов и тикеты Добавьте снимок структуры, чтобы показать расположение файлов.

  • AI‑ассистенты Передайте ИИ (ChatGPT, Copilot) компактное представление большой кодовой базы, когда весь код отправить невозможно.

    ├── src  
│   ├── Controllers  
│   ├── Services  
│   └── Models  
└── tests  
    ├── Unit  
    └── Integration

  • Документация и Wiki Автоматически обновляемый раздел с деревом проекта.

  • Онбординг новых сотрудников Быстрая ориентация в структуре без изучения всего кода.

🔧 Идеи развития

  • Экспорт в Markdown Сохранение вывода в формат .md автоматически.

  • Сохранение настроек Переключатели фильтров и шрифта как пресеты для разных проектов.

  • Тёмная тема Смена оформления под OS/IDE.

  • Поиск и подсветка Быстрый поиск нужной папки или файла в дереве.

🤝 Участие в проекте

  1. Форкните репозиторий

  2. Создайте ветку:

    git checkout -b feature/имя-функции

  3. Внесите изменения и зафиксируйте коммит:

    git commit -am "Добавить новую функцию"

  4. Запушьте ветку и откройте pull request