phpqaconfig
1.0.0
Configuração para controle de qualidade e ferramentas de desenvolvimento específicas para os padrões de codificação da LoVullo Associates. Este pacote, combinado com lovullo/phpqatools pretende ser uma base para novos projetos PHP.
Basta exigi-lo no composer.json do seu projeto
"require-dev" : {
"lovullo/phpqaconfig" : " @stable "
}Ou
$ composer require --dev lovullo/phpqaconfig Crie um arquivo build.xml na raiz do seu projeto com o seguinte conteúdo:
<? xml version = " 1.0 " encoding = " utf-8 " ?>
< project name = " project-name " >
< import file = " ${basedir}/vendor/lovullo/phpqaconfig/build.xml " />
</ project > Crie um arquivo phpunit.xml na raiz do seu projeto com o seguinte conteúdo:
<? 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 >Consulte a seção "Personalização" abaixo se você tiver uma configuração PHPUnit existente em outro lugar.
Ao desenvolver, use os seguintes alvos de formigas:
Por exemplo:
$ ant phpcs phpmd phpcpd Ao configurar a Integração Contínua (ou seja, Jenkins), composer deve baixar e instalar este repositório antes de poder executar tarefas ant . Adicione uma etapa de construção "Execute Shell" ao Jenkins com o seguinte comando:
$ composer install -oEm seguida, adicione uma etapa de construção "Invoke Ant" com o seguinte destino:
build-qa
Isso executará check_mergeconflicts , phplint , phpunit , phpcs-ci , pdepend , phpmd-ci , phpcpd-ci , phploc-ci e phpdox .
Para trabalhos que precisam ser executados rapidamente e precisam apenas de um número mínimo de verificações de controle de qualidade, execute os seguintes destinos:
build-quick
Isso executará check_mergeconflicts , phplint e phpunit .
Adicione destinos de construção adicionais ao seu arquivo build.xml conforme apropriado para seu projeto específico.
O build.xml incluído pressupõe que todas as ferramentas de controle de qualidade estão instaladas em ./vendor/bin . Se eles estiverem instalados em outro lugar, forneça uma propriedade toolsdir para sua localização:
<? 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 > Por padrão, o build.xml incluído executa php -l em todos os arquivos PHP do projeto, exceto no diretório vendor/ na raiz do seu projeto. Você pode substituir esta configuração usando a propriedade 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 > Por padrão, o build.xml incluído assume que existe um arquivo phpunit.xml no mesmo diretório que ele. Se você já possui um arquivo phpunit.xml localizado em outro lugar, você pode substituir a configuração da seguinte maneira:
<? 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 > Você pode personalizar os arquivos que são ignorados nas verificações phpcs especificando uma propriedade phpcsignore :
<? 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 > Por padrão, apenas o diretório vendor é excluído das verificações.
Você pode alterar o que o padrão PHP_CodeSniffer usa substituindo a propriedade phpcsstandard :
<? 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 > Você pode personalizar os arquivos que são ignorados nas verificações phpmd especificando uma propriedade phpmdignore :
<? 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 > Por padrão, apenas o diretório vendor é excluído das verificações.
Você pode personalizar os arquivos que são ignorados nas verificações phpcpd especificando uma propriedade phpcpdignore :
<? 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 > Por padrão, apenas o diretório vendor é excluído das verificações.
<? 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 > Se você não quiser que determinadas ferramentas de controle de qualidade sejam executadas em um projeto, inclua uma ou mais das seguintes propriedades disable antes de incluir o arquivo build.xml base:
<? 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 >
