Đường dẫn thực thi Phpc

Để sử dụng PHP_CodeSniffer từ PhpStorm thay vì dòng lệnh, bạn cần đăng ký nó trong PhpStorm và định cấu hình nó dưới dạng kiểm tra mã PhpStorm. Sau khi được cài đặt và kích hoạt trong PhpStorm, công cụ này có sẵn trong mọi tệp PHP đã mở và không cần thực hiện thêm bước nào để khởi chạy nó. Kiểm tra mã nhanh chóng được kích hoạt sau mỗi lần cập nhật trong tệp, do đó giúp dễ dàng loại bỏ các sự cố đã phát hiện

Các lỗi và cảnh báo do PHP_CodeSniffer báo cáo nhanh chóng được hiển thị dưới dạng thông báo bật lên. Khi công cụ được chạy ở chế độ hàng loạt, các lỗi và cảnh báo sẽ được hiển thị trong cửa sổ Sự cố của công cụ. Mỗi thông báo có tiền tố phpcs để phân biệt với kiểm tra nội bộ của PhpStorm. PhpStorm cũng tích hợp với công cụ PHP Code Beautifier and Fixer, cho phép bạn khắc phục nhiều sự cố đã phát hiện

điều kiện tiên quyết

Trước khi tích hợp PHP_CodeSniffer trong PhpStorm, hãy đảm bảo đáp ứng các điều kiện tiên quyết sau

  • Bạn đang làm việc với PHP_CodeSniffer phiên bản 1. 5. 0 trở lên

  • Thư mục chứa tệp thực thi công cụ PHP phải được thêm vào hệ thống path. Điều này cho phép các tập lệnh công cụ chất lượng mã thực hiện các cuộc gọi đến công cụ PHP trên toàn hệ thống

  • Đối với trình thông dịch từ xa dựa trên Docker Compose, hãy đảm bảo sử dụng chế độ exec để tránh tạo ra các vùng chứa bổ sung

    1. Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], đi tới PHP< . .

    2. Trên trang PHP mở ra, hãy nhấp vào

      bên cạnh CLI Interpreter list.

    3. Trong hộp thoại Trình thông dịch CLI mở ra, hãy đặt Vòng đời mode for the selected interpreter to Connect to existing container ['docker-compose exec'] .

Cài đặt và cấu hình PHP_CodeSniffer

Các tập lệnh PHP_CodeSniffer có thể được sử dụng làm tập lệnh cục bộ, tập lệnh được liên kết với trình thông dịch PHP hoặc tập lệnh được khai báo là phần phụ thuộc của dự án và được cài đặt qua Trình soạn thảo, đây là cách thích hợp hơn và được đề xuất

Cài đặt PHP_CodeSniffer với Composer

Trước khi bạn bắt đầu, hãy đảm bảo Trình soạn thảo được cài đặt trên máy của bạn và được khởi tạo trong dự án hiện tại như được mô tả trong trình quản lý phụ thuộc Trình soạn thảo

Khi bạn cài đặt PHP_CodeSniffer với Composer, PhpStorm sẽ tự động tải xuống các tập lệnh cần thiết, đăng ký chúng trong IDE và tùy chọn bật và định cấu hình kiểm tra mã tương ứng

  1. Bên trong nhà soạn nhạc. json , hãy thêm bản ghi phụ thuộc squizlabs/php_codesniffer vào phần require hoặc require-dev. Nhấn Ctrl + Space để hoàn thành mã cho tên gói và phiên bản.

  2. làm một điều trong số sau đây

    • Nhấp vào liên kết tắt Cài đặt ở đầu bảng chỉnh sửa.

    • Nếu kiểm tra Gói Composer chưa được cài đặt được bật, PhpStorm sẽ đánh dấu các phần phụ thuộc đã khai báo hiện chưa được cài đặt. Nhấn Alt+Enter và chọn xem bạn muốn cài đặt một phần phụ thuộc cụ thể hay tất cả các phần phụ thuộc cùng một lúc.

Nhấp vào

bên cạnh bản ghi gói trong trình soạn thảo. json để chuyển đến trang Cài đặt/Tùy chọn tương ứng và định cấu hình PHP_CodeSniffer theo cách thủ công.

Đặt lại cấu hình PHP_CodeSniffer

