eslint plugin sonarjs

لقد تحرك هذا المستودع!

يحتوي هذا المستودع على eslint-plugin-sonarjs حتى الإصدار ^1.0.0 . للإصدارات >=2.0.0 يرجى الانتقال إلى مستودع محلل Sonarjs. تتيح الإصدارات الجديدة من eslint-plugin-sonarjs جميع قواعد Sonarjs لمستخدمي ESLINT ، بدلاً من مجموعة فرعية كما كانت مع ^1.0.0 العيش هنا.

لا من المتوقع أن تهبط أي تغييرات جديدة هنا.

eslint-plugin-sonarjs

قواعد Sonarjs لـ ESLINT لمساعدة المطورين على إنتاج رمز نظيف من خلال اكتشاف الحشرات والأنماط المشبوهة.

قواعد

الكشف عن الأخطاء؟

تهدف القواعد في هذه الفئة إلى إيجاد أماكن في الكود التي لديها فرصة كبيرة لكونك الأخطاء ، أي لا تعمل على النحو المقصود.

• لا ينبغي أن يكون لجميع الفروع في بنية مشروطة نفس التنفيذ بالضبط ( no-all-duplicated-branches )
• لا ينبغي استبدال عناصر التجميع دون قيد أو شرط ( no-element-overwrite )
• لا ينبغي الوصول إلى المجموعات الفارغة أو تكرارها ( no-empty-collection )
• لا ينبغي أن تمر مكالمات الوظائف ( no-extra-arguments )
• لا ينبغي أن يكون لبيانات "if/else if no-identical-conditions
• لا ينبغي استخدام تعبيرات متطابقة على جانبي المشغل الثنائي ( no-identical-expressions )
• لا ينبغي تجاهل قيم الإرجاع من وظائف بدون آثار جانبية ( no-ignored-return ) ( أنواع الاستخدامات )
• يجب إعادة بناء الحلقات التي تحتوي على تكرار واحد على الأكثر ( no-one-iteration-loop )
• لا ينبغي استخدام إخراج الوظائف التي لا تُرجع أي شيء ( no-use-of-empty-return-value )
• المشغلين غير الموجودين '=+' ، '=-' و '=!' لا ينبغي استخدامها ( non-existent-operator ) (: مفتاح الربط: قابل للتثبيت )

الكشف عن رائحة الكود؟

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

• يجب ألا يكون التعقيد المعرفي للوظائف مرتفعًا جدًا ( cognitive-complexity )
• "إذا ... إذا كان" إذا "يجب أن تنتهي بنيات" آخر "( elseif-without-else ) ( معطل )
• لا ينبغي أن تحتوي عبارات "التبديل" على جمل "الحالات" ( max-switch-cases )
• يجب دمج عبارات "قابلة للطي" إذا no-collapsible-if (
• يجب أن تكون مقارنات التجميع ومقارنات طول الصفيف منطقية ( no-collection-size-mischeck ) (: مفتاح الربط: قابلة للتثبيت ، أنواع الاستخدامات )
• لا ينبغي تكرار حرفيات السلسلة ( no-duplicate-string )
• لا ينبغي أن يكون لهان فرعين في بنية مشروطة نفس التنفيذ ( no-duplicated-branches )
• لا ينبغي أن تكون التعبيرات المنطقية غير مبررة ( no-gratuitous-expressions )
• لا ينبغي أن يكون للوظائف تطبيقات متطابقة ( no-identical-functions )
• لا ينبغي قلب الشيكات المنطقية ( no-inverted-boolean-check ) (: وجع: قابلة للتثبيت ، معطل )
• لا ينبغي أن تتلاعب ببيانات "التبديل" ( no-nested-switch )
• لا ينبغي أن تتلألأ الحرفيين عن القالب ( no-nested-template-literals )
• لا ينبغي أن تكون الحرفية المنطقية زائدة عن الحاجة ( no-redundant-boolean )
• لا ينبغي أن تكون عبارات القفز زائدة عن الحاجة ( no-redundant-jump ) (: مفتاح الربط: قابلة للتثبيت )
• يجب أن تبدأ الشرطية على خطوط جديدة ( no-same-line-conditional ) (: وجع: قابلة للإصلاح )
• يجب أن تحتوي عبارات "Switch" على جمل على الأقل 3 no-small-switch
• يجب استخدام محتويات التجميع والمصفوفة ( no-unused-collection )
• يجب أن تفعل شروط "Catch" أكثر من Rethrow ( no-useless-catch )
• لا ينبغي الإعلان عن المتغيرات المحلية ثم إرجاعها أو إلقاؤها على الفور ( prefer-immediate-return ) (: مفتاح الربط: قابل للتثبيت )
• يجب استخدام بناء الجملة الحرفي الكائن ( prefer-object-literal )
• لا ينبغي أن يتم إرجاع عودة التعبيرات المنطقية إلى عبارة "إذا كانت" إذا prefer-single-boolean-return ) (: وجع: Fixable )
• يجب استخدام حلقة "بينما" بدلاً من "حلقة" ( prefer-while ) (: مفتاح الربط: قابلة للتثبيت )

