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

Lưu ý: Đóng Linter không được dùng nữa và hiếm khi được dùng trong Google nữa. Hãy 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 Linter Closure

Sử dụng tiện ích pip của Python để tải 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 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 ý: Tính năng hỗ trợ Windows cho Closure Linter đang trong quá trình thử nghiệm.

Tìm vấn đề về kiểu trình bày

Để chạy công cụ Closure Linter trên một tệp, hãy thử:

$ gjslint path/to/my/file.js

Bạn sẽ thấy các 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ể định kỳ kiểm tra toàn bộ một thư mục, chẳng hạn như sau:

$ gjslint -r path/to/my/directory

Theo mặc định, công cụ Số liệu phân tích về lỗi đóng (Linter) không kiểm tra sự hiện diện của các chú thích JJDoc 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, hãy tắt tính năng kiểm tra như sau:

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

Mặc dù cờ này sẽ vô hiệu hoá các bước kiểm tra đối với các chú thích JsDoc bị thiếu, Công cụ tìm lỗi mã nguồn vẫn xác minh rằng các chú thích JsDoc hiện có được sử dụng đúng cách.

Cờ --cho nghiêm ngặt

Nếu bạn muốn Closure Linter nghiêm ngặt hơn về các quy tắc định kiểu như khoảng cách, 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 đóng.

Khắc phục sự cố về kiểu

Trong bất kỳ lệnh nào ở trên, bạn có thể thay thế fixjsstyle cho gjslint để tự động sửa 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ữ các tệp đó 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 các thay đổi mà bạn không muốn.