Sau khi PHP_CodeSniffer được định cấu hình ban đầu, các sửa đổi tiếp theo trong composer. json sẽ không ảnh hưởng đến cấu hình kiểm tra. Để áp dụng các thay đổi mới hơn, hãy đặt lại cấu hình PHP_CodeSniffer.

  1. Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], điều hướng đến PHP. Công cụ chất lượng .

  2. Trên trang Công cụ chất lượng mở ra, hãy mở rộng khu vực PHP_CodeSniffer và nhấp vào bên cạnh < . Configuration list.

  3. Trong hộp thoại PHP_CodeSniffer mở ra, hãy làm trống đường dẫn PHP_CodeSniffer field.

  4. Cập nhật các thành phần phụ thuộc Trình soạn thảo của dự án bằng cách nhấp vào Cập nhật ở đầu trình soạn thảo. bảng soạn thảo json . Xem Cập nhật phụ thuộc để biết chi tiết.

PhpStorm sẽ thực hiện lại cấu hình PHP_CodeSniffer và do đó áp dụng các thay đổi trong composer. json .

Định cấu hình PHP_CodeSniffer theo cách thủ công

Bạn có thể sử dụng tập lệnh công cụ chất lượng mã PHP cục bộ được tải xuống thủ công hoặc tập lệnh được liên kết với trình thông dịch PHP. Có thể có một số trình thông dịch PHP cục bộ và từ xa, trình thông dịch được chỉ định trên trang PHP của hộp thoại Cài đặt/Tùy chọn được coi là Project Default. Learn more about configuring PHP interpreters in Configure remote PHP interpreters or in Configure local PHP interpreters.

Chọn tập lệnh PHP_CodeSniffer để sử dụng

  1. Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], điều hướng đến PHP. Công cụ chất lượng .

  2. Trên trang Công cụ chất lượng mở ra, hãy mở rộng khu vực PHP_CodeSniffer . Từ danh sách Cấu hình , chọn tập lệnh PHP_CodeSniffer.

    • Để sử dụng tập lệnh được liên kết với trình thông dịch PHP từ xa cụ thể, hãy chọn tên của trình thông dịch này

    • Để sử dụng tập lệnh cục bộ, hãy chọn Cục bộ . Trong trường hợp này, PHP_CodeSniffer cục bộ sẽ được thực thi bất kể trình thông dịch PHP nào - cục bộ hay từ xa - được sử dụng trong dự án. Lưu ý rằng chỉ có thể có một cấu hình Cục bộ cho PHP_CodeSniffer vì PhpStorm chạy tập lệnh [ phpcs. bat cho Windows hoặc phpcs cho Linux và macOS] có chứa đường dẫn đến công cụ PHP.

    • Để sử dụng tập lệnh được liên kết với trình thông dịch dự án mặc định, tức là tập lệnh được chọn trên trang PHP của Settings/Preferences dialog, choose By default project interpreter.

Định cấu hình tập lệnh PHP_CodeSniffer cục bộ

  1. Tải xuống và cài đặt tập lệnh PHP_CodeSniffer

    Để kiểm tra cài đặt PHP_CodeSniffer, hãy chuyển đến thư mục cài đặt và chạy lệnh sau

    phpc --version

    Nếu công cụ có sẵn, bạn sẽ nhận được thông báo ở định dạng sau

    PHP_CodeSniffer version [stable] by Squiz. [///uiz.net]

    Để mã được kiểm tra theo tiêu chuẩn mã hóa tùy chỉnh của riêng bạn, hãy tạo mã đó. Lưu trữ các quy tắc và bộ quy tắc. xml trỏ đến chúng trong thư mục gốc tiêu chuẩn mã hóa .

  2. Đăng ký tập lệnh PHP_CodeSniffer cục bộ trong PhpStorm

    • Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], điều hướng đến PHP. Công cụ chất lượng .

    • Trên trang Công cụ chất lượng mở ra, hãy mở rộng khu vực PHP_CodeSniffer và nhấp vào bên cạnh < . Configuration list.

    • Trong hộp thoại PHP_CodeSniffer mở ra, hãy chỉ định vị trí của phpcs. bat hoặc phpcs PHP_CodeSniffer có thể thực thi được trong đường dẫn PHP_CodeSniffer field. Type the path manually or click

      và chọn thư mục có liên quan trong hộp thoại mở ra.

      Để kiểm tra xem đường dẫn đã chỉ định đến phpcs. bat hoặc phpcs đảm bảo tương tác giữa PhpStorm và PHP_CodeSniffer, nghĩa là công cụ có thể khởi chạy từ PhpStorm và PhpStorm sẽ . Việc xác thực này tương đương với việc chạy lệnh phpcs --version. Nếu quá trình xác thực thành công, PhpStorm sẽ hiển thị thông tin về phiên bản PHP_CodeSniffer được phát hiện. Validate button. This validation is equal to running the phpcs --version command. If validation passes successfully, PhpStorm displays the information on the detected PHP_CodeSniffer version.

  3. Nếu cần, trong trường Thời gian chờ của quy trình công cụ , hãy chỉ định khoảng thời gian bạn muốn PhpStorm đợi kết quả từ PHP_CodeSniffer, sau đó quy trình sẽ được thực hiện .

  4. Nếu cần, trong khu vực Cài đặt Trình sửa lỗi và làm đẹp mã PHP cung cấp đường dẫn đến công cụ Trình sửa lỗi và làm đẹp mã PHP trong Path to phpcbf field. This will let you automatically fix many of the errors detected by PHP_CodeSniffer. If you install PHP_CodeSniffer with Composer, PHP Code Beautifier and Fixer sẽ được phát hiện và thiết lập tự động.

