rescript vscode

صمم vscode

المكون الإضافي الرسمي VSCODE للرسالة

محتويات

• المتطلب السابق
• ؟ مواضيع مدعومة
• سمات
• ؟ تثبيت
• ؟ الأوامر
• ؟ إعدادات
• محلل الكود
  • تكوين محلل الرمز
  • الاستخدام
  • تحذيرات
• ؟ نصائح وحيل
  • إخفاء الملفات التي تم إنشاؤها
• ⌨ استخدم مع المحررين الآخرين
• ؟ Changelog
• ؟ كيفية المساهمة
• ؟ رخصة

المتطلب السابق

يجب أن يكون لديك Rescript> = 9.1 مثبتًا محليًا في مشروعك ، من خلال تثبيت NPM المعتاد أو الغزل. الإصدارات القديمة ليست مضمونة للعمل.

؟ مواضيع مدعومة

يعمل تسليط الضوء لدينا بشكل جيد مع موضوعات VSCode الأكثر شعبية ، مثل:

• Dark+ (افتراضي الظلام) ، الضوء+ (الضوء الافتراضي)
• ضوء الظلام الشمسي الشمسي
• مونوكاي باهت
• ليلة الغد الأزرق
• مؤيد مظلم واحد

الموضوعان الوحيدان الذي لا ندعمهما (ولا يمكننا) ، بسبب افتقارهم للتلوين ، هما:

• Dark (Visual Studio) ، Light (Visual Studio)

لاحظ أنه إذا لم يبرز موضوعك المخصص كثيرًا (على سبيل المثال ، لا توجد ألوان لعلامة JSX العلوية ، فلا تمييز بين الوحدة النمطية والبديل) ، جرب أحد الموضوعات الموصى بها لمعرفة ما إذا كانت هذه هي المشكلة. لمزيد من المعلومات ، راجع هذا المنشور.

سمات

• يدعم .res ، .resi ، rescript.json وملف التكوين القديم bsconfig.json .
• بناء جملة تسليط الضوء.
• التنسيق.
• بناء التشخيص.
• مراقب BSB مدمج (اختياري ، ويتعرض بشكل صريح باعتباره منبثقة ، لا تقلق من البناء المتدلي).
• اكتب تلميح تحوم.
• القفز إلى التعريف.
• الإكمال التلقائي.
• العثور على المراجع.
• إعادة تسمية.
• تلميحات البطانة.
• مساعدة التوقيع.
• عدسات رمز.
• قصاصات لتخفيف بعض الجملة:
  • الميزات external مثل @bs.module و @bs.val
  • try ، for .
• طي ، وقابل للطي مخصص من خلال //#region و //#endregion .

؟ تثبيت

قم بتشغيل VS Code Quick Open ( Ctrl+P ) ، والصق الأمر التالي ، واضغط على Enter.

 ext install chenglou92.rescript-vscode

يتم تنشيط البرنامج المساعد على ملفات .res و .resi . إذا كنت قد تم تثبيت خادم باللغة الأسباب بالفعل ، فمن الممكن أن يكون الأخير له الأسبقية على هذا. تأكد من أنك تستخدم هذا المكون الإضافي ("بناء جملة الدقة") بدلاً من خادم الأسباب ("Bucklescript Syntax").

قناة ما قبل الإصدار

هناك قناة قبل الإصدار متاحة. إنه مخصص لاختبار ميزات جديدة وبالتالي ربما غير مستقرة. يمكنك تنشيطه من خلال النقر فوق الزر "Switch to-release إصدار" على صفحة تمديد rescript-vscode في VScode. من هذه النقطة فصاعدًا ، سيكون لدى إصدارات ما قبل الإصدار دائمًا إصدارًا غريبًا (1.5.x ، 1.7.x ، 2.1.x ، وما إلى ذلك) في حين أن الإصدارات المستقرة لها أرقام بسيطة (1.4.x ، 1.6.x ، 2.0.0 ، إلخ).

