Asistente de refactorización (Refactor Assistant)
Abrir la aplicación: Planifica una refactorización → (products.documentize.ai)
En una frase
Refactor Assistant escanea un repositorio de C# en GitHub en busca de clases sobredimensionadas que esconden responsabilidades distintas, las ordena y, cuando tú lo decides, extrae las partes elegidas a clases nuevas y abre un pull request.
Qué lo hace único
Funciona en dos pasos separados con una decisión humana en medio. Scan (llamado «suggest») es de solo lectura y no cambia nada. Apply extrae después únicamente las «costuras» (seams) que hayas puesto en la cola. De cada clase se muestran sus costuras (una costura es una responsabilidad oculta que podría salir de la clase), una puntuación y un veredicto, así que decides con pruebas en la mano y no dejas que una IA reescriba lo que le parezca.
Cuándo usarlo y cuándo no
- Úsalo en clases de C# que han crecido hasta convertirse en clases que «lo hacen todo» y para las que quieres una lista corta ordenada de qué dividir.
- No sirve para documentación → Documentos del repositorio (Repo Docs). No sirve para un mapa estructural completo → Code Graph.
- No sirve para lenguajes que no sean C#.
- No sirve como comprobación de compilación. La página lo dice con claridad: Documentize nunca compila ni ejecuta tu código, así que tu CI sobre el pull request es la comprobación de compilación.
Antes de empezar
- Un repositorio de GitHub (
owner/nameo URL) con código C#. Repositorio privado: da antes acceso aarise-project, como indica la sugerencia de la página. - Para Apply: debes haber iniciado sesión, y la página dice que Apply requiere un plan de pago y tarda de 10 a 30 minutos por costura.
- Privacidad: el código se lee para analizarlo; Apply escribe una rama y un pull request como
arise-project. Considera que el repositorio queda compartido con esa cuenta y con el servicio de modelo de lenguaje que se usa en el análisis (comprueba el flujo exacto de datos en la aplicación en funcionamiento).
Paso a paso
- Escribe el repositorio de GitHub y, si quieres, una rama.
- Elige cuántos candidatos mostrar (10, 25 o 50), o escribe el nombre de una clase que inspeccionar (opcional).
- Ejecuta el escaneo. Lee los mosaicos (clases escaneadas, candidatos, costuras encontradas, ya refactorizado, rechazado, demasiado grande) y la lista.
- Filtra por proyecto o por veredicto, abre una clase para ver su esquema y abre cada costura: puntuación, cohesión, puntos de llamada que delegar, qué se mueve con ella y qué se queda atrás.
- Vista previa del plan: el contrato con el que se escribe la clase nueva y lo que se mueve. Aún no se genera nada.
- Agregar a la cola de aplicación las costuras que quieras (como máximo 5 por ejecución), elige Una solicitud de extracción, un commit por costura o Una solicitud de extracción por costura y pulsa Aplicar.
- Sigue los pasos (Plan, Contrato, Generar, Arreglar bucle, Construir, Revisión, Confirmar) y abre el pull request. Usa tu CI para compilarlo.
Opciones explicadas
| Opción | Qué hace | Valor por defecto | Recomendado |
|---|---|---|---|
| Rama | Rama que se analiza y contra la que se abre el pull request | rama predeterminada | Usa una rama estable |
| Candidatos a mostrar | Tamaño de la lista ordenada: 10, 25 o 50 | 10 | Empieza con 10 |
| Inspeccionar una clase (opcional) | Escanea solo una clase y muestra todas sus costuras, también las ya resueltas | vacío | Cuando ya sospechas de una clase |
| Veredicto (filtro) | Vale la pena dividir, Infraestructura, Demasiado aplanado, Resuelto, No juzgado | todos | Empieza con «Vale la pena dividir» |
| Proyecto (filtro) | Limita la lista a un proyecto | todos | Úsalo en soluciones grandes |
| Modo (Apply) | Un pull request con un commit por costura, o un pull request por costura en su propia rama | un PR | Un PR por costura si tu equipo revisa en trozos pequeños |
Qué obtienes
- Scan: un informe en la página, guardado como una ejecución que puedes reabrir. También hay un Historial de todo lo decidido sobre el repositorio (rechazado, propuesto, extraído), visible cuando has iniciado sesión.
- Apply: un pull request con las clases extraídas, con un resumen de archivos y comprobaciones. Resultados por costura: En la solicitud de extracción, No vale la pena una reseña, Falló, Omitido, No iniciado, Tiempo agotado. Si no se conservó nada, no se abre ningún pull request.
Calidad y límites
- Scan es solo análisis; Apply es código generado por IA, no compilado por Documentize. Revisa cada pull request y deja que el CI se ejecute antes de fusionar.
- Scan tiene un límite de tiempo; un repositorio demasiado grande para escanearlo a tiempo se rechaza con un mensaje. Apply tarda varios minutos por costura.
- Como máximo 5 costuras por ejecución de Apply.
Funciona bien con
- Ejecuta antes de esta aplicación: Code Graph para ver la forma de la solución.
- Ejecuta después de esta aplicación: Documentos del repositorio (Repo Docs) para documentar la nueva estructura.
- Relacionado: Confianza, verificación y límites de lo que produce la IA.
Errores frecuentes y soluciones
- «Choose at least one seam» → escanea primero, pon una costura en la cola y luego pulsa Apply.
- «At most 5 seams» → deja el resto en la cola para una segunda ejecución.
- «A seam reference is not valid» → el resultado está obsoleto; vuelve a escanear.
- Esperar un resultado compilado → el pull request es código propuesto; tu CI es la compilación.
- «Este resultado ya no está disponible» → vuelve a escanear.
Lo mismo en otros canales
No verificado para esta aplicación. Consulta canales.
Pruébalo
Escanea un repositorio público de C# con Candidatos a mostrar = 10. Abre la clase de arriba marcada como «Vale la pena dividir», lee su primera costura y pulsa Vista previa del plan. No lo apliques; juzga si la división propuesta coincide con cómo habrías cortado tú la clase.