churn php
Release 1.7.2
Ajuda a descobrir bons candidatos para refatoração.
churn-php é um pacote que ajuda a identificar arquivos php em seu projeto que podem ser bons candidatos para refatoração. Ele examina cada arquivo PHP no caminho fornecido e:
Os resultados são exibidos em uma tabela:
Um arquivo que muda muito e tem alta complexidade pode ser um candidato melhor para refatoração do que um arquivo que não muda muito e tem baixa complexidade.
churn-php apenas auxilia o desenvolvedor a identificar arquivos para refatoração. É melhor usar os resultados além de seu próprio julgamento para decidir quais arquivos você deseja refatorar.
Baixe a última versão do churn.phar ou instale-o com Phive:
phive install churn Você também pode instalar churn-php via Composer:
composer require bmitch/churn-php --devchurn run < one or more paths to source code > ...
churn run src
churn run src tests
# the command name can be skipped if directoriesToScan is set in churn.yml
churn Você pode adicionar um arquivo churn.yml opcional que pode ser usado para configurar o churn-php. A localização deste arquivo pode ser personalizada usando a opção --configuration :
# Default: "churn.yml" or "churn.yml.dist"
churn run --configuration=config-dir/ < path >
churn run --configuration=my-config.yml < path > Um exemplo de arquivo churn.yml se parece com:
# The maximum number of files to display in the results table.
# Default: 10
filesToShow : 10
# The minimum score a file need to display in the results table.
# Disabled if null.
# Default: 0.1
minScoreToShow : 0
# The command returns an 1 exit code if the highest score is greater than the threshold.
# Disabled if null.
# Default: null
maxScoreThreshold : 0.9
# The number of parallel jobs to use when processing files.
# Default: 10
parallelJobs : 10
# How far back in the VCS history to count the number of commits to a file
# Can be a human readable date like 'One week ago' or a date like '2017-07-12'
# Default: '10 Years ago'
commitsSince : One year ago
# Files to ignore when processing. The full path to the file relative to the root of your project is required.
# Also supports regular expressions.
# Default: All PHP files in the path provided to churn-php are processed.
filesToIgnore :
- src/Commands/ChurnCommand.php
- src/Results/ResultsParser.php
- src/Foo/Ba*
# File extensions to use when processing.
# Default: php
fileExtensions :
- php
- inc
# This list is used only if there is no argument when running churn.
# Default: <empty>
directoriesToScan :
- src
- tests/
# List of user-defined hooks.
# They can be referenced by their full qualified class name if churn has access to the autoloader.
# Otherwise the file path can be used as well.
# See below the section about hooks for more details.
# Default: <empty>
hooks :
- NamespaceMyHook
- path/to/my-hook.php
# The version control system used for your project.
# Accepted values: fossil, git, mercurial, subversion, none
# Default: git
vcs : git
# The path of the cache file. It doesn't need to exist before running churn.
# Disabled if null.
# Default: null
cachePath : .churn.cache Se um arquivo churn.yml for omitido ou uma configuração individual for omitida, os valores padrão acima serão usados.
Você pode configurar churn para gerar o resultado em diferentes formatos. Os formatos disponíveis são:
csvjsonmarkdowntext (padrão) Para usar um formato diferente, use a opção --format . Comando de exemplo para json :
churn run --format json A configuração dos ganchos permite personalizar churn .
Um gancho definido pelo usuário deve implementar pelo menos uma interface Hook:
| Interface de gancho | Interface de evento correspondente |
|---|---|
| AfterAnalysisHook | Pós-Análise |
| AfterFileAnalysisHook | Análise Pós-Arquivo |
| AntesAnalysisHook | AntesAnálise |
Perguntas, comentários, feedback? @bmitch2112
composer test no PHP 7.1 e certifique-se de que ele seja aprovado.A licença MIT (MIT). Consulte Arquivo de licença para obter mais informações.
