هذه المقالة مستوحاة من الحزمة الداخلية لـ Remotion، وهي تحسينات الذكاء الاصطناعي. تُستخدم هذه الحزمة الداخلية لتحسين/إنشاء تعليق JSDoc وتسجيل الدخول إلى وحدة التحكم لوظيفة في كود مصدر Remotion.

تختلف حالة الاستخدام هذه تمامًا لأنك تستخدم عادةً الكود المصدري وتسمح لـ OpenAI بإنشاء وثائق API ولكن بدلاً من ذلك في Remotion، تستخدم هذه الحزمة الداخلية OpenAI API لإنشاء تعليق JSDoc لوظيفة باستخدام وثائق API والكود المصدر.

سننظر على مستوى عالٍ في كيفية تكوين هذه الحزمة:

1. تحسين-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 على الواردات المذكورة أعلاه. يتم استيراد generatorJSDocTask من مجلد "المهام".

اعتمادًا على المهمة، يمكنك إما إنشاء ملف JSDoc أو العثور على الأخطاء.

قم بإنشاء ملف JSDoc

generate-jsdoc.ts يستخدم openai API ولديه مطالبات كما هو موضح في الصورة أعلاه.

يرجى ملاحظة أن هذا سيؤدي فقط إلى كتابة JSDoc الذي تم إنشاؤه على وحدة التحكم. هل من الممكن كتابة تعليقات JSDoc هذه برمجيًا في الملف؟ لست متأكدًا، ولكن من المفيد قراءة وثائق AST لمعرفة ما إذا كان هناك أي واجهة برمجة تطبيقات متاحة لإضافة تعليقات JSDoc أعلى اسم الوظيفة أو الفئة مباشرةً. من المعروف أن ts-morph يُستخدم في shadcn-ui/ui لمعالجة الكود المصدري على مستوى AST.

معلومات عنا:

الموقع الإلكتروني: https://thinkthroo.com/

جيثب: 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