CodeWeaver: автоматическая генерация документов в формате Markdown на основе структуры и содержания кода.

Последние ресурсы по искусственному интеллектуОпубликовано 6 месяцев назад Круг обмена ИИ

8.4K 00

Общее введение

CodeWeaver - это инструмент командной строки, предназначенный для объединения кодовой базы в единый, удобный для навигации документ в формате Markdown. Он генерирует структурированное представление файловой иерархии проекта путем рекурсивного сканирования каталогов и встраивания содержимого каждого файла в блоки кода. Инструмент разработан с целью упрощения обмена кодовой базой и извлечения информации, и особенно хорошо подходит для того, чтобы сделать информацию о кодовой базе доступной для обработки инструментами анализа кода AI/ML.

Вот пример генерации: https://github.com/tesserato/CodeWeaver/blob/main/codebase.md

Список функций

Полное создание документации по кодовой базе: Создайте файл в формате Markdown с подробным описанием структуры каталогов и файлов проекта в виде понятного дерева.
Встраивание кодового содержимого: Вставьте полное содержимое каждого файла в создаваемый документ Markdown с подсветкой синтаксиса на основе расширения файла.
Гибкая фильтрация путей: Используйте регулярные выражения для определения шаблонов игнорирования, которые позволяют исключить определенные файлы и каталоги (например, .git, продукты сборки, определенные типы файлов).
Дополнительное протоколирование маршрутов: Опция сохранения отдельных списков включенных и исключенных путей к файлам в файл для детального отслеживания и отладки правил игнорирования.
Простой интерфейс командной строки: Предоставляет интуитивно понятный интерфейс командной строки с простыми возможностями настройки.

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

Процесс установки

Установка с помощью Go

Если у вас установлена языковая среда Go, вы можете выполнить следующую команду для установки последней версии CodeWeaver:

go install github.com/tesserato/CodeWeaver@latest

Или установите указанную версию:

go install github.com/tesserato/CodeWeaver@vX.Y.Z

Загрузите предварительно скомпилированный исполняемый файл

Загрузите соответствующий предварительно скомпилированный исполняемый файл со страницы релиза.

При желании вы можете использоватьchmodчтобы дать исполняемому файлу разрешение на выполнение:

chmod +x codeweaver

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

Получение помощи

Выполните следующую команду для получения справочной информации:

codeweaver -h

практическое использование

Выполните следующую команду, чтобы создать документ:

codeweaver [options]

Описание опций

опции (как в настройках компьютерного программного обеспечения)	описания	значение по умолчанию
-dir	Корневой каталог, который будет сканироваться и регистрироваться.	Текущий каталог (...)
-вывод	Выводит имя файла Markdown.	codebase.md
-игнорировать ""	Список шаблонов регулярных выражений для исключения определенных путей, разделенный запятыми.	.git.*
-included-paths-file	Сохраняет файл, содержащий список путей в документе.	не иметь
-excluded-paths-file	Файл, содержащий список путей, исключенных в соответствии с правилом игнорирования.	не иметь
-help	Отобразите это справочное сообщение и выйдите.	не иметь

Пример использования

Создание документации для текущего каталога

./codeweaver

Эта команда создаст в текущем каталоге файл с именемcodebase.mdфайл, в котором записана структура и содержимое текущего каталога и его подкаталогов (исключение соответствует шаблону игнорирования по умолчанию).\.git.*(путь).

Укажите различные каталоги ввода и выходные файлы

./codeweaver -dir=my_project -output=project_docs.md

Эта команда обработаетmy_projectи сохраните документ в каталогеproject_docs.md.

Игнорировать определенные типы файлов и каталоги

./codeweaver -ignore="\.log,temp,build" -output=detailed_docs.md

В примере будет сгенерированdetailed_docs.mdисключая любые имена, содержащие.log, иtempвозможноbuildфайлов или каталогов. Шаблоны регулярных выражений разделяются запятыми.

Ведение списка включенных и исключенных путей

./codeweaver -ignore="node_modules" -included-paths-file=included.txt -excluded-paths-file=excluded.txt -output=code_overview.md

Эта команда создастcode_overview.mdсохраняя список включенных путей в файлеincluded.txtбудет обусловленоnode_modulesСписок путей, исключенных шаблоном игнорирования, сохраняется в файлеexcluded.txt.