Hướng dẫn phpstan config - cấu hình phpstan
|
Thực đơn Show
Định dạng neon #Phpstan sử dụng định dạng cấu hình được gọi là neon. Nó rất giống với YAML vì vậy nếu bạn quen thuộc với nó, bạn cũng có thể viết neon. Đây là cách một ví dụ có thể của tệp cấu hình có thể trông giống như: Tập tin cấu hình #Một tệp cấu hình có thể được chuyển cho Khi sử dụng tệp cấu hình, bạn phải chuyển tùy chọn Nếu bạn không cung cấp tệp cấu hình một cách rõ ràng, PHPSTAN sẽ tìm các tệp có tên Ưu tiên độ phân giải là như vậy:
Thực tiễn thông thường là có Nhiều tệp #Định dạng neon hỗ trợ phần Nếu người dùng không có các tiện ích mở rộng PHP nhất định, muốn bỏ qua một số lỗi được báo cáo từ phân tích và để vô hiệu hóa xử lý CPU song song, họ có thể tạo tệp Các đường dẫn tương đối trong phần Bỏ qua lỗi #Tìm hiểu thêm về việc bỏ qua các lỗi trong Hướng dẫn sử dụng. Các khóa cấu hình liên quan: Khám phá các ký hiệu #Tìm hiểu thêm về khám phá các ký hiệu trong Hướng dẫn sử dụng. Các khóa cấu hình liên quan: Bootstrap #Nếu bạn cần khởi tạo một cái gì đó trong thời gian chạy PHP trước khi phpstan chạy (như trình tải tự động của riêng bạn), bạn có thể cung cấp các tệp bootstrap của riêng mình: Các đường dẫn tương đối trong khóa Bộ nhớ đệm #Theo mặc định, PHPSTAN lưu trữ các tệp bộ đệm của mình trong Đường dẫn tương đối trong khóa Các tệp được phân tích #Phpstan chấp nhận danh sách các tệp và thư mục trên dòng lệnh: Bạn có thể lưu một số tổ hợp phím mỗi khi bạn chạy PHPSTAN bằng cách di chuyển các đường dẫn được phân tích vào tệp cấu hình: Các đường dẫn tương đối trong khóa Nếu bạn cung cấp các đường dẫn được phân tích đến PHPSTAN trên dòng lệnh và trong tệp cấu hình cùng một lúc, chúng không được hợp nhất. Chỉ các đường dẫn trên dòng lệnh sẽ được sử dụng. Nếu cơ sở mã của bạn chứa một số tệp bị hỏng có mục đích (e. G. Để kiểm tra hành vi của ứng dụng của bạn trên các tệp có mã PHP không hợp lệ), bạn có thể loại trừ chúng bằng khóa Đây là một lối tắt cho: Nếu cấu trúc thư mục của dự án của bạn trộn mã của riêng bạn (mã bạn muốn phân tích và sửa lỗi trong) và mã bên thứ ba (mà bạn đang sử dụng để khám phá các ký hiệu, nhưng không muốn phân tích), cấu trúc tệp có thể trông giống như đây: Trong trường hợp này, bạn muốn phân tích toàn bộ thư mục Ngoài ra, có thể có một thư mục Theo mặc định, PHPSTAN chỉ phân tích các tệp với tiện ích mở rộng Cấp độ quy tắc #Tìm hiểu thêm về các cấp quy tắc trong Hướng dẫn sử dụng. Thay vì sử dụng tùy chọn CLI Quy tắc tùy chỉnh #Phpstan yêu cầu bạn chỉ định một cấp độ để chạy, điều đó có nghĩa là nó sẽ chọn các quy tắc được thực thi cho bạn. Nếu bạn không muốn tuân theo các cấp độ quy tắc được xác định trước và muốn tạo quy tắc của riêng mình, hãy nói với Phpstan không yêu cầu một cấp bằng cách đặt Sau đó, bạn có thể chọn quy tắc của riêng mình bằng cách sao chép các phần của các tệp cấu hình cấp từ các nguồn PHPSTAN hoặc bao gồm các quy tắc tùy chỉnh của riêng bạn. Giải các biến không xác định #Tìm hiểu thêm về việc giải các biến không xác định trong việc viết mã PHP. Các khóa cấu hình liên quan: Các thùng đối tượng phổ quát #Các lớp không có cấu trúc được xác định trước là phổ biến trong các ứng dụng PHP. Chúng được sử dụng làm người giữ dữ liệu phổ quát - bất kỳ thuộc tính nào cũng có thể được đặt và đọc trên chúng. Các ví dụ đáng chú ý bao gồm Hằng số #Tìm hiểu thêm về việc cho Phpstan biết về các hằng số toàn cầu của bạn trong Hướng dẫn sử dụng. Đôi khi các hằng số của bạn có thể có các giá trị khác nhau trong các môi trường khác nhau, như Tệp stub #Tìm hiểu thêm về các tập tin sơ khai trong Hướng dẫn sử dụng. Khóa cấu hình liên quan: Phân tích chặt chẽ hơn #Hiện tại ngoài các cấp quy tắc Có các tham số bổ sung ảnh hưởng đến kết quả phân tích mà bạn có thể điều chỉnh. parameters: excludePaths: - tests/*/data/*9 #Mặc định: Ví dụ: với Khi được đặt thành parameters: excludePaths: analyseAndScan: - tests/*/data/*7 #Mặc định: Ví dụ: với Khi được đặt thành parameters: excludePaths: analyseAndScan: - tests/*/data/*7 #Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành
Mặc định: Ví dụ: Với parameters: excludePaths: analyseAndScan: - tests/*/data/*1, với parameters: excludePaths: analyseAndScan: - tests/*/data/*0Khi được đặt thành vendor/bin/phpstan analyse -c phpstan.neon65 #Mặc định: Khi được đặt thành vendor/bin/phpstan analyse -c phpstan.neon68 #Mặc định: Ví dụ: Với Khi được đặt thành vendor/bin/phpstan analyse -c phpstan.neon74 #Có sẵn trong Phpstan 1.8.0 Mặc định: Theo mặc định, PHPSTAN coi tất cả các chức năng trả về giá trị là thuần khiết. Điều đó có nghĩa là cuộc gọi thứ hai đến cùng một hàm trong cùng một phạm vi sẽ trả về cùng loại bị thu hẹp: Đây là một mặc định lành mạnh trong trường hợp getters nhưng đôi khi chúng ta có một hàm có thể trả về các giá trị khác nhau dựa trên trạng thái toàn cầu như trình tạo số ngẫu nhiên, cơ sở dữ liệu hoặc thời gian. Bạn có thể đánh dấu vendor/bin/phpstan analyse -c phpstan.neon80 #Mặc định: Khi được đặt thành Ngoại lệ #Các quy tắc liên quan đến ngoại lệ nâng cao có sẵn. Đọc bài viết này để biết thêm chi tiết ». Các khóa cấu hình liên quan: Tiểu đồ mơ hồ #Cấp 6 kiểm tra các kiểu chữ bị thiếu. Không chỉ nó báo cáo khi không có kiểu chữ nào cả, mà còn khi nó không đủ cụ thể. Phpstan cần biết về các loại mục mảng. Vì vậy, Nếu bạn muốn sử dụng Cấp 6 để báo cáo các loại hình ảnh bị thiếu, nhưng vẫn ổn với Nếu bạn sử dụng thuốc generic, một điều khác mà Cấp 6 làm là nó yêu cầu các biến loại luôn được chỉ định trong TypeHints. Vì vậy, Bạn có thể vô hiệu hóa cách tiếp cận nghiêm ngặt này đối với thuốc generic bằng cách đặt khóa Nếu bạn sử dụng các thiết bị gọi, bạn có thể thấy rằng Tuy nhiên, theo mặc định, PHPSTAN đã giành được khiếu nại nếu bạn không chỉ định chữ ký cho việc gọi hoặc đóng. Bạn có thể làm cho PHPSTAN yêu cầu chữ ký có thể gọi được được chỉ định với cú pháp PHPDOC có thể gọi PHPSTAN bằng cách đặt khóa Nhập bí danh #Tìm hiểu thêm về các bí danh loại bằng văn bản mã PHP. Khóa cấu hình liên quan: Tiến trình song song #Phpstan chạy trong nhiều luồng theo mặc định, tận dụng nhiều lõi trong CPU của bạn. Nó sử dụng một công thức để tìm ra có bao nhiêu quá trình con để sinh sản. Các quy trình của con được cung cấp các công việc trên mạng - mỗi công việc đại diện cho một loạt một số lượng tệp nhất định để xử lý. Các đầu vào cho công thức là:
Các biến này có thể được thay đổi trong cấu hình. Đây là mặc định: Bạn có thể gặp phải thông báo lỗi này khi chạy phpstan:
Điều này có thể xảy ra khi một công việc duy nhất mất nhiều thời gian hơn so với thời gian chờ đã đặt. Nó ngăn PHPSTAN chạy vô thời hạn khi có điều gì đó bất ngờ xảy ra. Trong trường hợp các tệp lớn, có thể bình thường là phân tích của một số trong số chúng mất nhiều thời gian hơn. Bạn có thể làm cho thời gian chờ dài hơn trong cấu hình: Để vô hiệu hóa xử lý song song hoàn toàn, đặt Xử lý song song cũng bị vô hiệu hóa khi chạy với Url url có thể nhấp #Bạn có thể định cấu hình PHPSTAN để hiển thị URL Trình chỉnh sửa có thể nhấp dẫn đến tệp và dòng có lỗi trong định dạng lỗi Khóa cấu hình liên quan: Tham số linh tinh #parameters: level: 6 paths: - src - tests18 #Mặc định: Nếu bạn muốn phân tích một cơ sở mã như thể nó được viết cho một phiên bản PHP khác với bạn đang chạy, hãy thay đổi tham số PHPSTAN sẽ tự động suy ra phiên bản parameters: level: 6 paths: - src - tests23 #Mặc định: Khi được đặt thành parameters: level: 6 paths: - src - tests26 #Mặc định: Ví dụ: với Phpstan theo mặc định không phân biệt giữa các loại PHPDOC và các loại gốc. Nó coi cả hai đều chắc chắn. Đây có thể không phải là những gì bạn muốn trong trường hợp bạn viết một thư viện mà người dùng có thể chuyển một loại đối số sai cho một hàm. Đặt parameters: level: 6 paths: - src - tests32 #Mặc định: Ví dụ: với Phpstan theo mặc định không phân biệt giữa các loại PHPDOC và các loại gốc. Nó coi cả hai đều chắc chắn.Đây có thể không phải là những gì bạn muốn trong trường hợp bạn viết một thư viện mà người dùng có thể chuyển một loại đối số sai cho một hàm. Đặt Thỉnh thoảng, PHPSTAN cho thấy các mẹo của ngày trong ngày khi kết thúc một phân tích thành công. Bạn có thể tắt điều này bằng cách đặt khóa parameters: level: 6 paths: - src - tests32 thành parameters: excludePaths: analyseAndScan: - tests/*/data/*1.
Mở rộng đường dẫn # Có hai tham số được xác định trước có thể sử dụng để mở rộng trong các tham số cấu hình đại diện cho các đường dẫn: Chúng không còn hữu ích vì tất cả các đường dẫn tương đối trong các tham số cấu hình được giải quyết dựa trên thư mục của tệp cấu hình, dẫn đến một ký hiệu ngắn và ngắn gọn.Xem xét cấu trúc thư mục này: Để tham khảo tệp Để tham khảo Tham số tùy chỉnh #
Phpstan không cho phép các tham số không xác định có mặt trong cấu hình để ngăn lỗi chính tả. Bất kỳ tham số mới nào cũng cần được thêm vào phần |