Định cấu hình tập lệnh PHP_CodeSniffer được liên kết với trình thông dịch PHP

  1. Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], đi tới PHP. Công cụ chất lượng .

  2. Trên trang Công cụ chất lượng mở ra, hãy mở rộng khu vực PHP_CodeSniffer và nhấp vào bên cạnh < . Hộp thoại Configuration list. The PHP_CodeSniffer mở ra hiển thị danh sách tất cả các tập lệnh PHP_CodeSniffer đã định cấu hình trong ngăn bên trái, một trong số chúng thuộc loại Local and others are named after the PHP interpreters with which the scripts are associated.

  3. Nhấp vào

    trên thanh công cụ. Trong hộp thoại PHP_CodeSniffer của Trình thông dịch từ xa mở ra, hãy chọn trình thông dịch PHP từ xa để sử dụng tập lệnh được liên kết từ. Nếu danh sách không chứa trình thông dịch phù hợp, hãy nhấp vào và định cấu hình trình thông dịch từ xa trong hộp thoại Trình thông dịch CLI như được mô tả .

    Khi bạn nhấp vào OK , PhpStorm sẽ đưa bạn trở lại PHP_CodeSniffer dialog where the new PHP_CodeSniffer configuration is added to the list and the right-hand pane shows the chosen remote PHP interpreter, the path to the PHP_CodeSniffer associated with it, and the advanced PHP_CodeSniffer options.

  4. Nếu cần, trong trường Thời gian chờ của quy trình công cụ , hãy chỉ định khoảng thời gian bạn muốn PhpStorm đợi kết quả từ PHP_CodeSniffer, sau đó quy trình sẽ được thực hiện .

  5. Nếu cần, trong khu vực Cài đặt Trình sửa lỗi và làm đẹp mã PHP cung cấp đường dẫn đến công cụ Trình sửa lỗi và làm đẹp mã PHP trong Path to phpcbf field. This will let you automatically fix many of the errors detected by PHP_CodeSniffer. If you install PHP_CodeSniffer with Composer, PHP Code Beautifier and Fixer sẽ được phát hiện và thiết lập tự động.

Định cấu hình PHP_CodeSniffer làm kiểm tra PhpStorm

Cấu hình kiểm tra PHP_CodeSniffer với Composer

Bạn có thể bao gồm thông tin về bộ quy tắc PHP_CodeSniffer mặc định và tùy chỉnh bên trong phần tập lệnh của composer. json . Khi bạn cài đặt hoặc cập nhật các phần phụ thuộc của dự án, các bộ quy tắc đã chỉ định sẽ được phát hiện và kiểm tra PHP_CodeSniffer sẽ được bật tự động.

Nếu không có bộ quy tắc nào được chỉ định trong phần scripts của composer. json , PhpStorm sẽ kiểm tra thêm thư mục gốc của dự án để xác định bộ quy tắc bằng phpcs. xml tên mặc định. Nếu có tệp, tệp sẽ tự động được chọn làm bộ quy tắc Tùy chỉnh của kiểm tra.

  • Trong phần scripts của nhà soạn nhạc. json , hãy thêm lệnh khởi chạy phpcs PHP_CodeSniffer vào một trong các phần tử lá.

    Cung cấp đối số --standard để biểu thị tiêu chuẩn viết mã được sử dụng. Ví dụ: việc thêm bản ghi sau sẽ đặt tiêu chuẩn viết mã thành PSR2 .

    "kịch bản". { "phpc". "phpcs --standard=PSR2" }

    Việc thêm bản ghi sau sẽ đặt tiêu chuẩn viết mã thành Tùy chỉnh và đường dẫn đến bộ quy tắc thành . xml .

    "kịch bản". { "phpc". "phpcs --standard=phpcs. xml" }

