Este artículo está inspirado en el paquete interno de Remotion, ai-improvements. Este paquete interno se utiliza para mejorar/generar comentarios JSDoc e iniciar sesión en la consola para una función en el código fuente de Remotion.

Este caso de uso es bastante diferente porque normalmente usarías el código fuente y dejarías que OpenAI genere documentación API, pero en Remotion, este paquete interno usa la API OpenAI para generar comentarios JSDoc para una función usando documentación API y el código fuente.

Veremos a alto nivel cómo se configura este paquete:

1. mejorar-docs.ts
2. generar-jsdoc

Mejorar documentos

import path from "path";
import { OpenAI } from "openai";
import { getApis } from "./map-over-api";
import { findMistakes } from "./tasks/find-mistakes";
import { generateJSDocTask } from "./tasks/generate-jsdoc";

improve-docs.ts tiene las importaciones anteriores. generateJSDocTask se importa desde la carpeta 'tareas'.

dependiendo de la tarea, puedes generar un JSDoc o encontrar errores.

Generar JSDoc

generate-jsdoc.ts usa la API openai y tiene indicaciones como se muestra en la imagen de arriba.

Tenga en cuenta que esto solo escribirá el JSDoc generado en la consola. ¿Sería posible escribir estos comentarios JSDoc mediante programación en el archivo? No estoy seguro, pero vale la pena leer la documentación de AST para ver si hay alguna API disponible para agregar comentarios JSDoc justo encima del nombre de la función o clase. Se sabe que ts-morph se usa en shadcn-ui/ui para manipular el código fuente a nivel AST.

Sobre nosotros:

sitio web: https://thinkthroo.com/

Github: https://github.com/thinkthroo/thinkthroo (¡Danos una estrella!)

Crea proyectos de código abierto desde cero de forma gratuita

Mejora las habilidades de codificación de tu equipo.

¿Necesitas ayuda con un proyecto? Contáctenos en [email protected]

Referencias:

https://github.com/remotion-dev/remotion/tree/main/packages/ai-improvements

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/improve-docs.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/generate-jsdoc.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/tasks/find-mistakes.ts

https://github.com/remotion-dev/remotion/blob/main/packages/ai-improvements/map-over-api.ts

https://github.com/remotion-dev/remotion/blob/main/packages/docs/src/data/articles.ts