이 글은 Remotion의 내부 패키지인 ai-Improvement에서 영감을 받았습니다. 이 내부 패키지는 JSDoc 주석을 개선/생성하고 Remotion 소스 코드의 기능에 대한 콘솔에 로그인하는 데 사용됩니다.

이 사용 사례는 일반적으로 소스 코드를 사용하고 OpenAI가 API 문서를 생성하도록 허용하지만 대신 Remotion에서 이 내부 패키지는 OpenAI API를 사용하여 API 문서 및 소스 코드를 사용하는 함수에 대한 JSDoc 주석을 생성하기 때문에 상당히 다릅니다.

이 패키지가 어떻게 구성되어 있는지 개략적으로 살펴보겠습니다.

1. improve-docs.ts
2. generate-jsdoc

문서 개선

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에는 위의 가져오기가 있습니다. generateJSDocTask를 'tasks' 폴더에서 가져옵니다.

작업에 따라 JSDoc을 생성하거나 실수를 찾을 수 있습니다.

JSDoc 생성

generate-jsdoc.ts는 openai API를 사용하며 위 이미지와 같은 프롬프트가 표시됩니다.

생성된 JSDoc만 콘솔에 기록한다는 점에 유의하세요. 이러한 JSDoc 주석을 파일에 프로그래밍 방식으로 작성할 수 있습니까? 확실하지는 않지만, 함수나 클래스 이름 바로 위에 JSDoc 주석을 추가하는 데 사용할 수 있는 API가 있는지 알아보려면 AST 문서를 읽어 볼 가치가 있습니다. ts-morph는 AST 수준에서 소스 코드를 조작하기 위해 shadcn-ui/ui에서 사용되는 것으로 알려져 있습니다.

회사 소개:

웹사이트: https://thinkthroo.com/

Github: https://github.com/thinkthroo/thinkthroo (별표를 주세요!)

오픈소스 프로젝트를 처음부터 무료로 구축

팀 코딩 기술을 향상하세요.

프로젝트에 도움이 필요하신가요? [email protected]으로 연락주세요

참고자료:

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