Cài Đặt WordPress Coding Standards Cho Phpstorm
--- Bài mới hơn ---
TL;DR
Bài viết sẽ hướng dẫn bạn cài đặt PHP Code Sniffer kết hợp với WordPress Coding Standards trên PhpStorm. Tuy nhiên trước khi cài đặt, chúng ta tản mạn xíu.
Viết code như làm thơ
WordPress có một câu sologan nổi tiếng “Code is Poetry” có thể tạm dịch là “Viết code như làm thơ”. Quả đúng như vậy, công việc lập trình không phải là thứ gì đó khô khan, cứng nhắc hay tẻ nhạt chỉ có if cái này then cái kia. Nhưng nó còn ẩn chứa rất nhiều điều thú vị.
Khi làm văn hay thơ, bước đầu bạn có thể phải lên dàn ý, draft ý tưởng. Nhưng cuối cùng bạn phải chỉnh sửa lại bài văn hay bài thơ đó cho thật đẹp mắt, mạch văn phải trôi chảy, kiểm tra lỗi chính tả, ngữ pháp v.v.. với mục đích trước tiên là để bạn dễ dàng đọc, dễ dàng chỉnh sửa sau này, tiếp đến là hướng tới người đọc.
Việc viết code cũng tương tự, bạn cũng phải “viết code đẹp” để có thể maintain code của chính mình và cho người khác dễ dàng contribute. Và “viết code đẹp” đấy chính là viết theo chuẩn, vì những gì đẹp, đúng đắn và thống nhất đều xuất phát từ một tiêu chuẩn giá trị có sẳn nào đó.
Tại sao phải code theo chuẩn
Nếu mong muốn công ty không bao giờ sa thải bạn vì code của bạn không ai có thể maintain được ngoài bạn thì bạn có thể bỏ qua bài này và đọc những bài viết khác của 12bit.
Đi sâu hơn một chút về việc tại sao cần code theo chuẩn thì có vài điều sau để thuyết phục một lập trình viên phải “viết code đẹp”:
- Giúp thần thái coding của bạn được tôn lên một đẳng cấp khác.
- Việc code theo một tiêu chuẩn đã được công nhận sẽ giúp bạn hòa mình vào cộng đồng coder thế giới một cách dễ dàng. Nếu bạn muốn contribute vào một project nào đó, bắt buộc bạn phải code theo chuẩn của project đó. Team của bạn sẽ trở nên đoàn kết yêu thương nhau hơn vì tất cả đã có chung một tiêu chuẩn, ai cũng có thể contrubite vào một project mà không sợ bị conflict style. Sếp của bạn chắc hẳn sẽ rất yên tâm.
- Bạn sẽ thêm yêu cuộc sống khi nhìn vào code của mình.
- Sếp bạn yêu cầu!
Còn nhiều lí do nữa, nhưng mà mình không liệt kê hết ra đây. Như vậy cũng đủ để thuyết phục một coder chân chính phải viết code theo chuẩn.
Code theo chuẩn WordPress
Mỗi ngôn ngữ, framwork đều có một tiêu chuẩn (Coding standard) riêng. WordPress cũng không năm ngoài số đó.
WordPress đã xây dựng một handbook đầy đủ coding standards cho PHP, HTML, CSS và Javascript. Bài viết này sẽ tập trung vào phần PHP và cách sử dụng PhpStorm để có thể code PHP theo chuẩn của WordPress một cách dễ dàng.
Cách code PHP theo chuẩn của WordPress đã được ghi rất cụ thể và mình sẽ không đi chi tiết phần này.
Bây giờ chúng ta sẽ đến phần cài đặt PHP Code Sniffer cho PhpStorm kết hợp với WordPress Coding Standards để PhpStorm có thể highlight mỗi khi code không theo chuẩn cũng như giúp format code chuẩn hơn.
À mà khoan! Tại sao lại phải cài những thứ này? Nếu bạn chắc mình có thể nhớ hết các tiêu chuẩn và không bao giờ thiếu xót thì có thể bạn không cần phải cài đâu.
Cài đặt PHP Code Sniffer cho PhpStorm
Bạn hãy truy cập vào repo của PHP Code Sniffer (phpcs) trên Github https://github.com/squizlabs/PHP_CodeSniffer và xem hướng dẫn cài đặt. Mình chọn cách cài đặt bằng Composer để thuận tiện cho việc tích hợp với PhpStorm.
composer global require "squizlabs/php_codesniffer=*"
Sau khi bật lên bạn sẽ thấy 3 setting chính đó là:
- PHP Code Sniffer (phpcs) Path: Đường dẫn tới phpcs.
- Maximum number of messages per file: đây là thời gian timeout để phpcs check lỗi. Nếu bạn để timeout quá thấp thì không thể check hết lỗi của một file (nếu file đó có quá nhiều lỗi).
Để phpcs hoạt động trong PhpStorm bạn phải load file chúng tôi đã được tải về bằng Composer, đường dẫn cho file này phụ thuộc vào hệ điều hành của bạn. Mình đang dùng Windows 10 nên đường dẫn sẽ là:
Để xem phpcs sẽ báo lỗi gì?
--- Bài cũ hơn ---
