codeclimate haml lint

كود مناخ محرك هامل لين

هل أردت يومًا أن تعرف بالضبط مدى جودتك في كتابة Haml المتسقة؟ حسنا لا أكثر! باستخدام محرك Code Climate Engine ، يمكنك تسخير قوة Haml-Lint لتسجيل الكود الخاص بك.

تريد المساعدة؟

مذهل! نحن نسعى جاهدين للترحيب بالجميع. تحقق من دليل المساهمة وتأكد من قراءة مدونة قواعد السلوك الخاصة بنا.

هل تحتاج إلى بعض المساعدة؟

للحصول على مساعدة مع Haml-Lint ، تحقق من وثائقهم.

إذا كنت تواجه مشكلة مناخ رمز ، تحقق أولاً من [وثائق المحرك] [#الاستخدام] وابحث عن أي مشكلات موجودة ، لأن سؤالك قد يكون قد تمت تغطيته بالفعل. إذا لم يكن الأمر كذلك ، يرجى فتح مشكلة وسنرى ما يمكننا القيام به للمساعدة.

تثبيت

نظرًا لأن هذا ليس محركًا تم إصداره بشكل علني حتى الآن ، فسيتعين عليك إنشاء المحرك من هذا المستودع. ستحتاج إلى تثبيت CODE CLIMATE CLI ، وكذلك git make الأوامر.

1. إذا لم تقم بالفعل ، قم بتثبيت Code Climate CLI.
2. إذا لم يكن لديك git ، فقم بتثبيته.
3. إذا لم يكن لديك make ، قم بتثبيته. على جهاز Mac ، يمكنك الحصول عليه باستخدام Xcode. على Linux ، يمكنك الحصول عليها في Manager Package (الحزمة build-essential في Ubuntu أو حزمة base-devel على Arch Linux). على Windows ، ربما تحتاج إلى Cygwin أو نظام Linux الفرعي لنظام التشغيل Windows.
4. اصنع حاوية Docker للمحرك مع make .

إذا فشلت الحاوية في الإنشاء ، قم بتقديم مشكلة.

يجب أن تكون قادرًا الآن على استخدام المحرك من خلال Code Climate CLI كمحرك على مستوى التطوير. لاستخدامه في مشروعك ، انتقل أولاً إلى دليل مشروعك. ثم استخدم الأمر التالي:

 $ codeclimate analyze -e haml-lint --dev

الاستخدام

مثل محركات Code Code الأخرى ، يمكنك تكوين هذا واحد من خلال استخدام ملف .codeclimate.yml في دليل الجذر لمشروعك. إذا لم يكن لديك بالفعل واحدة ، فيمكنك استخدام codeclimate engines:enable haml_lint لإنشاء ملف .codeclimate.yml الأساسي مع تمكين المحرك.

إذا كنت لا تهتم بتعديل التكوين الخاص بك ، فيجب أن تكون قادرًا الآن على تشغيل المحرك باستخدام أمر التحليل:

 $ codeclimate analyze

لتعديل المبيدات التي سيتم تشغيل Haml-Lint ، اتبع هذا النمط في ملف التكوين:

 engines :
  haml-lint :
    enabled : true
    config :
      file : my_custom_haml_lint.yml
    checks :
      HamlLint/AltText :
        enabled : false
      HamlLint/RuboCop :
        include :
          - lib/project_name/**/*.rb
        exclude :
          - spec/**/*.rb
exclude_paths :
  - ignored_directory/

يعيش معظم التكوين ضمن engines.haml-lint المفتاح. الخيارات كما يلي:

• config.file - ملف تكوين Haml -lint الذي تريد استخدامه كقاعدة.
• checks.<LINTER_NAME> - التكوين للبطيخ المعطى بواسطة <LINTER_NAME> . يمكنك تمرير أي من خيارات التكوين الخاصة بـ Linter بتنسيق Haml-Lint الأساسي. راجع وثائق Haml-Lint لمزيد من المعلومات.
• يتم تضمين التكوين العالمي مثل exclude_paths أيضًا في تكوين المحرك. راجع الوثائق المناخية لمزيد من المعلومات.

الإصدار

يتم إصدار هذا المحرك بناءً على مخطط الإصدار من Haml-Lint. يستخدم إصدار GEM Haml-Lint الذي يتم تثبيته كإصدار أساسي ثم يضيف رقم بناء. على سبيل المثال ، في المرة الأولى التي يتم فيها بناء المحرك وإصداره لإصدار 0.23.1 من Hamllint ، فإن إصدار المحرك هو 0.23.1-1 . إذا كان هناك أي أخطاء ثابتة في المحرك دون تحديث إصدار Haml-Lint ، فسيتم زيادة رقم الإنشاء (على سبيل المثال إلى 0.23.1-2 ).

رخصة

الجوهرة متوفرة كمصدر مفتوح بموجب شروط ترخيص معهد ماساتشوستس للتكنولوجيا.