หมายเหตุ: เราเลิกใช้ 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
- ดาวน์โหลดและ ติดตั้ง Python สำหรับ Windows
- เรียกใช้คำสั่งต่อไปนี้
> pip install https://github.com/google/closure-linter/zipball/master
หมายเหตุ: การรองรับ Closure Linter ใน Windows เป็น เวอร์ชันทดลอง
ค้นหาปัญหาเกี่ยวกับสไตล์
หากต้องการเรียกใช้ 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 ที่ขาดหายไป แต่ Linter จะยังคงยืนยันว่ามีการใช้คำอธิบายประกอบ JsDoc ที่มีอยู่ อย่างถูกต้อง
แฟล็ก --strict
หากต้องการให้ Closure Linter เข้มงวดมากขึ้นเกี่ยวกับกฎการจัดรูปแบบ เช่น
การเว้นวรรค ประเภท JsDoc และแท็กผู้เขียน ให้ใช้--strict
แฟล็กบรรทัดคำสั่ง คุณต้องใช้ --strict หากจะร่วมเขียนโค้ดใน Closure
Library
แก้ไขปัญหาเกี่ยวกับสไตล์
ในคำสั่งข้างต้น คุณสามารถแทนที่ fixjsstyle ด้วย
gjslint เพื่อแก้ไขข้อผิดพลาดหลายอย่างโดยอัตโนมัติ
ที่ gjslint ตรวจสอบ
เช่น
$ fixjsstyle path/to/file1.js path/to/file2.js
คุณควรสำรองข้อมูลไฟล์หรือจัดเก็บไว้ในระบบควบคุมแหล่งที่มา
ก่อนใช้ fixjsstyle ในกรณีที่สคริปต์ทำการเปลี่ยนแปลงที่คุณไม่ต้องการ