حتى إذا كانت قناة ما قبل الإصدار تبدو تجريبية للغاية بالنسبة لك ، فإننا ما زلنا نقترح عليك أن تجربها وتقديم أي مشكلات تواجهها. على المدى الطويل ، سيعطينا تجربة تحرير أفضل بشكل عام.

؟ الأوامر

يأمر	وصف
صمم: قم بإنشاء ملف واجهة لملف التنفيذ هذا	يقوم بإنشاء ملف واجهة ( .resi ) لملف .res الحالي ، وملء جميع الأنواع والقيم تلقائيًا في الملف الحالي.
صمم: افتح ملف JS المترجم لهذا ملف التنفيذ هذا	يفتح ملف JS المترجمة لملف الرصيد الحالي.
صمم: تبديل التنفيذ/الواجهة	المفاتيح بين ملف التنفيذ وملف الواجهة. إذا كنت في ملف .res ، فسيقوم الأمر بفتح ملف .resi المقابل (إذا كان موجودًا) ، وإذا كنت في ملف .resi ، فسوف يفتح الأمر ملف .res المقابل. يمكن أيضًا تشغيل هذا مع Alt+O keybinding.
صمم: محلل رمز البدء	سيؤدي ذلك إلى بدء تحليل التعليمات البرمجية في المشروع الدائم للملف الذي تقوم بتشغيل الأمر منه.

؟ إعدادات

ستجد جميع الإعدادات المحددة للرسالة تحت Scope rescript.settings .

جلسة	وصف
موجه لبدء البناء	إذا لم يكن هناك بناء مستند يعمل بالفعل في المشروع المفتوح ، فسيطلب منك الامتداد ويسأل عما إذا كنت تريد بدء إنشاء تلقائيًا. يمكنك إيقاف تشغيل هذه المطالبة التلقائية عبر الإعداد rescript.settings.askToStartBuild .
مسار ثنائي	سيبحث الامتداد عن وجود ملف node_modules/.bin/rescript ويستخدم دليله باعتباره binaryPath . إذا لم يجدها في جذر المشروع (وهو المكان الذي يقيم فيه أقرب rescript.json ) ، فإنه يرتفع مجلدات في نظام الملفات بشكل متكرر حتى يجدها (غالبًا ما تكون في Monorepos) أو يضرب المستوى العلوي. لتجاوز عملية البحث هذه ، يمكن تكوين المسار بشكل صريح باستخدام الإعداد rescript.settings.binaryPath
مسار النظام الأساسي	سيبحث الامتداد عن وجود دليل node_modules/rescript ويستخدم الدليل الفرعي المقابل للمنصة الحالية platformPath . إذا لم يجدها في جذر المشروع (وهو المكان الذي يقيم فيه أقرب rescript.json ) ، فإنه يرتفع مجلدات في نظام الملفات بشكل متكرر حتى يجدها (غالبًا ما تكون في Monorepos) أو يضرب المستوى العلوي. لتجاوز عملية البحث هذه ، يمكن تكوين المسار بشكل صريح باستخدام الإعداد rescript.settings.platformPath
تلميحات البطانة (تجريبية)	يتيح ذلك للمحرر وضع التعليقات التوضيحية مع النص لعرض تلميحات نوع. تمكين استخدام rescript.settings.inlayHints.enable: true
عدسة الكود (تجريبية)	هذا يخبر المحرر بإضافة عدسات رمز لتعريفات وظائف ، مما يدل على نوعه الكامل فوق التعريف. تمكين استخدام rescript.settings.codeLens: true
مساعدة التوقيع	هذا يطلب من المحرر إظهار مساعدة التوقيع عندما تكتب مكالمات الوظائف. تمكين استخدام rescript.settings.signatureHelp.enabled: true

الإعدادات الافتراضية:

 // Whether you want the extension to prompt for autostarting a ReScript build if a project is opened with no build running
