CodeWeaver: Genera automáticamente documentos Markdown a partir de la estructura y el contenido del código.

Últimos recursos sobre IAPublicado hace 7 meses Círculo de intercambio de inteligencia artificial

10.7K 00

Introducción general

CodeWeaver es una herramienta de línea de comandos diseñada para tejer una base de código en un único documento Markdown fácil de navegar. Genera una representación estructurada de la jerarquía de archivos de un proyecto explorando recursivamente los directorios e incrustando el contenido de cada archivo en bloques de código. La herramienta está diseñada con el objetivo de simplificar el intercambio de código base y la extracción de información, y es especialmente adecuada para poner la información del código base a disposición de las herramientas de análisis de código AI/ML para su procesamiento.

He aquí un ejemplo de generación: https://github.com/tesserato/CodeWeaver/blob/main/codebase.md

Lista de funciones

Generación exhaustiva de documentación sobre la base de códigoGenerar un archivo Markdown detallando la estructura de directorios y archivos del proyecto en un formato de árbol claro.
Incrustación de contenidos en código: Incrusta el contenido completo de cada archivo en el documento Markdown generado, con resaltado de sintaxis basado en la extensión del archivo.
Filtrado flexible de rutas: Defina patrones de ignorar utilizando expresiones regulares para permitir la exclusión de archivos y directorios específicos (por ejemplo, .git, productos de compilación, tipos de archivos específicos).
Registro opcional de rutasOpción de guardar listas separadas de rutas de archivos incluidas y excluidas en un archivo para el seguimiento detallado y la depuración de las reglas de ignorar.
Interfaz de línea de comandos sencilla: Ofrece una interfaz de línea de comandos intuitiva con opciones de personalización sencillas.

Utilizar la ayuda

Proceso de instalación

Instalación con Go

Si ha instalado el entorno de lenguaje Go, puede ejecutar el siguiente comando para instalar la última versión de CodeWeaver:

go install github.com/tesserato/CodeWeaver@latest

O instale la versión especificada:

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

Descargar el ejecutable precompilado

Descargue el ejecutable precompilado adecuado de la página de la versión.

Si lo desea, puede utilizar la funciónchmodpara dar permiso de ejecución al archivo ejecutable:

chmod +x codeweaver

Proceso de utilización

Obtener ayuda

Ejecute el siguiente comando para obtener información de ayuda:

codeweaver -h

uso práctico

Ejecute el siguiente comando para generar el documento:

codeweaver [options]

Descripción de las opciones

opciones (como en la configuración de programas informáticos)	descripciones	valor por defecto
-dir	El directorio raíz que se escaneará y registrará.	Directorio actual (...)
-salida	Muestra el nombre del archivo Markdown.	codebase.md
-ignorar ""	Lista separada por comas de patrones de expresión regular de rutas para excluir rutas específicas.	.git.*
-archivo-rutas-incluidas	Guarda el archivo que contiene la lista de rutas del documento.	no tener
-excluded-paths-file	Archivo que contiene la lista de rutas excluidas debido a la regla de ignorar.	no tener
-ayuda	Mostrar este mensaje de ayuda y salir.	no tener

ejemplo de uso

Generar documentación para el directorio actual

./codeweaver

Este comando creará un archivo en el directorio actual llamadocodebase.mdque registra la estructura y el contenido del directorio actual y sus subdirectorios (excluir coincide con el patrón de ignorar predeterminado).\.git.*(el camino).

Especifique diferentes directorios de entrada y archivos de salida

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

Este comando procesará elmy_projecty guarde el documento en el directorioproject_docs.md.

Ignorar determinados tipos de archivos y directorios

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

El ejemplo generarádetailed_docs.mdexcluyendo cualquier nombre que contenga.logytemptal vezbuildde archivos o directorios. Los patrones de expresiones regulares se separan por comas.

Mantener una lista de rutas incluidas y excluidas

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

Este comando creará elcode_overview.mdmientras se guarda la lista de rutas incluidas enincluded.txtse deberá anode_modulesLa lista de rutas excluidas por el patrón de ignorar se guarda en el archivoexcluded.txt.