wotan

مشروع FIMBullinter

TypeScript و JavaScript Linter

الحزم المتاحة

ووتان

وقت تشغيل Linter الرئيسي مع مجموعة مختارة جيدًا من القواعد المبنية. قابلة للتخصيص مع القواعد الخاصة بك ومعالجاتك وتنسيقات وتكوينات مشاركة ووحدات البرنامج المساعد.

يرجى الرجوع إلى المستندات للحصول على شرح مفصل للقواعد المتاحة والتكوين والاستخدام.

vé

المعالج الرسمي لمكونات الملف الفردي VUE (SFC). يستخرج محتوى البرنامج النصي من ملفات *.vue .

Heimdall

طبقة التوافق للسماح باستخدام قواعد TSLINT وتنسيق داخل وقت تشغيل WOTAN.

فالتير

جعل Wotan يتصرف تقريبا مثل tslint. أعد استخدام tslint.json الحالي دون أي تغيير.

بيفرست

يسمح للمؤلفين بقواعد TSLINT و Formatters لتوفير الحزمة الخاصة بهم للاستخدام داخل WOTAN. القواعد والتنسيقات التي تستخدم Bifröst لا تحتاج إلى Heimdall لتعمل بشكل صحيح.

يمير

يوفر الأنواع الأساسية للقواعد المخصصة ومؤلفي البرنامج المساعد.

ميمير

يحتوي على جميع القواعد الأساسية ، التنسيقات ، المسبقة للتكوين.

ميثوتن

Languageservice Plugin لـ TypeScript. يوفر في الوقت الفعلي محررًا أثناء الكتابة.

توثيق آخر

• فهم واجهة برمجة تطبيقات TypeScript
• قواعد الكتابة
• قواعد الاختبار
• باستخدام القواعد المحلية
• كتابة التكوينات القابلة للمشاركة
• باستخدام API

وصفات

• ربط ملفات Vue مع قواعد tslint
• استبدال tslint --type-check
• اكتشاف المتغيرات غير المستخدمة

ما هذا كل شيء؟

ما الأمر مع هذه الأسماء؟

الأساطير الإسكندنافية:

يأتي Fimbullinter من Fimbulwinter ، الشتاء المذهل لمدة 3 سنوات يسبق أحداث Ragnarök. "Fimbul" تعني "The Great" ، "Linter" هي أداة تكتشف وتحذر من أنماط الترميز معينة.

Wotan هو واحد من أسماء Odin العديدة ، All-Father. قد تعرفه أيضًا باسم Woden و Wodan و Wensley وما إلى ذلك. إنه يسعى باستمرار إلى الحكمة. من عرشه يمكنه رؤية كل شيء في العوالم التسعة التي تحدث.

Vé هو أصغر من ثلاثة أدوات تزيين Woden و Vili و Vé الذين قلصوا معا Ymir العملاق وخلق العوالم التسعة من جسده.

إلى أول زوجين بشريين ، اسأل و embla ، أعطى أودين الروح والحياة ؛ أعطى Vili الذكاء (الذكاء) والشعور باللمس ؛ وأعطى Vé (المظهر ، تعبير الوجه) ، الكلام ، السمع ، والبصر.

Heimdall (المعروف أيضًا باسم Heimdallr) ، الذي يقع حيث يلتقي جسر قوس قزح Burning Bifröst ، يراقب بداية Ragnarök.

Bifröst هو جسر قوس قزح المحترق الذي يربط عالم البشر بعالم الآلهة.

Valtýr ، من "Valr" (الموتى ، ذبح في المعركة) و "Týr" (الله) ، يعني إله القتلى وغالبًا ما يستخدم للإشارة إلى Odin.

Ymir هو عملاق الذي تم إنشاء العالم بأسره. هو سلف كل يوتنار.

ميمير ("المتذكر ، الحكيم") المشهور بمعرفته وحكمته. الله أودين يحمل حول رأس Mímir ويقرأ المعرفة السرية والمشورة له.

Mithotyn (في الواقع "Mitoðinn" ، وهذا يعني "موزع المصير") يقدم القواعد التي لم يكن فيها شيء. يملأ مكان أودين خلال رحلاته إلى الأراضي الأجنبية.

لماذا لينتر آخر؟

هذا يحاول تجنب قرارات تصميم المبيدات الأخرى التي تبين أنها مشكلة:

• تجنب تعارضات الاسم عن طريق البادئة أسماء القواعد اعتمادًا على الحزمة التي تأتي منها.
  • يضع Tslint جميع القواعد في مساحة الاسم العالمية ويفحصها في جميع أدلة القواعد المتاحة. إن ترتيب الدلائل مهم بينما تخطى القواعد الأساسية الأسبقية.
  • يسمح ESLINT بدليل القواعد المحلية كعلم CLI. يمكن للقواعد في هذا الدليل تجاوز القواعد الأساسية.
