churn php下載 - churn php原始碼下載

churn php

其他類別

Release 1.7.2

下載

攪動-php

幫助發現重構的良好候選者。

它是什麼？

churn-php是一個包，可協助您識別專案中可能適合重構的 php 檔案。它檢查提供的路徑中的每個 PHP 文件，並且：

檢查它有多少提交。
計算圈複雜度。
根據這兩個值建立分數。

結果顯示在表格中：

更改較多且複雜性較高的文件可能比更改較少且複雜性較低的文件更適合重構。

churn-php僅幫助開發人員識別要重構的文件。除了您自己的判斷之外，最好還使用結果來決定您可能想要重構哪些文件。

相容性

PHP 7.1+
作曲家2.0+

如何安裝？

下載最新版本的churn.phar或使用 Phive 安裝它：

phive install churn

您也可以透過 Composer 安裝churn-php ：

composer require bmitch/churn-php --dev

如何使用？

churn 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