Ngoài ra, bạn có thể cung cấp phần phụ thuộc tiêu chuẩn không phải PSR tùy chỉnh bên trong phần require-dev của composer. json để nó tự động được phát hiện. Hiện tại, các tiêu chuẩn sau được hỗ trợ.

  • học thuyết

  • lập trình viên Drupal

  • Joomla

  • Magento

  • MediaWiki

  • Khả năng tương thích PHP

  • giao hưởng

  • WordPress

  • yii

Sau khi PHP_CodeSniffer được định cấu hình ban đầu, các sửa đổi tiếp theo trong composer. json sẽ không ảnh hưởng đến cấu hình kiểm tra. Để áp dụng các thay đổi mới hơn, hãy đặt lại cấu hình PHP_CodeSniffer trên PHP. Trang Công cụ chất lượng của hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S] và cập nhật các thành phần phụ thuộc của dự án.

Định cấu hình kiểm tra PHP_CodeSniffer theo cách thủ công

  1. Trong hộp thoại Cài đặt/Tùy chọn [Ctrl+Alt+S], nhấp vào Kiểm tra under Editor.

  2. Trên trang Kiểm tra mở ra, mở rộng PHP. nút Công cụ chất lượng và chọn hộp kiểm bên cạnh Xác thực PHP_CodeSniffer .

    Nếu bạn đã cài đặt PHP_CodeSniffer với Composer nhưng tính năng kiểm tra tương ứng hiện đang bị tắt, PhpStorm sẽ đánh dấu bản ghi của nó trong composer. json . Nhấn Alt+Enter và sử dụng bản sửa lỗi nhanh Bật kiểm tra được cung cấp để bật kiểm tra và mở trang Kiểm tra.

  3. Trên ngăn bên phải của trang, định cấu hình công cụ PHP_CodeSniffer bằng các điều khiển trong khu vực Tùy chọn .

    1. Từ danh sách Mức độ nghiêm trọng , chọn mức độ nghiêm trọng cho kiểm tra PHP_CodeSniffer. Giá trị được chọn xác định mức độ nghiêm trọng của sự khác biệt được phát hiện sẽ được PhpStorm xử lý và được trình bày trong kết quả kiểm tra.

    2. Từ danh sách Phạm vi , hãy chọn phạm vi để giới hạn ứng dụng kiểm tra.

    3. Trong trường Kiểm tra tệp có phần mở rộng , hãy cung cấp danh sách phần mở rộng tệp được phân tách bằng dấu phẩy mà PHP_CodeSniffer sẽ kiểm tra.

    4. Để PHP_CodeSniffer báo cáo cảnh báo ngoài lỗi, hãy chọn Hiển thị cảnh báo dưới dạng. hộp kiểm và chọn mức độ nghiêm trọng từ danh sách. Để chỉ báo cáo lỗi và chặn cảnh báo báo cáo, hãy xóa Hiển thị cảnh báo dưới dạng. hộp kiểm.

    5. Nếu bạn đang dựa vào tiêu chuẩn mã hóa tùy chỉnh của bên thứ ba [ví dụ: Tiêu chuẩn mã hóa Coder hoặc Joomla], bạn cần tích hợp tiêu chuẩn đó với PHP_CodeSniffer trước khi sử dụng. Để thực hiện việc này, hãy chọn hộp kiểm Đường dẫn tiêu chuẩn đã cài đặt , nhấp vào và chọn thư mục cài đặt tiêu chuẩn tùy chỉnh trong hộp thoại .

    6. Chọn hộp kiểm Hiển thị tên đánh hơi để hiển thị tên của tên đánh hơi tương ứng trong trình chỉnh sửa hoặc kết quả kiểm tra ngoài phần tóm tắt kiểm tra.

    7. Chỉ định tiêu chuẩn mã hóa để áp dụng

      • Để sử dụng một trong các tiêu chuẩn mã hóa được xác định trước, hãy chọn tiêu chuẩn mã hóa đó trong danh sách Tiêu chuẩn mã hóa , chỉ định kiểu mã hóa để kiểm tra mã của bạn với. Danh sách chứa tất cả các tiêu chuẩn viết mã được cài đặt bên trong cấu trúc thư mục chính php_codesniffer .

      • Để mã của bạn được kiểm tra theo tiêu chuẩn viết mã do chính bạn xác định trước đó, hãy chọn Tùy chỉnh . Nhấp vào và trong hộp thoại Tiêu chuẩn mã hóa tùy chỉnh mở ra, hãy chỉ định đường dẫn đến ruleset.xml cho tiêu chuẩn viết mã của riêng bạn trong trường Đường dẫn đến bộ quy tắc . Nhập đường dẫn theo cách thủ công hoặc nhấp vào và chọn thư mục có liên quan trong hộp thoại mở ra.