"rescript.settings.askToStartBuild" : true ,

// Path to the directory where cross-platform ReScript binaries are. You can use it if you haven't or don't want to use the installed ReScript from node_modules in your project.
"rescript.settings.binaryPath" : null

// Path to the directory where platform-specific ReScript binaries are. You can use it if you haven't or don't want to use the installed ReScript from node_modules in your project.
"rescript.settings.platformPath" : null

// Enable (experimental) inlay hints.
"rescript.settings.inlayHints.enable" : true

// Maximum length of character for inlay hints. Set to null to have an unlimited length. Inlay hints that exceed the maximum length will not be shown
"rescript.settings.inlayHints.maxLength" : 25

// Enable (experimental) code lens for function definitions.
"rescript.settings.codeLens" : true 

محلل الكود

محلل التعليمات البرمجية هو وضع في الامتداد الذي يقوم بتحليل رمز إضافي في مشروعك. يساعدك التحليل في العثور على الكود الميت على مستوى محبب ، والعثور على استثناءات غير معطلة ، وأكثر من ذلك.

يستخدم محلل التعليمات البرمجية Reanalyze ، وهو مضمن في الامتداد ، لذلك لا تحتاج إلى تثبيت أي شيء إضافي لتشغيله.

تكوين محلل الرمز

ستحتاج إلى تكوين تحليل التعليمات البرمجية التي تريد تشغيلها ، وما هي (إن وجدت) التي تريد تجاهلها. يتم التكوين عن طريق إضافة reanalyze في rescript.json . ستحصل على الإكمال التلقائي لما هي خيارات التكوين صالحة. يمكنك أيضًا قراءة كل شيء عن تكوين reanalyze هنا.

الاستخدام

افتح لوحة الأوامر وقم بتشغيل ReScript: Start Code Analyzer . سيؤدي ذلك إلى بدء تحليل التعليمات البرمجية في المشروع الدائم للملف الذي تقوم بتشغيل الأمر منه.

تم تمييز الكود الميت في المحرر ، وتتوفر إجراءات رمز لقمع تحذيرات الكود الميت في معظم الحالات.

عند الانتهاء ، أوقف وضع تحليل التعليمات البرمجية بالنقر فوق زر Stop Code Analyzer في شريط حالة المحرر. هذا سوف يزيل جميع تحذيرات التحليل المبلغ عنها.

تحذيرات

حاليًا لا يعمل في تحليل الكود الميت الكامل Monorepo (على الرغم من أنه يجب أن يعمل مع كل حزمة Monorepo بشكل فردي).

؟ نصائح وحيل

إخفاء الملفات التي تم إنشاؤها

يمكنك تكوين VSCODE لانهيار مستخدم ملفات JavaScript التي يتم إنشاؤها ضمن ملف مصدرها المصدر. سيؤدي ذلك إلى "إخفاء" الملفات التي تم إنشاؤها في مستكشف ملف VSCODE ، ولكن لا يزال يتركها في متناولها عن طريق توسيع ملف مصدر المصدر الذي ينتمون إليه.

افتح إعدادات VSCode الخاصة بك واكتب:

 "explorer.fileNesting.enabled" : true ,
"explorer.fileNesting.patterns" : {
  "*.res" : "${capture}.mjs, ${capture}.js, ${capture}.cmi, ${capture}.cmt, ${capture}.cmj" ,
  "*.resi" : "${capture}.res"
} ,

تنطوي هذه التطبيقات تحت الواجهات في حالة وجودها وتتويش جميع الملفات التي تم إنشاؤها تحت ملف الرسم الرئيسي. التكيف والتعديل حسب رغبتك.

لقطة شاشة للنتيجة:

؟ Changelog

انظر Changelog

؟ كيفية المساهمة

اقرأ دليلنا المساهم

؟ رخصة

انظر ملف الترخيص للحصول على التفاصيل.