eslint config

@code-pushup/eslint-config

مسبقات ESLINT الموصى بها عن طريق تمرينات الرمز.

التكوينات

كومة	تكوين	وصف
	جافا سكريبت	التكوين الافتراضي ، مناسب لأي مشروع JavaScript/TypeScript .
	TypeScript	تكوين لمشاريع TypeScript الصارمة.
	العقدة	تكوين لمشاريع node.js.
	زاوي	تكوين للمشاريع الزاوية .
	NGRX	تكوين للمشاريع الزاوية باستخدام مكتبة NGRX .
	GraphQl	تكوين لخوادم GraphQL التي تم تنفيذها في Node.js.
	مزاح	تكوين للمشاريع باستخدام Jest للاختبار.
	فيت	تكوين للمشاريع باستخدام Vitest للاختبار.
	السرو	تكوين للمشاريع باستخدام Cypress للاختبار.
	قصص	تكوين للمشاريع باستخدام Storybook لمكونات واجهة المستخدم.

بعض التكوينات تمدد التكوينات الأخرى ، كما هو موضح أدناه. لذلك ، على سبيل المثال ، يمتد التكوين angular ضمنيًا يوسع typescript و javascript أيضًا.

 الرسم البياني BT ؛
    JavaScript ("JavaScript")
    TypeScript ("TypeScript")
    العقدة ("العقدة")
    زاوي ("Angular")
    NGRX ("NGRX")
    GraphQL ("GraphQL")
    TypeScript-extends-> JavaScript
    العقدة-تمتد-> JavaScript
    Angular-excedends-> typeScript
    NGRX-تمتد-> Angular
    GraphQl-تمدد-> العقدة

يثبت

لاستخدام التكوين الافتراضي ، اتبع هذه الخطوات:

1. يجب أولاً تثبيت جميع تبعيات الأقران المطلوبة (إذا لم تكن قد لم تكن بالفعل):

   npm install -D eslint @eslint/js eslint-plugin-{functional,import,promise,sonarjs,unicorn} globals typescript-eslint

2. تثبيت @code-pushup/eslint-config مع:

   npm install -D @code-pushup/eslint-config

3. قم بتضمين التكوين الافتراضي في ملف تكوين ESLINT الخاص بك (عادةً ما يكون eslint.config.js ):

    import javascript from '@code-pushup/eslint-config/javascript.js' ;
   import tseslint from 'typescript-eslint' ;
   
   export default tseslint . config ( ... javascript ) ;

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

؟ تبعيات الأقران

يتم سرد جميع تبعيات الأقران المستخدمة بواسطة @code-pushup/eslint-config أدناه ، إلى جانب إصداراتها المدعومة. فقط تبعيات التكوين الافتراضية مطلوبة ، والبعض الآخر اختياري.

	حزمة NPM	إصدار	مطلوب
	eslint	^9.0.0	✅
	@ESLINT/JS	^9.0.0	✅
	Eslint-plugin-functional	^7.0.0	✅
	Eslint-plugin-import	^2.31.0	✅
	Eslint-Import-Resolver-typescript	^3.0.0
	Eslint-plugin-promise	>=6.4.0	✅
	eslint-plugin-sonarjs	^1.0.4	✅
	Eslint-plugin-unicorn	>=50.0.0	✅
	الكرات	>=14.0.0	✅
	TypeScript-eslint	^8.0.0	✅
	@graphql-eslint/eslint-plugin	^3.0.0
	@ngrx/eslint-plugin	^18.0.0
	زاوي الزاوية	^18.0.0
	Eslint-plugin-cypress	>=3.3.0
	Eslint-plugin-jest	^28.8.0
	ESLINT-PLUGIN-JEST	^3.0.0
	eslint-plugin-n	>=17.0.0
	Eslint-plugin-rxjs-x	>=0.6.0
	ESLINT-PLUGIN-STORYBOOK	>=0.10.0
	ESLINT-PLUGIN-VITIST	>=0.5.0

؟ اختبارات التجاوز

بالنسبة لرمز عدم الإنتاج ، يتم تعطيل بعض القواعد (أو تخفيض تخفيض الأخطاء إلى التحذيرات).

ينطبق هذا على مسارات الملفات التي تطابق أيًا من الكرات التالية:

• **/*.spec.?(c|m)[jt]s?(x)
• **/*.test.?(c|m)[jt]s?(x)
• **/__tests__/**/*.?(c|m)[jt]s?(x)
• **/__mocks__/**/*.?(c|m)[jt]s?(x)
• **/*.cy.?(c|m)[jt]s?(x)
• **/*.stories.?(c|m)[jt]s?(x)
• **/*.e2e.?(c|m)[jt]s?(x)
• **/*.mock.?(c|m)[jt]s?(x)
• **/*.mocks.?(c|m)[jt]s?(x)
• **/test/**/*.?(c|m)[jt]s?(x)
• **/tests/**/*.?(c|m)[jt]s?(x)
• **/mocks/**/*.?(c|m)[jt]s?(x)
• **/testing-utils/**/*.?(c|m)[jt]s?(x)
• **/test-utils/**/*.?(c|m)[jt]s?(x)
• **/fixtures/**/*.?(c|m)[jt]s?(x)
• **/*.config.?(c|m)[jt]s
• **/.prettierrc.?(c|m)[jt]s
• **/codegen.?(c|m)[jt]s
• **/test-setup.?(c|m)[jt]s

؟ المساهمة

تثبيت Node.js هو شرط أساسي (إصدار LTS). تثبيت التبعيات مع NPM:

npm install

لتنفيذ الاختبارات:

npm test

لتوليد الوثائق:

npm run docs