phpqaconfigダウンロード - phpqaconfigソースコードのダウンロード

phpqaconfig

LoVullo Associates のコーディング標準に固有の QA および開発ツールの構成。 lovullo/phpqatoolsと組み合わせたこのパッケージは、新しい PHP プロジェクトのベースとなることを目的としています。

インストール

プロジェクトのcomposer.jsonでそれを要求するだけです

    "require-dev" : {
        "lovullo/phpqaconfig" : " @stable "
    }

または

$ composer require --dev lovullo/phpqaconfig

使用法

プロジェクトのセットアップ

プロジェクトルートに次の内容のbuild.xmlファイルを作成します。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

プロジェクトのルートに次の内容のphpunit.xmlファイルを作成します。

xml version = " 1.0 " encoding = " UTF-8 " ?>
< phpunit verbose = " true " >
  < testsuites >
    < testsuite name = " ProjectName " >
      < directory suffix = " Test.php " >tests/directory >
    testsuite >
  testsuites >

  < logging >
    < log type = " coverage-html " target = " build/coverage " />
    < log type = " coverage-clover " target = " build/logs/clover.xml " />
    < log type = " coverage-crap4j " target = " build/logs/crap4j.xml " />
    < log type = " junit " target = " build/logs/junit.xml " logIncompleteSkipped = " false " />
  logging >
phpunit >

他の場所に既存の PHPUnit 構成がある場合は、以下の「カスタマイズ」セクションを参照してください。

発達

開発時には、次の Ant ターゲットを使用します。

作曲家
phpunit
phpcs
phpmd
phpcpd
phploc

例えば：

$ ant phpcs phpmd phpcpd

継続的インテグレーション

継続的インテグレーション (つまり、Jenkins) を構成する場合、 antタスクを実行する前に、 composerこのリポジトリをダウンロードしてインストールする必要があります。次のコマンドを使用して、「シェルの実行」ビルドステップを Jenkins に追加します。

$ composer install -o

次に、次のターゲットを使用して「Invoke Ant」ビルドステップを追加します。

 build-qa

これにより、 check_mergeconflicts 、 phplint 、 phpunit 、 phpcs-ci 、 pdepend 、 phpmd-ci 、 phpcpd-ci 、 phploc-ci 、およびphpdoxが実行されます。

迅速に実行する必要があり、最小限の QA チェックのみが必要なジョブの場合は、代わりに次のターゲットを実行します。

 build-quick

これにより、 check_mergeconflicts 、 phplint 、およびphpunit実行されます。

特定のプロジェクトに応じて、追加のビルドターゲットをbuild.xmlファイルに追加します。

カスタマイズ中

QAツールの場所

付属のbuild.xml 、すべての QA ツールが./vendor/binにインストールされていることを前提としています。他の場所にインストールされている場合は、その場所にtoolsdirプロパティを指定します。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " toolsdir " value = " ${basedir}/bin/ " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

PHP lint 設定

デフォルトでは、含まれているbuild.xmlプロジェクトのルートにあるvendor/ディレクトリを除く、プロジェクト内のすべての PHP ファイルに対してphp -l実行します。 phplintignoreプロパティを使用してこの設定をオーバーライドできます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phplintignore " value = " components/**/*,vendor/**/* " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

PHPUnit 構成

デフォルトでは、含まれているbuild.xml 、それ自体と同じディレクトリにphpunit.xmlファイルがあることを前提としています。すでに別の場所にphpunit.xmlファイルがある場合は、次のように構成をオーバーライドできます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phpunitconfig " value = " ${basedir}/app/ " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

PHP_CodeSniffer の構成

phpcsignoreプロパティを指定することで、 phpcsチェックで無視されるファイルをカスタマイズできます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phpcsignore " value = " app/,bin/,vendor/,web/ " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

デフォルトでは、 vendorディレクトリのみがチェックから除外されます。

phpcsstandardプロパティをオーバーライドすることで、PHP_CodeSniffer 標準で使用されるものを変更できます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phpcsstandard " value = " PSR1,PSR2 " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

PHPMDの構成

phpmdignoreプロパティを指定することで、 phpmdチェックで無視されるファイルをカスタマイズできます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phpmdignore " value = " app,bin,vendor,web " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

デフォルトでは、 vendorディレクトリのみがチェックから除外されます。

PHPCPD 構成

phpcpdignoreプロパティを指定することで、 phpcpdチェックで無視されるファイルをカスタマイズできます。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " phpcpdignore " value = " --exclude vendor --exclude app " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >

デフォルトでは、 vendorディレクトリのみがチェックから除外されます。

phpDox 構成

xml version = " 1.0 " encoding = " utf-8 " ?>
< phpdox xmlns = " http://xml.phpdox.net/config " silent = " true " >
    < bootstrap />

    < project name = " phpdox " source = " ${basedir}/src " workdir = " ${basedir}/build/phpdox/xml " >
        < collector publiconly = " false " backend = " parser " >
            < include mask = " *.php " />
            < inheritance resolve = " true " />
        collector >

        < generator output = " ${basedir}/build/docs " >
            < enrich base = " ${basedir}/build " >
                < source type = " build " />

                < source type = " phploc " >
                    < file name = " logs/phploc.xml " />
                source >

                < source type = " git " >
                    < git binary = " git " />
                    < history enabled = " true " limit = " 15 " cache = " ${phpDox.project.workdir}/gitlog.xml " />
                source >

                < source type = " checkstyle " >
                    < file name = " logs/checkstyle.xml " />
                source >

                < source type = " phpunit " >
                    < file name = " logs/phpunit " />
                source >

                < source type = " pmd " >
                    < file name = " logs/pmd.xml " />
                source >
            enrich >

            < build engine = " html " enabled = " true " output = " html " >
                < template dir = " ${phpDox.home}/templates/html " />
                < file extension = " html " />
            build >
        generator >
    project >
phpdox >

QA チェックの無効化

プロジェクトに対して特定の QA ツールを実行したくない場合は、基本のbuild.xmlファイルを含める前に、次のdisableプロパティを 1 つ以上追加します。

xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
  < property name = " disable-phpunit " value = " true " />
  < property name = " disable-pdepend " value = " true " />
  < property name = " disable-phpmd " value = " true " />
  < property name = " disable-phpcs " value = " true " />
  < property name = " disable-phpcpd " value = " true " />

  < import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
project >