Эта статья вдохновлена ​​внутренним пакетом Remotion — улучшениями искусственного интеллекта. Этот внутренний пакет используется для улучшения/создания комментариев JSDoc и входа в консоль для функции в исходном коде Remotion.

Этот вариант использования совершенно другой, поскольку обычно вы используете исходный код и позволяете OpenAI генерировать документацию API, но вместо этого в Remotion этот внутренний пакет использует API OpenAI для генерации комментария JSDoc для функции с использованием документации API и исходного кода.

Мы подробно рассмотрим настройку этого пакета:

1. improve-docs.ts
2. генерировать-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 имеет вышеуказанный импорт. генерироватьJSDocTask импортируется из папки «задачи».

В зависимости от задачи можно либо сгенерировать JSDoc, либо найти ошибки.

Создать JSDoc

generate-jsdoc.ts использует API openai и содержит подсказки, как показано на изображении выше.

Обратите внимание, что при этом на консоль будет записан только сгенерированный JSDoc. Можно ли программно записать эти комментарии JSDoc в файл? Не уверен, но стоит прочитать документацию AST, чтобы узнать, есть ли какой-либо API для добавления комментариев JSDoc непосредственно над именем функции или класса. Известно, что ts-morph используется в shadcn-ui/ui для управления исходным кодом на уровне AST.

О нас:

сайт: 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