Este artigo é inspirado no pacote interno do Remotion, melhorias de IA. Este pacote interno é usado para melhorar/gerar comentários JSDoc e logar no console para uma função no código-fonte do Remotion.

Este caso de uso é bem diferente porque você normalmente usaria o código-fonte e deixaria o OpenAI gerar documentação da API, mas em vez disso, no Remotion, este pacote interno usa a API OpenAI para gerar comentários JSDoc para uma função usando a documentação da API e o código-fonte.

Veremos em alto nível como este pacote é configurado:

1. melhorar-docs.ts
2. gerar-jsdoc

Melhorar 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 tem as importações acima. generateJSDocTask é importado da pasta ‘tarefas’.

dependendo da tarefa, você pode gerar um JSDoc ou encontrar erros.

Gerar JSDoc

generate-jsdoc.ts usa a API openai e possui prompts conforme mostrado na imagem acima.

Observe que isso apenas gravará o JSDoc gerado no console. Seria possível escrever esses comentários JSDoc programaticamente no arquivo? Não tenho certeza, mas vale a pena ler a documentação do AST para ver se há alguma API disponível para adicionar comentários JSDoc logo acima do nome da função ou classe. Sabe-se que ts-morph é usado em shadcn-ui/ui para manipular o código-fonte no nível AST.

Sobre nós:

site: https://thinkthroo.com/

Github: https://github.com/thinkthroo/thinkthroo (Dê-nos uma estrela!)

Crie projetos de código aberto do zero gratuitamente

Melhore as habilidades de codificação da sua equipe.

Precisa de ajuda com um projeto? Contate-nos em [email protected]

Referências:

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