الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

ابدأ | موقع إلكتروني

ارتكاب الوبر رسائل

التوضيح الذي تم إنشاؤه باستخدام SVG-Term-Cli

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

  • كن commitizen جيدًا

  • مشاركة التكوين عبر npm

  • الاستفادة من conventional-changelog

محتويات

  • ابدأ | موقع إلكتروني

    • تثبيت وتشغيل

    • الإصدارات

    • فوائد استخدام الالتزام

    • محتويات

    • ما هو الالتزام

    • ابدء

    • CLI

    • تكوين

    • التكوين المشترك

    • الوثائق

    • API

    • أدوات

    • خريطة الطريق

    • دعم الإصدار والإصدارات

    • المشاريع ذات الصلة

    • رخصة

    • تطوير

ما هو الالتزام

Commiclelint يتحقق مما إذا كانت رسائل الالتزام الخاصة بك تفي بتنسيق الالتزام التقليدي.

بشكل عام ، يبدو النمط في الغالب مثل هذا:

 النوع (النطاق؟): الموضوع #Scope اختياري ؛ يتم دعم نطاقات متعددة (خيارات المحدد الحالية: "/" ، "" و "،")

يمكن أن تبدو أمثلة العالم الحقيقي هكذا: 

chore: run tests on travis ci
fix(server): send cors headers
feat(blog): add comment section

يمكن أن تكون الأنواع الشائعة وفقًا لـ Mancelint-Config-Cernvivers (استنادًا إلى الاتفاقية الزاوية):

  • يبني

  • عمل روتيني

  • CI

  • مستندات

  • العمل الفذ

  • يصلح

  • Perf

  • Refactor

  • يرجع

  • أسلوب

  • امتحان

يمكن تعديل هذه عن طريق التكوين الخاص بك.

فوائد استخدام الالتزام

  • لماذا تستخدم الالتزامات التقليدية؟

  • "امتيازات الالتزام بالاتفاقيات" (شرائح الحديث)

ابدء

  • الإعداد المحلي - رسائل LINT على الالتزام مع Husky

  • CI Setup - رسائل LINT أثناء بناء CI

CLI

  • الطريقة الأولية للتفاعل مع الالتزام.

  • npm install --save-dev @commitlint/cli

  • الحزم: CLI

تكوين

  • يتم التقاط التكوين من:

    • .commitlintrc

    • .commitlintrc.json

    • .commitlintrc.yaml

    • .commitlintrc.yml

    • .commitlintrc.js

    • .commitlintrc.cjs

    • .commitlintrc.mjs

    • .commitlintrc.ts

    • .commitlintrc.cts

    • commitlint.config.js

    • commitlint.config.cjs

    • commitlint.config.mjs

    • commitlint.config.ts

    • commitlint.config.cts

    • commitlint Field في package.json

    • حقل commitlint في package.yaml

  • الحزم: CLI ، CORE

  • انظر قواعد للحصول على قائمة كاملة بالقواعد الممكنة

  • يمكن العثور على تكوين مثال على @commiclint/confignvental

التكوين المشترك

يتوفر عدد من التكوينات المشتركة للتثبيت والاستخدام مع commitlint :

  • @complint/config-angular

  • @commiclint/config-conventional

  • @commiclint/config-lerna-scopes

  • @commiclint/config-nx-scopes

  • @commiclelint/config-paternplate

  • التقليدية changelog-lint-config-atom

  • التقليدية changelog-lint-config-canonical

️ إذا كنت ترغب في نشر التكوين القابل للمشاركة الخاص بك ، فتأكد من أن لديه اسمًا يتماشى مع اسم النمط commitlint-config-emoji-log أو commitlint-config-your-config-name ثم في تمديد كل ما عليك أن تكتبه هو emoji-log أو your-config-name .

الوثائق

تحقق من الموقع الرئيسي.

API

  • طريقة بديلة وبرنامٍ للتفاعل مع commitlint

  • الحزم:

    • التنسيق - تنسيق تقارير الالتزام

    • LINT - LINT سلسلة ضد قواعد الالتزام

    • تحميل - تحميل تكوين الالتزام المشترك

    • قراءة - اقرأ رسائل الالتزام من نطاق محدد أو تحرير آخر

  • انظر API للحصول على قائمة كاملة بالطرق والأمثلة

أدوات

  • محول الالتزام

  • اِسْتَدْعَى

خريطة الطريق

يعتبر commitlint مستقرًا ويستخدم في مختلف المشاريع كأداة تنمية.

الأفكار : التقليدية التقليدية/الالتزام#94

دعم الإصدار والإصدارات

  • node.js lts >= 18

  • git >= 2.13.2

الإصدارات

سيتم تطبيق بقع الأمان على الإصدارات التي لم تتم بعد EOL.
سيتم تطبيق الميزات فقط على الإصدار الرئيسي الحالي.

يطلق الإصدار الأولي
V19 02/2024
V18 10/2023

عادة ما يكون EOL بعد حوالي عام.

نحن لسنا مشروع OSS برعاية. لذلك لا يمكننا أن نعد بأننا سنقوم بإصدار إصدارات تصحيح للإصدارات القديمة في الوقت المناسب.
إذا كنت عالقًا في إصدار أقدم وتحتاج إلى تصحيح أمان ، فنحن سعداء إذا كان بإمكانك تقديم علاقات عامة.

المشاريع ذات الصلة

  • التغير التقليدي يولد Changelog من تاريخ الالتزام التقليدي

  • الالتزام بالاتفاقيات البسيطة للمواطنين على الإنترنت

  • إنشاء وحدة CLI للوحدة الدلالية لدمج الالتزام والالتزام بسرعة في مشاريع جديدة أو حالية

رخصة

حقوق الطبع والنشر بواسطة marionebl. يتم إصدار جميع حزم commitlint تحت رخصة معهد ماساتشوستس للتكنولوجيا.

تطوير

تم تطوير commitlint في مستودع أحادي.

تثبيت وتشغيل

 git clone [email protected]: التقليدية changelog/commiclelint.gitcd الالتزام
غزل
yarn Run Build # Run Build Tasksyarn Start # Run Tests ، مرة أخرى على changeyarn Run Communlint # Run Cli

لمزيد من المعلومات حول كيفية المساهمة ، يرجى إلقاء نظرة على دليل المساهمة لدينا.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل