Plugin linter này cho Visual Studio Code cung cấp giao diện cho phpcs. Nó sẽ được sử dụng với các tệp có chế độ ngôn ngữ “PHP”
Cài đặt
Visual Studio Code phải được cài đặt để sử dụng plugin này. Nếu Visual Studio Code chưa được cài đặt, vui lòng làm theo hướng dẫn tại đây
Linter cài đặt
Trước khi sử dụng plugin này, bạn phải đảm bảo rằng
composer require --dev squizlabs/php_codesniffer
4 đã được cài đặt trên hệ thống của bạn. Phương pháp ưa thích là sử dụng trình soạn thảo cho cả cài đặt toàn hệ thống và toàn dự ánSau khi cài đặt phpcs, bạn có thể tiến hành cài đặt plugin vscode-phpcs nếu nó chưa được cài đặt
GHI CHÚ. Plugin này có thể phát hiện xem dự án của bạn đã được thiết lập để sử dụng phpc thông qua trình soạn thảo hay chưa và tự động sử dụng
4 dành riêng cho dự án qua cài đặt toàn hệ thống củacomposer require --dev squizlabs/php_codesniffer
4. Tính năng này yêu cầu cả nhà soạn nhạc. json và nhà soạn nhạc. lock tồn tại trong thư mục gốc không gian làm việc của bạn hoặccomposer require --dev squizlabs/php_codesniffer
7 để kiểm tra sự phụ thuộc của nhà soạn nhạc. Nếu bạn muốn bỏ qua tính năng này, bạn có thể đặt cài đặt cấu hìnhcomposer require --dev squizlabs/php_codesniffer
8composer require --dev squizlabs/php_codesniffer
GHI CHÚ. Bạn cũng có thể cài đặt
4 trên hệ thống của mình bằng quả lê hoặc thậm chí theo cách thủ công nhưng nằm ngoài phạm vi của plugin nàycomposer require --dev squizlabs/php_codesniffer
Cài đặt toàn hệ thống
Trình nói dối
composer require --dev squizlabs/php_codesniffer
4 có thể được cài đặt trên toàn cầu bằng Trình quản lý phụ thuộc của Trình soạn thảo cho PHPCài đặt nhà soạn nhạc
Yêu cầu gói
4 bằng cách nhập thông tin sau vào thiết bị đầu cuối________số 8composer require --dev squizlabs/php_codesniffer
Cài đặt toàn dự án
Trình nói dối
composer require --dev squizlabs/php_codesniffer
4 có thể được cài đặt trong dự án của bạn bằng Trình quản lý phụ thuộc Trình soạn thảo cho PHPCài đặt nhà soạn nhạc
Yêu cầu gói
4 bằng cách nhập nội dung sau vào thư mục gốc của dự án của bạn trong một thiết bị đầu cuốicomposer require --dev squizlabs/php_codesniffer
composer require --dev squizlabs/php_codesniffer
Cài đặt plugin
- Mở mã Visual Studio
- Nhấn
24 trên Windows hoặccomposer require --dev squizlabs/php_codesniffer
25 trên máy Mac để mở hộp thoại Mở nhanhcomposer require --dev squizlabs/php_codesniffer
- Gõ ext install phpc để tìm phần mở rộng
- Nhấn Enter hoặc nhấp vào biểu tượng đám mây để cài đặt nó
- Khởi động lại Visual Studio Code khi được nhắc
Cấu hình cơ bản
Có nhiều tùy chọn khác nhau có thể được định cấu hình để kiểm soát cách hoạt động của plugin có thể được đặt trong tùy chọn người dùng, không gian làm việc hoặc thư mục của bạn
phpc. cho phép
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. boolean. Mặc định. thật ]
Cài đặt này kiểm soát xem linting
composer require --dev squizlabs/php_codesniffer
4 có được bật hay khôngphpc. đường dẫn thực thi
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. sợi dây. Mặc định. vô giá trị ]
Cài đặt này kiểm soát đường dẫn thực thi cho
composer require --dev squizlabs/php_codesniffer
4. Bạn có thể chỉ định đường dẫn tuyệt đối hoặc đường dẫn tương đối của không gian làm việc tới tệp thực thi composer require --dev squizlabs/php_codesniffer
4. Nếu bị bỏ qua, plugin sẽ cố gắng xác định vị trí đường dẫn phân tích cấu hình trình soạn thảo của bạn hoặc đường dẫn chungphpc. Tiêu chuẩn
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. sợi dây. Mặc định. vô giá trị ]
Cài đặt này kiểm soát tiêu chuẩn mã hóa được sử dụng bởi
composer require --dev squizlabs/php_codesniffer
4. Bạn có thể chỉ định tên, đường dẫn tuyệt đối hoặc đường dẫn tương đối của không gian làm việc của tiêu chuẩn mã hóa để sử dụngGHI CHÚ. Trong khi sử dụng trình quản lý phụ thuộc của nhà soạn nhạc trong quá trình cài đặt toàn cầu, hãy đảm bảo rằng bạn sử dụng các lệnh phpcs trong phạm vi dự án của mình
Các giá trị sau được áp dụng
Cài đặt này có thể được đặt thành
80, đây là hành vi mặc định và sử dụngcomposer require --dev squizlabs/php_codesniffer
81 khi được đặt trong cấu hìnhcomposer require --dev squizlabs/php_codesniffer
4 hoặc dự phòng cho tiêu chuẩn mã hóacomposer require --dev squizlabs/php_codesniffer
83composer require --dev squizlabs/php_codesniffer
2composer require --dev squizlabs/php_codesniffer
Bạn có thể đặt
81 được sử dụng bởi phpc bằng lệnh saucomposer require --dev squizlabs/php_codesniffer
8composer require --dev squizlabs/php_codesniffer
hoặc khi sử dụng trình quản lý phụ thuộc của nhà soạn nhạc từ thư mục gốc của dự án của bạn, hãy thực hiện lệnh sau
5composer require --dev squizlabs/php_codesniffer
Cài đặt có thể được đặt thành tên của tiêu chuẩn mã hóa tích hợp [tức là. ________ 185, ________ 186, ________ 187, _______ 188,
89,composer require --dev squizlabs/php_codesniffer
50,composer require --dev squizlabs/php_codesniffer
51 ] và bạn đã sẵn sàng để đicomposer require --dev squizlabs/php_codesniffer
3composer require --dev squizlabs/php_codesniffer
Tôi có thể đặt cài đặt thành tên của tiêu chuẩn mã hóa tùy chỉnh [tức là.
52,composer require --dev squizlabs/php_codesniffer
53, v.v. ]. Trong trường hợp này, bạn phải đảm bảo rằng tiêu chuẩn mã hóa đã chỉ định được cài đặt và truy cập được bởicomposer require --dev squizlabs/php_codesniffer
4composer require --dev squizlabs/php_codesniffer
7composer require --dev squizlabs/php_codesniffer
Sau khi bạn cài đặt tiêu chuẩn mã hóa tùy chỉnh, bạn có thể cung cấp tiêu chuẩn đó cho phpc bằng cách đưa ra lệnh sau
8composer require --dev squizlabs/php_codesniffer
hoặc khi sử dụng trình quản lý phụ thuộc của nhà soạn nhạc từ thư mục gốc của dự án của bạn, hãy thực hiện lệnh sau
9composer require --dev squizlabs/php_codesniffer
Cài đặt có thể được đặt thành đường dẫn tuyệt đối thành tiêu chuẩn mã hóa tùy chỉnh
0composer require --dev squizlabs/php_codesniffer
hoặc bạn có thể sử dụng đường dẫn đến bộ quy tắc tùy chỉnh
0composer require --dev squizlabs/php_codesniffer
Cài đặt có thể được đặt thành đường dẫn tương đối không gian làm việc của bạn thành tiêu chuẩn mã hóa tùy chỉnh
1composer require --dev squizlabs/php_codesniffer
hoặc bạn có thể sử dụng đường dẫn đến bộ quy tắc tùy chỉnh của dự án
2composer require --dev squizlabs/php_codesniffer
phpc. autoConfigSearch
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. boolean. Mặc định. thật ]
Tự động tìm kiếm bất kỳ tệp
composer require --dev squizlabs/php_codesniffer
55, composer require --dev squizlabs/php_codesniffer
56, composer require --dev squizlabs/php_codesniffer
57 hoặc composer require --dev squizlabs/php_codesniffer
58 nào để sử dụng làm cấu hình. Ghi đè cấu hình composer require --dev squizlabs/php_codesniffer
59 khi tìm thấy bộ quy tắcGHI CHÚ. Tùy chọn này không áp dụng cho các tài liệu chưa được lưu [trong bộ nhớ]
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. mảng. Mặc định. [] ]
Một mảng các mẫu hình cầu để bỏ qua các tệp và thư mục phù hợp khi sắp xếp tài liệu của bạn
composer require --dev squizlabs/php_codesniffer
3phpc. lỗi Mức độ nghiêm trọng
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. con số. Mặc định. 5 ]
Mức độ nghiêm trọng tối thiểu của một lỗi phải được hiển thị. Bạn có thể chỉ định một giá trị số nguyên
phpc. cảnh báo Mức độ nghiêm trọng
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. con số. Mặc định. 5 ]
Mức độ nghiêm trọng tối thiểu mà một cảnh báo phải được hiển thị. Bạn có thể chỉ định một giá trị số nguyên
phpc. showCảnh báo
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. boolean. Mặc định. thật ]
Kiểm soát xem các cảnh báo có được hiển thị hay không
phpc. showSources
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. boolean. Mặc định. sai ]
Hiển thị mã nguồn đánh hơi trong thông báo chẩn đoán
phpc. dấu vết. người phục vụ
[ Phạm vi. Người sử dụng. Không bắt buộc. Loại hình. sợi dây. Mặc định. tắt ]
Cài đặt này kiểm soát xem máy chủ theo dõi có được kích hoạt hay không. Các giá trị có thể bạn có thể sử dụng là
composer require --dev squizlabs/php_codesniffer
30, composer require --dev squizlabs/php_codesniffer
31 hoặc composer require --dev squizlabs/php_codesniffer
32Cấu hình nâng cao
phpc. nhà soạn nhạcJsonPath
[ Phạm vi. Tất cả các. Không bắt buộc. Loại hình. sợi dây. Mặc định. nhà soạn nhạc. json ]
Cài đặt này cho phép bạn ghi đè đường dẫn đến nhà soạn nhạc của mình. json khi nó không nằm trong thư mục gốc của không gian làm việc. Bạn có thể chỉ định đường dẫn tuyệt đối hoặc đường dẫn tương đối của không gian làm việc tới tệp
composer require --dev squizlabs/php_codesniffer
33Chẩn đoán các lỗi phổ biến
Báo cáo phpc chứa json không hợp lệ
Lỗi này xảy ra khi có sự cố xảy ra trong quá trình thực thi phpc, chẳng hạn như Thông báo PHP, Ngoại lệ nghiêm trọng của PHP, Đầu ra tập lệnh khác, v.v., hầu hết có thể được phát hiện như sau
Thực thi lệnh phpcs trong thiết bị đầu cuối của bạn với --report=json và xem liệu đầu ra có chứa bất kỳ thứ gì khác ngoài json hợp lệ không
GHI CHÚ. Tham số '-q' được tự động truyền vào phpcs v. 2. 6. 2 trở lên để loại bỏ các lỗi như vậy. Vui lòng cập nhật
4 lên phiên bản >=2. 6. 2composer require --dev squizlabs/php_codesniffer
Sự nhìn nhận
Kiến trúc tiện ích mở rộng dựa trên Ví dụ về nút máy chủ ngôn ngữ
Cảm hứng bổ sung đến từ Atom Linter-phpcs
Đóng góp và cấp phép
Dự án được lưu trữ trên GitHub nơi bạn có thể báo cáo sự cố, rẽ nhánh dự án và gửi yêu cầu kéo
Dự án có sẵn theo giấy phép MIT, cho phép sửa đổi và phân phối lại cho cả mục đích thương mại và phi thương mại