問題タブ [codesniffer]

コードベースの品質を向上させるために、継続的インテグレーション サーバーにPHP CodeSnifferをセットアップするというアイデアに手を出しています。ドキュメントを読んだ後、コーディング標準を標準化して強制するというアイデアに非常に興奮しています。しかし、私たちの製品の実際の改善については疑問に思っています. スニファーが定義されたコーディング標準への違反のみを検出することはよく知っていますが、クリーンで一貫性のあるコードベースにはどのような利点がありますか? PEAR 標準に準拠するために 10 万行以上のコードを含むプロジェクトをリファクタリングするのに余分な作業をする価値はありますか?

PHP CodeSniffer や code-smell に慣れていない方のために、出力例を次に示します。

ファイル: /path/to/code/myfile.php
FOUND 5 ERROR(S) AFFECTING 2 LINE(S)
--
2 | エラー | ファイル ドキュメント コメントがありません
20 | エラー | PHP キーワードは小文字にする必要があります。"false" と予想されていましたが、"FALSE" が見つかりました
47 | エラー | 行が正しくインデントされていません。4 つのスペースが必要でしたが、1
51 |見つかりました。エラー | 関数ドキュメントのコメントがありません
88 | エラー | 行が正しくインデントされていません。9 個のスペースが必要でしたが、6 個見つかりました

厳密に言えば、ユーザー/クライアントは、標準に準拠するようにリファクタリングされた製品の違いに気付かないでしょうが、他に隠れた利点があるかどうか疑問に思っています

現在、私たちのコードは決してずさんではなく、Pear's Coding Standardsから派生した独自の基準に従うように努めていますが、訓練された目で違いを見つけることができます。

だから私の質問は、それらが製品の品質をどれだけ改善するかということです. それによってどのような潜在的な利益が生じましたか？

製品を一連の基準に近づけたいという欲求に、強迫観念を抱いているだけですか? それは価値があるでしょうか？もしそうなら、コードスニファーを実装し、検出されたその後の違反を修正するためにどのような戦略を使用しましたか?

私はphpUnderControlをセットアップしましたが、PHP-CodeBrowserタブに出力が得られないいくつかのプロジェクトを除いて、すべてうまく機能しています。

コマンドを手動で実行すると、次のようになります。

PHP-CodeSniffer の checkstyle.xml 出力で追跡できます。を含む：

私がうまくいかないのは、phpcbがパスの半分を落としている理由です。sourceパスに2回表示されるという事実に問題があるのは、何らかの形式のパス置換(私の --source パスに基づく)であると推測しています。欠落しているパスのセクションは、指定されたソース パスと最後のsource.

Phpcb でバグを見つけましたか? もしそうなら、どこに報告できますか？phpcb が存在する場所に私が見つけた最も近いものは、残念ながら phpUnit github の壊れた URL にリンクしているphpUnderControl リリース ページのリンクです。

Ant を使用してプロジェクトをビルドし、ドキュメントを生成し、コーディング規約違反をチェックしています。execタスクを介して外部ツールを使用しています。Exec は、出力行の前に[exec]
This string messes my output up を付けます。コマンドラインでスイッチを指定すると、-e静かなままになります。

する方法はありますか

• -ebuild.xml ファイルで実行ごとにスイッチを指定しますか?
• または同等のもの。

PHP CodeSnifferを使用してリモートgitリポジトリにコミットされたコードを確認し、コード標準に問題がある場合は拒否したいと思います。誰かがgitリモートリポジトリでそれを使用する方法の例、または多分pre-receiveフックでそれを使用する方法の例を持っていますか？ありがとう。

さて、私はPHPCSからかなり奇妙なエラーを受け取っています：

ここで何が起こっているかについてのヒントはありますか？PEARのバグレポートにも同様のことが記載されていますが、2009年に修正されたようです。最新バージョンのPHPCSを実行しているので、どう考えてください。

私は最近、CruisControlに基づく継続的インテグレーションサーバーであるPHPUnderControlをセットアップしようとしています。私が実行したいチェックの一部は、「コードの臭い」を検出するためのPHP CodeSniffer（PHPCS）です。ただし、これをコードベースで実行すると、非常に多くの問題が検出されます。これらのほとんどは、svn：externalsディレクティブを介してSVNリポジトリに含めたライブラリにあるため、私の管理下にはありません。

PHP_CodeSniffer他の部分を検証しながら、SVNリポジトリの一部を無視するように指示することは可能ですか？

PHP 5 Web アプリケーションがあり、コード標準を強制することでコード品質が向上するかどうかを判断するために、現在PHP CodeSnifferを評価しています。

私たちはコード リポジトリと展開ベースにSubversionを使用しており、SVN pre-commit フックを追加して、コミットされたすべてのファイルにコーディング標準の匂いがないようにしています。フックは技術的には機能しますが、実際に役立つには頭痛の種が多すぎます。

1. サイトの停止を引き起こしている緊急のバグを修正する必要がある場合、最後に必要なのは、マイナーな空白のインデントの問題が原因でコミットが拒否されることです。
2. 時には何百もの phpcs エラーを含む大量のレガシー コードがあります。現在、これらのファイルのすべての phpcs エラーを修正することは現実的ではありません。1 つの例は、ドキュメント コメントを持たない関数でいっぱいのファイルです。別の例として、クラス名が小文字で始まる場合、エラーがスローされますが、これを修正するには、コミットが必要な 10、20 以上のファイルを変更する必要があり、その後盗聴され、再帰されます...
3. 少し大きなファイル (たとえば 4000 行のコード) がいくつかあり、phpcs はそれらをチェックするのに数分かかります。この長さだけコミットを遅らせることは容認できません。
4. これはまだテストしていませんが、svn ブランチを実行してコミットすると、phpcs はすべてをチェックし、1000 個のファイルすべてをチェックするのに非常に長い時間がかかると思いますか?

今日、コードベース全体をリファクタリングできないことを考えると、svn pre-commit フックに phpcs を実行しないように指示する svn commit パラメータを使用する方法を知っている人はいますか?

または、説明されている頭痛を取り除く別の方法があるのでしょうか?

Windows XP で XAMPP を実行しています。PHP_CodeSniffer をダウンロードしただけで、実行方法がわかりません。

ありがとうございました

Zendコーディング標準に従うようにNetbeansPHPを構成するにはどうすればよいですか？

私はこれにかなり苦労していますが、それでも複数行の関数引数でphpcsエラーが発生します。

設定を共有しますか？

PHPコードスニファー用のカスタムruleset.xmlを作成しようとしていますが、デフォルトのフォルダーに配置せずにコマンドラインから呼び出すと機能しないようです。

ドキュメントには別の方法が記載されているようですので、ここで何か間違ったことをしているのかどうか尋ねたいと思います

それがうまくいかない場合：独自のコーディング標準をソースと一緒に出荷する方法について何か提案はありますか？ありがとう