איך משתמשים בקליק על חסימות

הערה: הכלי Closure Linter הוצא משימוש, וכבר לא משתמשים בו ב-Google. מידע נוסף זמין בדף הזה

במאמר הזה מוסבר איך להתקין את Closure Linter ואיך להשתמש בו.

התקנה של Closure Linter

משתמשים בכלי השירות pip של Python כדי להוריד ולהתקין את 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 for 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 נכונות. אם לא רוצים לבדוק אם חסרים הערות JsDoc בפרויקט, משביתים את הבדיקה כך:

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

למרות שהדגל הזה משבית את הבדיקות של הערות JsDoc חסרות, הכלי לבדיקת קוד עדיין מוודא שהערות JsDoc קיימות נמצאות בשימוש נכון.

הדגל ‎--strict

אם רוצים ש-Closure Linter יהיה קפדני יותר לגבי כללי סגנון כמו רווחים, סוגי JsDoc ותגי מחבר, משתמשים בדגל של שורת הפקודה --strict. חובה להשתמש ב---strict אם אתם תורמים קוד ל-Closure Library.

פתרון בעיות בסגנון

בכל אחת מהפקודות שלמעלה, אפשר להחליף את fixjsstyle ב-gjslint כדי לתקן באופן אוטומטי הרבה מהשגיאות ש-gjslint בודק.

לדוגמה:

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

מומלץ לגבות את הקבצים או לאחסן אותם במערכת בקרת מקור לפני השימוש ב-fixjsstyle, למקרה שהסקריפט יבצע שינויים שלא תרצו.