Cara Memastikan Kualiti Kod Magento2: Gunakan Magento/Magento-Coding-Standard

Anda boleh belajar komposer melalui alamat berikut:

Memastikan kualiti kod adalah bahagian penting apabila membangunkan sambungan Magento 2. Projek Magento 2 biasanya melibatkan logik kompleks dan banyak kod tersuai, yang boleh membawa kepada kesilapan dan kesukaran penyelenggaraan tanpa standard kod yang ketat. Nasib baik, perpustakaan standard Magento/Magento-coding memberikan kami satu set peraturan kod PHP yang berdedikasi yang dapat membantu kami dengan cepat memeriksa dan mengoptimumkan kualiti kod.

Pasang

Menggunakan standard Magento/Magento-Coding dalam projek Magento 2 sangat mudah, anda hanya perlu melaksanakan arahan berikut dalam direktori root projek:

 <code class="bash">composer require --dev magento/magento-coding-standard</code>

Oleh kerana pertimbangan keselamatan, standard Magento perlu ditambah secara manual kepada PHPC selepas pemasangan. Anda boleh menambah skrip berikut ke fail composer.json untuk melengkapkan langkah ini secara automatik:

 <code class="json">"scripts": { "post-install-cmd": [ "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)" ], "post-update-cmd": [ "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/)" ] }</code>

gunakan

Selepas pemasangan selesai, anda boleh menganalisis kod anda melalui arahan berikut:

 <code class="bash">vendor/bin/phpcs --standard=Magento2 app/code/MyAwesomeExtension</code>

Jika anda menemui beberapa masalah yang boleh diperbaiki secara automatik, anda juga boleh menggunakan arahan phpcbf :

 <code class="bash">vendor/bin/phpcbf --standard=Magento2 app/code/MyAwesomeExtension</code>

Sahkan pemasangan

Anda boleh mengesahkan bahawa magento/magento-coding-standard dipasang dengan betul oleh:

 <code class="bash">vendor/bin/phpcs -i</code>

Perintah ini mengembalikan senarai piawaian pengekodan yang dipasang, yang sepatutnya termasuk Magento2.

menyumbang

Jika anda berminat dengan magento/magento-coding-standard dan ingin menyumbang, anda boleh bermula dari aspek berikut:

• Meningkatkan dokumentasi untuk peraturan yang ada.
• Betulkan pepijat yang diketahui dan memperbaiki peraturan yang ada.
• Buat peraturan PHP CodesNiffer baru.
• Mengambil bahagian dalam perbincangan mengenai peraturan baru.

Langkah -langkah sumbangan khusus boleh didapati dalam model sumbangan komuniti.

ujian

Semua peraturan harus mempunyai liputan ujian unit. Anda boleh menjalankan ujian dengan arahan berikut:

 <code class="bash">vendor/bin/phpunit</code>

Di samping itu, anda juga boleh menggunakan arahan berikut untuk memastikan bahawa kod sniffer itu sendiri mematuhi standard pengekodan magento:

 <code class="bash">vendor/bin/phpcs --standard=Magento2 Magento2/ --extensions=php</code>

Kelebihan dan kesan aplikasi praktikal

Manfaat menggunakan magento/magento-coding-standard adalah jelas. Ia bukan sahaja membantu kami dengan cepat menemui dan menyelesaikan masalah dalam kod kami, tetapi juga memastikan bahawa kod kami mematuhi piawaian Magento, dengan itu meningkatkan kebolehbacaan dan pemeliharaan kod kami. Dalam aplikasi praktikal, saya mendapati bahawa alat ini bukan sahaja meningkatkan kualiti kod, tetapi juga mengurangkan kebarangkalian kesilapan yang berlaku semasa pembangunan, meningkatkan kecekapan pembangunan.

Singkatnya, magento/magento-coding-standard adalah alat yang sangat praktikal yang sangat diperlukan untuk mana-mana pemaju Magento 2. Dengan alat ini, kami dapat dengan lebih mudah memastikan kualiti kod, dengan itu meningkatkan kestabilan dan prestasi keseluruhan projek.

Atas ialah kandungan terperinci Cara Memastikan Kualiti Kod Magento2: Gunakan Magento/Magento-Coding-Standard. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!