วิธีใช้การปิดถนน

หมายเหตุ: 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 สําหรับ 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 จะตรวจสอบว่ามีคําอธิบายประกอบ JesDoc ที่ถูกต้อง หากไม่ต้องการตรวจสอบคําอธิบายประกอบ JsDoc ที่ขาดหายไปในโปรเจ็กต์ ให้ปิดใช้การตรวจสอบ ดังนี้

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

แม้ว่าการตั้งค่าสถานะนี้จะปิดใช้การตรวจสอบคําอธิบายประกอบ JsDoc ที่ขาดหายไป แต่ Linux จะยังคงยืนยันว่ามีการใช้คําอธิบายประกอบ JsDoc ที่มีอยู่อย่างถูกต้อง

-- -- สถานะที่เข้มงวด

หากต้องการให้ Closure Linter เข้มงวดมากขึ้นเกี่ยวกับกฎรูปแบบ เช่น ระยะห่าง ประเภท JsDoc และแท็กผู้เขียน ให้ใช้--strict บรรทัดคําสั่ง คุณต้องใช้ --strict หากมีส่วนให้โค้ดในไลบรารีการปิด

แก้ปัญหาเกี่ยวกับสไตล์

ใช้คําสั่ง fixjsstyle แทน gjslint เพื่อแก้ไขข้อผิดพลาดหลายรายการที่ gjslint ตรวจสอบโดยอัตโนมัติได้

เช่น

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

คุณควรสํารองไฟล์หรือเก็บไว้ในระบบควบคุมแหล่งที่มาก่อนใช้ fixjsstyle ในกรณีที่สคริปต์ทําการเปลี่ยนแปลงที่คุณไม่ต้องการ