Trình sửa lỗi php cs psr_autoloading

Ngoài hỗ trợ mã hóa tích hợp, PhpStorm cung cấp kiểm tra mã nguồn thông qua tích hợp với công cụ PHP CS Fixer, công cụ này phát hiện các vấn đề về tiêu chuẩn mã hóa trong mã của bạn

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

Bạn có thể áp dụng các quy tắc được xác định trước hoặc xác định bộ quy tắc tùy chỉnh của riêng mình

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

Trước khi tích hợp PHP CS Fixer 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 CS Fixer phiên bản 2. 8. 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 [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 PHP CS Fixer

Các tập lệnh PHP CS Fixer 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 CS Fixer 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 CS Fixer 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.

  1. Bên trong nhà soạn nhạc. json , hãy thêm bản ghi phụ thuộc friendsofphp/php-cs-fixer vào phần require hoặc ________4____. 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ương ứng và.

Đặt lại cấu hình PHP CS Fixer

Sau khi PHP CS Fixer đượ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 CS Fixer.

  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 PHP CS Fixer và nhấp vào bên cạnh . Configuration list.

  3. Trong hộp thoại PHP CS Fixer mở ra, hãy để trống đường dẫn PHP CS Fixer 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 để biết chi tiết.

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

Định cấu hình PHP CS Fixer 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 đượ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 CS Fixer để sử dụng

  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 PHP CS Fixer . Từ danh sách Cấu hình , chọn tập lệnh PHP CS Fixer.

    • Để 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, Trình sửa lỗi CS PHP 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 CS Fixer vì PhpStorm chạy tập lệnh [ php-cs- . bat cho Windows hoặc php-cs-fixer 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 dialog, choose By default project interpreter.

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

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

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

    php-cs-fixer --version

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

    Trình sửa lỗi PHP CS 2. 13. 0 Yogi's BBQ của Fabien Potencier và Dariusz Ruminski

    Để 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à . php_cs hoặc php_cs. dist tệp trỏ đến chúng trong thư mục gốc rulesets .

  2. Đăng ký tập lệnh PHP CS Fixer 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 PHP CS Fixer và nhấp vào bên cạnh . Configuration list.

    3. Trong hộp thoại PHP CS Fixer mở ra, hãy chỉ định vị trí của php-cs- . bat hoặc php-cs-fixer PHP CS Fixer có thể thực thi được trong PHP . Nhập đường dẫn theo cách thủ công hoặc nhấp vào 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 php-cs-fixer. bat hoặc php-cs-fixer đảm bảo tương tác giữa PhpStorm và PHP CS Fixer, nghĩa là công cụ này có thể được . Việc xác thực này tương đương với việc chạy lệnh php-cs-fixer --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 CS Fixer được phát hiện. Validate button. This validation is equal to running the php-cs-fixer --version command. If validation passes successfully, PhpStorm displays the information on the detected PHP CS Fixer version.

  3. 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ừ PHP CS Fixer, sau đó .

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

  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 PHP CS Fixer và nhấp vào bên cạnh . Hộp thoại Configuration list. The PHP CS Fixer mở ra hiển thị danh sách tất cả các tập lệnh PHP CS Fixer đượ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.

  3. Nhấp vào trên thanh công cụ. Trong hộp thoại PHP CS Fixer by Remote Interpreter 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 CS Fixer dialog where the new PHP CS Fixer configuration is added to the list and the right-hand pane shows the chosen remote PHP interpreter, the path to the PHP CS Fixer associated with it, and the advanced PHP CS Fixer options.

  4. 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ừ PHP CS Fixer, sau đó .

Định cấu hình PHP CS Fixer làm kiểm tra PhpStorm

Cấu hình kiểm tra PHP CS Fixer với Composer

Bạn có thể bao gồm thông tin về bộ quy tắc PHP CS Fixer mặc định và tùy chỉnh bên trong phần tập lệnh của composer. json . Khi bạn hoặc dự án phụ thuộc, các bộ quy tắc được chỉ định sẽ được phát hiện và kiểm tra PHP CS Fixer 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 nhà soạn nhạc. 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 . php_cs hoặc . php_cs. dist 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 , thêm lệnh khởi chạy php-cs-fixer PHP CS Fixer vào một trong các phần tử lá.

    Cung cấp đối số --rules để 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 PSR1 .

    "kịch bản". { "php-cs-fixer". "php-cs-fixer --rules=@PSR1" }

    Hoặc, cung cấp đối số path0 và đường dẫn đến tệp bộ quy tắc, tệp này sẽ đặt tiêu chuẩn viết mã thành Tùy chỉnh .

    "kịch bản". { "php-cs-fixer". "php-cs-fixer --config=. /. php_cs" }

Sau khi PHP CS Fixer đượ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 PHP CS Fixer theo cách thủ công

  1. Trong hộp thoại Cài đặt [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 CS Fixer .

    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.

  3. Trên ngăn bên phải của trang, định cấu hình công cụ PHP CS Fixer 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 việc kiểm tra PHP CS Fixer. 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. Để cho phép , tức là các quy tắc có thể thay đổi hành vi của mã, hãy chọn hộp kiểm Cho phép các quy tắc rủi ro đối với bộ quy tắc tích hợp sẵn . Theo mặc định, các quy tắc rủi ro không được phép.

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

      • Để sử dụng một trong các kiểu được xác định trước , hãy chọn 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 dựa trên. Danh sách chứa tất cả các tiêu chuẩn viết mã được khai báo bên trong cấu trúc thư mục chính php-cs-fixer .

      • Để 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 Duyệt qua và trong hộp thoại Tiêu chuẩn mã hóa tùy chỉnh mở ra, hãy chỉ định . php_cs .php_cs hoặc . php_cs. dist 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 Duyệt qua và chọn thư mục có liên quan trong hộp thoại mở ra.

Chia sẻ phong cách mã hóa tùy chỉnh với nhóm

  1. Đặt thư mục gốc của tiêu chuẩn mã hóa của bạn dưới

  2. .

  3. .

  4. Đảm bảo rằng hồ sơ dự án được chọn ở đầu trang Kiểm tra. Những cấu hình như vậy được lưu trong của một dự án cụ thể. thư mục idea [ví dụ: $PROJECT_DIR$/. idea/inspectionProfiles ]. Xem Cấu hình cấu hình để biết chi tiết.

  5. Trên trang Kiểm soát phiên bản của hộp thoại Cài đặt , đảm bảo rằng . thư mục idea được đặt.

Chạy PHP CS Fixer ở 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 quá trình kiểm tra PHP CS Fixer được thực hiện .

  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 CS Fixer báo cáo có tiền tố là PHP CS Fixer để phân biệt chúng với các cuộc kiểm tra nội bộ của PhpStorm

Chủ Đề