Khắc phục sự cố do PHP_CodeSniffer phát hiện

PhpStorm tích hợp với công cụ PHP Code Beautifier and Fixer, cho phép bạn khắc phục nhiều sự cố đã phát hiện. Nếu bạn cài đặt PHP_CodeSniffer với Composer, PHP Code Beautifier and Fixer sẽ được phát hiện và thiết lập tự động. Nếu không, bạn cần thiết lập thủ công.

Khắc phục sự cố bằng cách sử dụng sửa lỗi nhanh

Khi phát hiện sự cố, PhpStorm đánh dấu sự cố theo cài đặt kiểm tra PHP_CodeSniffer

  1. Đặt dấu mũ tại vấn đề đã phát hiện và nhấp vào

    hoặc nhấn Alt+Enter.

  2. Chọn Trình chỉnh sửa và làm đẹp mã PHP. sửa toàn bộ tệp từ menu bật lên. Lưu ý rằng điều này sẽ khắc phục tất cả các sự cố được phát hiện trong tệp hiện tại.

Bạn cũng có thể phát hiện sự cố ở chế độ hàng loạt hoặc tự động khắc phục sự cố bằng tính năng dọn dẹp mã

Khắc phục sự cố tự động bằng Code Cleanup

  1. Từ menu chính, chọn Mã. Dọn dẹp mã .

  2. Trong hộp thoại Chỉ định Phạm vi Dọn dẹp Mã mở ra, hãy chọn phạm vi mà bạn muốn áp dụng hồ sơ kiểm tra

  3. Chọn cấu hình kiểm tra từ danh sách hoặc nhấp vào để định cấu hình cấu hình mới trong hộp thoại Kiểm tra làm sạch mã mở ra. Bạn cũng có thể nhấp vào để kiểm tra xem bản sửa lỗi nào sẽ được áp dụng và đảm bảo rằng kiểm tra PHP_CodeSniffer được bật.

  4. Nhấp vào OK để chạy dọn dẹp mã.

Chạy PHP_CodeSniffer ở chế độ hàng loạt

  1. Từ menu chính, chọn Mã. Kiểm tra mã .

  2. Chọn cấu hình kiểm tra từ danh sách hoặc nhấp vào để định cấu hình cấu hình mới trong hộp thoại Kiểm tra mở ra. Bạn cũng có thể nhấp vào để kiểm tra xem bản sửa lỗi nào sẽ được áp dụng và đảm bảo rằng kiểm tra PHP_CodeSniffer được bật.

  3. Xem kết quả kiểm tra trong cửa sổ công cụ Sự cố. Các lỗi và cảnh báo do PHP_CodeSniffer báo cáo có tiền tố là phpcs để phân biệt chúng với các cuộc kiểm tra nội bộ của PhpStorm

    Phpc tọa lạc ở đâu?

    Trên hầu hết các hệ điều hành, tệp phpcbf và phpcs nằm trong thư mục ~/. thư mục nhà soạn nhạc/nhà cung cấp/bin . Trên máy cục bộ chạy Linux, đường dẫn tệp có thể là ~/. cấu hình/nhà soạn nhạc/nhà cung cấp/thùng.

    Làm cách nào để định cấu hình phpc trong vscode?

    Cài đặt trình cắm .
    Mở mã Visual Studio
    Nhấn Ctrl+P trên Windows hoặc Cmd+P trên Mac để mở hộp thoại Mở nhanh
    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

    Làm cách nào để cài đặt php_ CodeSniffer?

    Để cài đặt plugin. .
    Mở hộp thoại Quick Open trên VS Code [bằng Ctrl+P hoặc Cmd+P]
    Nhập “ext install phpc” để tìm tiện ích mở rộng và
    Nhấp vào biểu tượng đám mây để cài đặt

Chủ Đề