churn php
Release 1.7.2
Помогает найти хороших кандидатов для рефакторинга.
churn-php — это пакет, который помогает вам идентифицировать php-файлы в вашем проекте, которые могут стать хорошими кандидатами на рефакторинг. Он проверяет каждый файл PHP по указанному пути и:
Результаты отображаются в таблице:
Файл, который сильно изменяется и имеет высокую сложность, может быть лучшим кандидатом на рефакторинг, чем файл, который мало меняется и имеет низкую сложность.
churn-php только помогает разработчику идентифицировать файлы для рефакторинга. Лучше всего использовать результаты в дополнение к своему собственному мнению, чтобы решить, какие файлы вы можете подвергнуть рефакторингу.
Загрузите последнюю версию churn.phar или установите его с помощью Phive:
phive install churn Вы также можете установить churn-php через 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 Вы можете добавить дополнительный файл churn.yml , который можно использовать для настройки churn-php. Местоположение этого файла можно настроить с помощью опции --configuration :
# Default: "churn.yml" or "churn.yml.dist"
churn run --configuration=config-dir/ < path >
churn run --configuration=my-config.yml < path > Пример файла churn.yml выглядит так:
# 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 Если файл churn.yml опущен или не указана отдельная настройка, будут использоваться значения по умолчанию, указанные выше.
Вы можете настроить churn для вывода результата в разных форматах. Доступные форматы:
csvjsonmarkdowntext (по умолчанию) Чтобы использовать другой формат, используйте опцию --format . Пример команды для json :
churn run --format json Конфигурация перехватчиков позволяет настроить churn .
Пользовательский перехватчик должен реализовывать хотя бы один интерфейс перехватчика:
| Интерфейс крючка | Соответствующий интерфейс событий |
|---|---|
| ПослеАнализХук | Послеанализ |
| ПослеФайлАнализХук | ПослеФайлАнализ |
| ДоАнализХук | До анализа |
Вопросы, комментарии, отзывы? @bmitch2112
composer test на PHP 7.1 и убедитесь, что он пройден.Лицензия MIT (MIT). Дополнительную информацию см. в файле лицензии.
