programming php

Tập tin cụ thể phpstan

PhpStorm cung cấp tính năng kiểm tra chất lượng mã thông qua tích hợp với công cụ PHPStan, công cụ này xác thực tính nhất quán của mã đối với một bộ quy tắc xác thực

Để sử dụng PHPStan 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 PHPStan 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ố phpstan để phân biệt với kiểm tra nội bộ của PhpStorm

Tích hợp PHPStan được triển khai thông qua plugin PHPStan mã nguồn mở. Plugin này đi kèm với PhpStorm và được bật theo mặc định

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

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

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 [Ctrl+Alt+S], chuyển đến 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 PHPStan

Các tập lệnh PHPStan 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 PHPStan 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 PHPStan 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 tập lệnh tương ứng.

Bên trong nhà soạn nhạc. json , hãy thêm bản ghi phụ thuộc phpstan/phpstan 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.
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ương ứng và.

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

Sau khi PHPStan đượ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 PHPStan.

Trong hộp thoại Cài đặt [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 PHPStan và nhấp vào bên cạnh < . Configuration list.
Trong hộp thoại PHPStan mở ra, hãy làm trống đường dẫn PHPStan field.
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 để biết chi tiết.

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

Định cấu hình PHPStan 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 PHPStan để sử dụng

Trong hộp thoại Cài đặt [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 PHPStan . Từ danh sách Cấu hình , chọn tập lệnh PHPStan.
- Để 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, PHPStan 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 PHPStan vì PhpStorm chạy tập lệnh [ phpstan. bat đối với Windows hoặc phpstan đối với 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 PHPStan cục bộ

Tải xuống và cài đặt tập lệnh PHPStan
Để kiểm tra cài đặt PHPStan, hãy chuyển đến thư mục cài đặt và chạy lệnh sau

phpstan --version
Nếu công cụ có sẵn, bạn sẽ nhận được thông báo ở định dạng sau
Đăng ký tập lệnh PHPStan cục bộ trong PhpStorm
1. Trong hộp thoại Cài đặt [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 PHPStan và nhấp vào bên cạnh < . Configuration list.
3. Trong hộp thoại PHPstan mở ra, hãy chỉ định vị trí của phpstan. bat hoặc phpstan PHPStan có thể thực thi được trong đường dẫn PHPStan 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 phpstan. bat hoặc phpstan đảm bảo tương tác giữa PhpStorm và PHPStan, tức là tool 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 phpstan --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 PHPStan được phát hiện. Validate button. This validation is equal to running the phpstan --version command. If validation passes successfully, PhpStorm displays the information on the detected PHPStan version.
Nếu cần, trong trường Thời gian chờ xử lý công cụ , hãy chỉ định khoảng thời gian bạn muốn PhpStorm đợi kết quả từ PHPStan, sau đó quá trình .

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

Trong hộp thoại Cài đặt [Ctrl+Alt+S], đi tới 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 PHPStan và nhấp vào bên cạnh < . Hộp thoại Configuration list. The PHPStan mở ra hiển thị danh sách tất cả các tập lệnh PHPStan được đị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.
Nhấp vào trên thanh công cụ. Trong hộp thoại PHP Stan bởi 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 PHPStan dialog where the new PHPStan configuration is added to the list and the right-hand pane shows the chosen remote PHP interpreter, the path to the PHPStan associated with it, and the advanced PHPStan options.
Nếu cần, trong trường Thời gian chờ xử lý công cụ , hãy chỉ định khoảng thời gian bạn muốn PhpStorm đợi kết quả từ PHPStan, sau đó quá trình .

Định cấu hình PHPStan dưới dạng kiểm tra PhpStorm

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

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

Nếu không có tệp cấu hình 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 với phpstan. neon hoặc phpstan. đèn neon. dist tên mặc định.

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

Cung cấp đối số -c và đường dẫn đến tệp cấu hình
"kịch bản". { "phpstan". "nhà cung cấp/bin/phpstan -c phpstan. đèn neon" }

Sau khi PHPStan đượ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, trên PHP. Trang Công cụ chất lượng của hộp thoại Cài đặt [Ctrl+Alt+S] và các phần phụ thuộc của dự án.

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

Trong hộp thoại Cài đặt [Ctrl+Alt+S], nhấp vào Kiểm tra under Editor.
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 PHPStan .
Nếu bạn có nhưng tính năng kiểm tra tương ứng hiện đang bị vô hiệu hóa, PhpStorm sẽ làm nổi bật 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.
Trên ngăn bên phải của trang, định cấu hình công cụ PHPStan bằng cách sử dụ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 PHPStan. 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 Cấp độ , hãy cung cấp Cấp độ quy tắc mong muốn để thực hiện kiểm tra PHPStan. Lưu ý rằng nếu tệp cấu hình được cung cấp, PhpStorm sẽ dựa vào giá trị được chỉ định trong tệp này và trường Cấp độ sẽ bị bỏ qua.
4. Trong trường Tệp cấu hình , cung cấp đường dẫn đến.
5. Trong Tệp tự động tải , hãy cung cấp đường dẫn đến trình tải tự động. Lưu ý rằng nếu tệp cấu hình được cung cấp, PhpStorm sẽ dựa vào giá trị được chỉ định trong tệp này và trường Tệp tự động tải sẽ bị bỏ qua.
6. Trong trường Giới hạn bộ nhớ , hãy cung cấp dung lượng RAM tối đa mà PHPStan được phép phân bổ. Bạn có thể cung cấp một giá trị số nguyên rõ ràng theo byte hoặc sử dụng [path0, path1, v.v.].
Tùy chọn Chạy toàn bộ dự án [chỉ ở chế độ hàng loạt] chỉ áp dụng khi. Nếu được chọn, toàn bộ dự án được bao gồm trong phạm vi chạy kiểm tra; .

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

Từ menu chính, chọn Mã. Kiểm tra mã .
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 Xác thực PHPStan được bật.
Sử dụng tùy chọn Chạy toàn bộ dự án [chỉ ở chế độ hàng loạt] để chọn xem toàn bộ dự án hay chỉ một dự án có được đưa vào phạm vi chạy kiểm tra hay không.
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 PHPStan báo cáo được thêm tiền tố để phân biệt chúng với các kiểm tra nội bộ của PhpStorm