Magento2コードの品質を確保する方法：Magento/Magento-Coding-Standardを使用する

次の住所から作曲家を 学ぶことができます。

Magento 2拡張機能を開発する際には、コードの品質を確保することが重要な部分です。 Magento 2プロジェクトには通常、複雑なロジックと多くのカスタムコードが含まれます。これは、厳格なコード標準なしではエラーやメンテナンスの困難に簡単につながる可能性があります。幸いなことに、Magento/Magento-Coding-Standard Libraryは、コードの品質を迅速にチェックおよび最適化するのに役立つ専用のPHP CodesNifferルールのセットを提供します。

インストール

Magento 2プロジェクトでMagento/Magento-Coding-Standardを使用することは非常に簡単です。プロジェクトルートディレクトリで次のコマンドを実行するだけです。

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

セキュリティ上の考慮事項により、Magento標準をインストール後にPHPCSに手動で追加する必要があります。次のスクリプトをcomposer.jsonファイルに追加して、この手順を自動的に完了できます。

 <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>

使用

インストールが完了したら、次のコマンドを使用してコードを分析できます。

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

自動的に修正できるいくつかの問題がある場合は、 phpcbfコマンドを使用することもできます。

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

インストールを確認します

Magento/Magento-Coding-Standardが正しく設置されていることを確認できます。

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

このコマンドは、Magento2を含む必要があるインストールされているエンコード標準のリストを返します。

貢献する

Magento/Magento-Coding Standardに興味があり、貢献したい場合は、次の側面から始めることができます。

• 既存のルールのドキュメントを改善します。
• 既知のバグを修正し、既存のルールを改善します。
• 新しいPHP CodesNifferルールを作成します。
• 新しいルールの議論に参加します。

特定の貢献手順は、コミュニティ貢献モデルにあります。

テスト

すべてのルールには、ユニットテストカバレッジが必要です。次のコマンドでテストを実行できます。

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

さらに、次のコマンドを使用して、スニファーコード自体がMagentoコーディング標準に準拠していることを確認することもできます。

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

利点と実用的なアプリケーション効果

Magento/Magento-Coding-Standardを使用することの利点は明らかです。コードの問題を迅速に発見して修正するのに役立つだけでなく、コードがMagentoの標準に準拠しているため、コードの読みやすさと保守性が向上することも保証します。実際のアプリケーションでは、このツールはコードの品質を改善するだけでなく、開発中に発生するエラーの確率を低下させ、開発効率を大幅に改善することがわかりました。

要するに、Magento/Magento-Coding-Standardは、Magento 2開発者にとって不可欠な非常に実用的なツールです。このツールを使用すると、コードの品質をより簡単に確保できるため、プロジェクト全体の安定性とパフォーマンスが向上します。

以上がMagento2コードの品質を確保する方法：Magento/Magento-Coding-Standardを使用するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。