كيفية استخدام إغلاق Linter

ملاحظة: تم إيقاف تطبيق Closure Linter، ونادرًا ما يتم استخدامه داخل Google. راجع هذه الصفحة للحصول على مزيد من المعلومات

يصف هذا المستند كيفية تثبيت Closure Linter واستخدامه.

تثبيت Closure Linter

استخدم الأداة المساعدة Python pip لتنزيل وتثبيت تطبيق Closure Linter.

Linux

لتثبيت Closure Linter على نظام التشغيل Linux، نفِّذ الأوامر التالية:

$ sudo apt-get install python-pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Mac OS X

لتثبيت Closure Linter على نظام التشغيل Mac OS X، نفِّذ الأمر التالي:

$ sudo easy_install pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Windows

لتثبيت Closure Linter على نظام التشغيل Windows:

  1. نزّل وثبّت Python لنظام التشغيل Windows.
  2. نفِّذ الأمر التالي:
> pip install https://github.com/google/closure-linter/zipball/master

ملاحظة: يتوافق دعم Windows مع Closure Linter بشكل تجريبي.

اعثر على مشاكل في النمط

لتشغيل Closure Linter على ملف واحد، جرّب:

$ gjslint path/to/my/file.js

من المفترض أن تظهر لك النتائج على النحو التالي:

Line 46, E:0110: Line too long (87 characters).
Line 54, E:0214: Missing description in @return tag
Line 66, E:0012: Illegal semicolon after function declaration
Line 150, E:0120: Binary operator should go on previous line "+"
Line 175, E:0011: Missing semicolon after function assigned to a variable
Line 210, E:0121: Illegal comma at end of array literal
Line 220, E:0002: Missing space before ":"

يمكنك أيضًا مراجعة دليل بالكامل بشكل متكرر، كما يلي:

$ gjslint -r path/to/my/directory

بشكل افتراضي، يتحقق Closure Linter من وجود تعليقات توضيحية صحيحة بتنسيق JsDoc. إذا لم تكن تريد التحقق من عدم وجود تعليقات توضيحية لجافا سكريبت في مشروعك، فعطّل هذا الفحص كما يلي:

$ gjslint --nojsdoc -r path/to/my/directory

على الرغم من أن هذه العلامة عطّلت عمليات التحقق بحثًا عن تعليقات JsDoc التوضيحية المفقودة، إلا أن Linter يتحقق من استخدام تعليقات JsDoc التوضيحية الحالية بشكل صحيح.

العلم --الصارم

إذا كنت تريد أن يكون تطبيق Closure Linter أكثر صرامةً بشأن قواعد النمط مثل التباعد وأنواع JsDoc وعلامات المؤلف، استخدِم علامة سطر الأوامر --strict. يجب استخدام --strict إذا كنت تساهم برمز في مكتبة الإغلاق.

إصلاح مشاكل النمط

في أي من الأوامر أعلاه، يمكنك استبدال fixjsstyle بـ gjslint لإصلاح الكثير من الأخطاء التي يتحقق منها gjslint تلقائيًا.

مثلاً:

$ fixjsstyle path/to/file1.js path/to/file2.js

عليك الاحتفاظ بنسخة احتياطية من ملفاتك أو تخزينها في نظام تحكم في المصدر قبل استخدام fixjsstyle، في حال إجراء النص البرمجي لتغييرات لا تريدها.