• يتم حل تبعيات ملفات التكوين بالنسبة إلى هذا الملف.
  • تسلينت يفعل ذلك بالفعل.
  • eslint لا يدعم ذلك.
• لا يوجد تمييز بين التكوينات القابلة للمشاركة والمكونات الإضافية. في الواقع ، كلاهما مجرد تكوينات قابلة للتمديد والتي يمكن أن توفر اختياريًا أدلة القواعد والإعدادات والقواعد والمعالجات.
  • يتيح لك TSLINT الاختيار بين extends و rulesDirectory . دليل قواعد الحزمة هو تفاصيل التنفيذ ويجب ألا يكون جزءًا من تكوين المستخدم.
  • تعامل ESLINT مع التكوينات والمكونات الإضافية مختلفة تمامًا. في الواقع ، حاولوا إهمال التكوينات القابلة للمشاركة لصالح الإضافات.
• تحميل كسول للقواعد لتقليل وقت بدء التشغيل.
  • تسلينت يفعل ذلك بالفعل.
  • تتوقع ESLINT أن توفر الإضافات القواعد كما تم تحميلها بالفعل. هذا يسبب الكثير من النفقات العامة إذا كنت تستخدم فقط بعض قواعد الحزمة الكبيرة.
• التخزين المؤقت للوصول إلى نظام الملفات والتكوين. نظرًا لأن ذاكرة التخزين المؤقت هي خدمة DI ، يمكن لمستخدمي API مسح ذاكرة التخزين المؤقت عند الحاجة.
• دعم المعالجات من البداية. تمكين ربط *.vue ملفات وغيرها الكثير.
• الاسم المستعار للقواعد مع التكوين. يمكن استخدامها لعلاج قواعد مثل ESLINT من no-resticted-syntax كقواعد مميزة مسموسة لكل خيار تكوين.
• يتم تشغيل واجهة برمجة التطبيقات بأكملها بواسطة حاوية DI. هذا يجعل من السهل حقن خدمة مختلفة. يمكنك حتى استخدام الإضافات من خلال CLI لحقن الخدمات المختلفة.
• ملف التكوين "العالمي" (إلى جانب .wotanrc.yaml ) للاتصالات الافتراضية CLI وتكوين البرنامج المساعد: .fimbullinter.yaml . يمكن استخدام هذا الملف بواسطة مكونات المحرر أيضًا ، لذلك ليست هناك حاجة لتكرار التكوين المشترك.
  • ESLINT ليس لديه مثل هذا الملف ورفض إضافة واحد في المستقبل. لن تحتاج أدوات مثل standard أو xo إلى الوجود إذا كنت بحاجة فقط لإنشاء ملف التكوين مثل الافتراضات CLI.
  • Tslint تبدأ في وضعها في tslint.json مما يؤدي إلى مشوش المستخدمين.
• الإبلاغ عن التعليقات غير المستخدمة والمتكررة وتعطيل التعليقات (أو أجزاء منها) مع --report-useless-directives .
  • تقارير ESLINT فقط تعطيل التعطيل. إنها تقارير فقط التعليقات غير المستخدمة تمامًا. لم يتم الإبلاغ عن التعليقات الزائدة بالإضافة إلى تمكين التعليقات للقواعد غير الموجودة.
  • Tslint لا يدعم ذلك.

الاختلافات في tslint

• لتمديد مكون إضافي أو تكوين قابل للمشاركة ، استخدم extends: plugin-name . سيتم حل الاسم وفقًا لخوارزمية دقة وحدة العقدة بالنسبة إلى ملف التكوين.
• لاستخدام القواعد التي يتم الاحتفاظ بها داخل مشروعك ، استخدم rulesDirectory: {"my-prefix": "./path/to/rules"} my-prefix/rule-one: "error" . دليل القواعد هو مسار بالنسبة إلى ملف التكوين.
• التجاوزات: يمكنك تجاوز الترجيح الرئيسي عن طريق تحديد واحد أو أكثر من التجاوزات. إذا كان اسم الملف يتطابق مع نمط الكرات من التجاوز ، يتم تطبيق جميع الإعدادات التي توفرها هذا التجاوز. تتم معالجة التجاوزات بالترتيب ، والتجاوز في وقت لاحق الإعدادات من التجاوزات السابقة.
  • تتطابق الأنماط بالنسبة لملف التكوين الذي تم تحديده فيه.
  • تتم مطابقة الأنماط التي لا تصل إلى مائل إلا مقابل اسم كل ملف.
  • للحد من تطابق إلى الدليل الحالي ، بادئة النمط مع ./ .
  • يمكن استخدام الأنماط المنقولة لطرحها من مباريات الأنماط السابقة.
• linterOptions.exclude -> exclude
  • لا يتم تجاوز الاستبعاد عند تمديد التكوين.
  • يتبع مطابقة النمط نفس القواعد مثل التجاوزات (انظر أعلاه).