المتطلبات الأساسية

• node.js (> = 16.x).
• eslint 8.x أو 9.x (تبعية الأقران للمكون الإضافي).

الاستخدام

• إذا لم يكن لديك ESLINT بعد تكوينه لمشروعك ، فاتبع هذه التعليمات.
• قم بتثبيت eslint-plugin-sonarjs باستخدام npm (أو yarn ) لمشروعك أو عالميًا:

npm install eslint-plugin-sonarjs --save-dev # install for your project
npm install eslint-plugin-sonarjs -g         # or install globally

• أضف eslint-plugin-sonarjs إلى المكونات الإضافية لتكوين Eslint الخاص بك.

لـ ESLINT 9: إضافة خيار plugins إلى eslint.config.js وتضمين التكوين الموصى به لتمكين جميع القواعد:

 import sonarjs from "eslint-plugin-sonarjs";

[
  sonarjs.configs.recommended,
  {
    "plugins": {
      sonarjs,
    }
  }
]

بالنسبة إلى ESLINT 8: أضف خيار plugins إلى .eslintrc والمكون plugin:sonarjs/recommended-legacy إلى خيار extends لتمكين جميع القواعد الموصى بها:

{
  "plugins" : [ " sonarjs " ],
  "extends" : [ " plugin:sonarjs/recommended-legacy " ]
}

• أو تمكين بعض القواعد يدويًا فقط:

{
  "rules" : {
    "sonarjs/cognitive-complexity" : " error " ,
    "sonarjs/no-identical-expressions" : " error "
    // etc.
  }
}

• للسماح لكل من القواعد بالأداء الكامل ، استخدم @typescript-eslint/parser كحامل لـ ESLINT (كما نفعل) وتعيين خيار parseroptions.project. بفضل ذلك ، تتوفر معلومات النوع ، وهي مفيدة أو حتى ضرورية لبعض القواعد.

التكوينات المتاحة

يوفر هذا البرنامج المساعد تكوين recommended فقط. يتم تنشيط جميع القواعد تقريبًا في هذا الملف الشخصي مع استثناءات قليلة (تحقق من علامة disabled في قائمة القواعد). التكوين recommended ينشط القواعد مع شدة error . نحن ندرج تكوين recommended-legacy ليكون متوافقًا مع ESLINT V8 ، مع نفس تكوين القاعدة ..

Eslint والسونار

يعرض هذا البرنامج المساعد لمستخدمي ESLINT مجموعة فرعية من قواعد JS/TS من منتجات Sonar-* (AKA Sonarjs). لقد استخرجنا القواعد غير المتوفرة في Eslint Core أو غيرها من الإضافات ESLINT لتكون مفيدة لمجتمع ESLINT.

إذا كنت من مستخدمي Sonarqube أو Sonarcloud ، لتربط الكود الخاص بك محليًا ، فإننا نقترح استخدام Extension Sonarlint IDE (متوفر لـ VScode و JetBrains Ides و Eclipse). يمكنك توصيل Sonarlint بمشروع Sonarqube/Sonarcloud الخاص بك لمزامنة تكوين القواعد ، وأوضع إصدار ، إلخ.

المساهمة

هل تريد المشاركة في تطوير المشروع؟ إلقاء نظرة على دليلنا المساهمة!