https://github.com/ging-dev/psalm-walkthrough
Sử dụng Psalm (PHP Static Analysis Linting Machine) trên vscode
https://github.com/ging-dev/psalm-walkthrough
Last synced: 11 months ago
JSON representation
Sử dụng Psalm (PHP Static Analysis Linting Machine) trên vscode
- Host: GitHub
- URL: https://github.com/ging-dev/psalm-walkthrough
- Owner: ging-dev
- Created: 2022-02-05T11:08:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-05T13:11:41.000Z (almost 4 years ago)
- Last Synced: 2025-01-13T14:19:16.250Z (about 1 year ago)
- Language: PHP
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Psalm là gì?
Psalm được phát triển bởi Vimeo trong bối cảnh năm 2015 thì khối lượng codebase của Vimeo đã trở nên vô cùng lớn, phục vụ hàng triệu requests mỗi giờ.
Mặc dù codebase hiện tại vẫn hoạt động bình thường nhưng khi thay đổi code ở 1 file, để có thể biết được nó có ảnh hưởng đến các chức năng khác hay không thì chỉ có cách đẩy lên production và sẵn sàng rollback 😢 Refactor trở nên khó khăn và codebase vẫn tiếp tục trở nên phình to ra.
Và Psalm đã được ra đời với các chức năng:
- Hạn chế errors khi thực hiện nhiều refactor
- Đảm bảo chất lượng code trong một team lớn
- Đảm bảo không có lỗi nào liên quan đến kiểu dữ liệu khi chạy
- Cung cấp công cụ tự động fix một số lỗi thông thường
## Cài đặt Psalm trên vscode
Trước tiên, hãy tìm psalm trong extensions của Visual Studio Code và cài đặt nó:
Extension này cung cấp language server giữa psalm và vscode.
Cài đặt psalm trong dự án của bạn thông qua `composer`:
```bash
composer require --dev vimeo/psalm
```
Chạy lệnh:
```bash
./vendor/bin/psalm --init
```
Psalm sẽ scan tất cả các file trong dự án của bạn và tạo ra một file `psalm.xml`.
## Sử dụng
Ở đây mình tạo 1 file `example.php` có nội dung như sau:
```php
data = $data;
}
/**
* @return T
*/
public function getData()
{
return $this->data;
}
}
/** @var Data */
$data = new Data(new stdClass());
// Sẽ báo lỗi vì $data->getData() trả về stdClass, bạn không thể echo nó
echo $data->getData();
```