• دعم JSON5 لملفات التكوين.
• الإعدادات المستقلة عن القواعد التي يمكن أن تلتقطها القواعد والمعالجات.
• المعالجات ، حتى يدعم --project .
• الاسم المستعار ، انظر أعلاه
• نهج عاقل وآمن للتثبيت:
  • لا إصلاح الملفات مع أخطاء بناء الجملة.
  • يستبعد بدائل متداخلة لمنع تدمير الكود الخاص بك.
  • يقوم بتشغيل عدد قابل للتكوين من التكرارات لكل ملف لتطبيق التغييرات المتضاربة في التكرار التالي.
  • توقف إذا كانت الإصلاحات ستقدم أخطاء بناء الجملة.
  • لا يؤدي التثبيت باستخدام --project إلى إنشاء البرنامج بأكمله من نقطة الصفر ، مما يجعله سريعًا بشكل كبير.
• الاختبار
  • يتم تكوين الاختبارات في ملفات JSON التي يمكنها تكوين كل ما يمكنك تحديده على الرغم من CLI
  • لا تحتوي ملفات الاختبار على علامة خطأ. هذا يتجنب أخطاء بناء الجملة ويجعلها أسهل في الحفاظ عليها. يتم تخزين نتائج الوبر والمحتوى الثابت في ملفات أساسية منفصلة.
  • يمكن اختبار نفس الرمز بإعدادات مختلفة.
• يدعم مراجع مشروع TypeScript.
• يقوم بتحميل القيم الافتراضية لخيارات CLI من .fimbullinter.yaml .
• لا تستخدم معلومات النوع في ملفات javaScript غير المحددة ( // @ts-nocheck أو "checkJs": false ).
• تقارير غير مستخدمة ومتكررة تمكين وتعطيل التعليقات مع --report-useless-directives .

البيئات المدعومة

يعمل هذا المشروع على جميع الإصدارات المدعومة بنشاط من Node.js.

يدعم هذا المشروع رسميًا أحدث 3 نسخة مستقرة من TypeScript. اعتبارا من كتابة هذا هو 3.0 - 3.2. يجب أن تعمل مع بنيات TypeScript Nightly ( typescript@next ) ، ولكن لا يوجد ضمان.

يجب أن تستخدم القواعد المخصصة على الأقل ES6 للحصول على دعم للفئات الأصلية. وإلا فإنك تواجه مشاكل عند محاولة تمديد الفصول الدراسية التي يتم تصديرها من أي من الحزم.

النسخة الدلالية (سياسة Semver)

️ لا تنطبق السياسة التالية إلا على الإصدارات التالية من 1.x والإصدارات التالية. يعتبر كل إصدار في نطاق 0.x تجريبيًا. يمكن أن يكون هناك وسوف يتم كسر تغييرات واجهة برمجة التطبيقات دون إهمال.

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

مسئول (بنيات ليلية)

• ليست مضمونة لتكون مستقرة
• تم وضع علامة على أنه next على NPM حتى تتمكن من تثبيت @fimbul/wotan@next
• يحتوي على أحدث التغييرات المخصصة للإصدار التالي
  • x.0.0-dev* يحتوي على جميع التغييرات بما في ذلك كسر الإصدار الرئيسي التالي
  • يحتوي xy0-dev* على جميع التغييرات في الإصدار الثانوي التالي
  • لا توجد مسبحة لإصدارات التصحيح

إصدارات التصحيح

• إصلاحات
• إصلاح الانحدارات
• refactors من الوظائف الداخلية التي لا تغير السلوك الذي يواجه المستخدم

إصدارات طفيفة

• يضيف قواعد جديدة وخيارات القواعد والنسج والمعالجات وواجهة برمجة التطبيقات
• يمكن أن تضيف القواعد شيكات جديدة قد تؤدي إلى نتائج جديدة
• يتم تمكين القواعد والخيارات الجديدة في wotan:latest
• يمكن أن تغير القواعد رسائل اكتشافها
• يمكن أن تؤدي التنسيقات المخصصة للاستهلاك البشري (مثل stylish ) إلى تغيير إنتاجها
• يمكن إهمال القواعد وخيارات القاعدة والمنسق والمعالجات وواجهة برمجة التطبيقات
• يمكن إضافة خيارات التكوين الجديدة إلى ملفات التكوين

الإصدارات الرئيسية

• يحتوي على تغييرات API كسر
• يزيل القواعد والخيارات والخطوط التي تم إهمالها مسبقًا وما إلى ذلك.
• يمكن أن تقوم التنسيقات المخصصة لاستهلاك الماكينة (مثل json أو tap ) بتغيير إخراجها
• wotan:recommended لمحتوى wotan:latest

جدول الإصدار

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

رخصة

Apache-2.0 © Klaus Meinhardt