كيف تنشئ مقتطفات الشيفرة وتديرها في VS Code

بقلم Sayaib Sarkarآخر تحديث قراءة في 3 دقيقة

في هذه الصفحة 5 قسم

الإجابة المختصرة: المقتطفات مدمجة في VS Code: شغّل Snippets: Configure Snippets، واختر لغة أو ملف مشروع، واكتب كل مقتطف بصيغة JSON مع prefix وbody. ولعمل أسرع، حدّد شيفرة واحفظها كمقتطف في ثوانٍ باستخدام Create Snippet في DevSnip Pro، واستخدم مقتطفاته ds- لـ Spring Boot وASP.NET Core وFastAPI وReact وNext.js وFlutter وSwiftUI.

المقتطف الجيد يوفّر أكثر من ضغطات المفاتيح. إنه يحفظ نسخة من نمط سبق أن صحّحته: معالج الأخطاء برموز الحالة الصحيحة، والاختبار بالإعداد الصحيح، وغلاف fetch الذي يتحقق من response.ok.

أين يحفظ VS Code المقتطفات

النطاقالملفاستخدمه من أجل
لغة واحدةtypescript.json في مجلد مقتطفات المستخدممقتطفات شخصية للغة واحدة
عام*.code-snippets في مجلد مقتطفات المستخدممقتطفات شخصية لعدة لغات
المشروع.vscode/*.code-snippets في المستودعمقتطفات الفريق، محفوظة مع الشيفرة

افتح أيًّا منها عبر Snippets: Configure Snippets (وفي الإصدارات الأقدم Preferences: Configure User Snippets) من لوحة الأوامر، Ctrl/Cmd+Shift+P.

اكتب مقتطفًا يدويًا

المقتطف إدخال مسمّى يضم النص الذي تكتبه (prefix)، والأسطر التي يدرجها (body)، وdescription اختياريًا يظهر في IntelliSense:

JSON
{
  "Express route handler": {
    "prefix": "exroute",
    "scope": "javascript,typescript",
    "body": [
      "router.${1|get,post,put,delete|}('/${2:path}', async (req, res, next) => {",
      "  try {",
      "    $0",
      "  } catch (err) {",
      "    next(err);",
      "  }",
      "});"
    ],
    "description": "Async Express route that passes errors to next()"
  }
}

الصيغة التي تجعل المقتطفات مفيدة:

  • $1 و$2 … هي نقاط التوقف: ينقلك Tab بينها، و$0 هو مكان انتهاء المؤشر.
  • ${1:path} هو عنصر نائب بنص افتراضي يمكنك الكتابة فوقه.
  • ${1|get,post,put,delete|} هو اختيار: قائمة منسدلة من القيم.
  • المتغيرات مثل $TM_FILENAME_BASE و$CURRENT_YEAR و$CLIPBOARD تدرج السياق. ويحوّل ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} ‏user-card إلى UserCard.
  • scope (في ملفات .code-snippets) يقصر المقتطف على بعض اللغات.

داخل body، اكتب $ الحرفية بالصيغة \\$، و} داخل العنصر النائب بالصيغة \\}.

احفظ مقتطفًا من الشيفرة المحددة

كتابة JSON يدويًا مع علامات الاقتباس المهرّبة هي الجزء البطيء. مع DevSnip Pro:

  1. حدّد الشيفرة التي تريد إعادة استخدامها.
  2. شغّل DevSnip Pro: Create Snippet.
  3. أدخل البادئة التي ستكتبها، واسمًا، ووصفًا اختياريًا.
  4. أعد تحميل النافذة عند الطلب. يحمّل VS Code المقتطفات المضافة عند بدء التشغيل.

يظهر المقتطف بعد ذلك في IntelliSense بتلك اللغة (39 لغة مدعومة). وإذا كانت البادئة مستخدمة في مقتطف آخر لديك، يُطلب منك التأكيد أولًا، فلا ينتهي بك الأمر بمقتطفين يظهران معًا. ويعرض DevSnip Pro: Saved Snippets كل ما حفظته ويحذف ما لم تعد تستخدمه.

استخدم مقتطفات أطر عمل جاهزة

اكتب ds- في ملف مدعوم، أو شغّل DevSnip Pro: Framework Snippets للاختيار من قائمة. هناك 56 مقتطفًا، وسّع VS Code كلًّا منها ثم تُرجم (وشُغّل حيث يسمح إطار العمل)، فهي تعمل كما تُدرج:

  • Spring Boot: ds-rest-controller وds-service وds-entity وds-repository وds-controller-advice وds-webmvctest وds-junit
  • ASP.NET Core: ds-minimal-api وds-api-controller وds-exception-handler وds-dbcontext وds-xunit وds-webapp-test
  • Python: ds-fastapi-app وds-fastapi-router وds-pydantic وds-flask-route وds-django-view وds-pytest وds-pytest-fixture
  • React وNext.js: ds-rfc وds-hook وds-context وds-next-page وds-next-route وds-server-action وds-rtl
  • TypeScript وNode.js: ds-express-router وds-express-error وds-zod وds-fetch-json وds-vitest
  • Flutter وSwiftUI: ds-stless وds-stful وds-future-builder وds-swiftui-view وds-view-model

ولـ Java وC#‎ وPython وSwift أيضًا مقتطف ds-logger. ينشئ المُسجّل الذي يستخدمه Insert Debug Log بعد ذلك لأسطر التصحيح.

حافظ على فائدة مجموعة مقتطفاتك

  • سمِّ البادئات بما تنتجه، لا بمصدرها: exroute أفضل من snippet3. والبداية المشتركة (مثل ds-) تجمعها في IntelliSense.
  • أبقِ المقتطفات صغيرة. المقتطف الذي يولّد ملفًا كاملًا يصعب تكييفه؛ وحين تحتاج إلى مورد كامل، يكون المولّد أنسب. ينشئ API Resource Scaffolder في DevSnip Pro واجهة CRUD موثّقة مع تقسيم الصفحات لـ Express أو NestJS أو Next.js أو Fastify أو Spring Boot أو ASP.NET Core أو FastAPI.
  • شارك مقتطفات الفريق عبر المستودع. يُدار ملف .vscode/project.code-snippets بالإصدارات ويُراجَع كالشيفرة، ويحصل عليه كل من يفتح المشروع.
  • نظّف. إذا لم تستخدم مقتطفًا منذ أشهر، فاحذفه ليسهل العثور على ما تستخدمه فعلًا.

جرّبه في محررك

مجاني، دون حساب، ويعمل محليًا. لـ VS Code 1.93 أو أحدث وبيئات JetBrains على Windows أو macOS أو Linux.

code --install-extension sayaib.hue-console