Cách sử dụng công cụ Báo hiệu thu thập dữ liệu

Lưu ý: Closure Linter không còn được dùng nữa và hiếm khi được sử dụng trong Google. Xem trang này để biết thêm thông tin

Tài liệu này mô tả cách cài đặt và sử dụng Closure Linter.

Cài đặt Closure Linter

Sử dụng tiện ích pip của Python để tải xuống và cài đặt Closure Linter.

Linux

Để cài đặt Closure Linter trên Linux, hãy thực thi các lệnh sau:

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

Mac OS X

Để cài đặt Closure Linter trên Mac OS X, hãy thực thi lệnh sau:

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

Windows

Cách cài đặt Closure Linter trên Windows:

  1. Tải xuống và cài đặt Python cho Windows.
  2. Thực thi lệnh sau:
> pip install https://github.com/google/closure-linter/zipball/master

Lưu ý: Windows hỗ trợ Closure Linter ở chế độ thử nghiệm.

Tìm vấn đề về kiểu

Để chạy Closure Linter trên một tệp duy nhất, hãy thử:

$ gjslint path/to/my/file.js

Bạn sẽ thấy kết quả như sau:

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 ":"

Bạn cũng có thể kiểm tra đệ quy toàn bộ thư mục, như sau:

$ gjslint -r path/to/my/directory

Theo mặc định, Closure Linter sẽ kiểm tra sự hiện diện của chú thích JsDoc chính xác. Nếu bạn không muốn kiểm tra các chú thích JsDoc bị thiếu trong dự án của mình, hãy tắt chế độ kiểm tra như sau:

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

Mặc dù cờ này vô hiệu hoá các bước kiểm tra đối với chú thích JsDoc bị thiếu, nhưng linter vẫn xác minh rằng các chú thích JsDoc hiện có được dùng đúng cách.

Cờ --strict

Nếu bạn muốn Closure Linter tuân thủ nghiêm ngặt hơn các quy tắc về kiểu như khoảng cách, các loại JsDoc và thẻ tác giả, hãy sử dụng cờ dòng lệnh --strict. Bạn phải sử dụng --strict nếu đang đóng góp mã cho Thư viện Closure.

Khắc phục vấn đề về kiểu

Trong bất kỳ lệnh nào ở trên, bạn có thể thay thế fixjsstyle bằng gjslint để tự động khắc phục nhiều lỗi mà gjslint kiểm tra.

Ví dụ:

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

Bạn nên sao lưu các tệp hoặc lưu trữ chúng trong một hệ thống kiểm soát nguồn trước khi sử dụng fixjsstyle, trong trường hợp tập lệnh thực hiện những thay đổi mà bạn không muốn.