添加注释

churn.yml

@@ -0,0 +1,59 @@
+# 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/
+  - cloud-admin/
+
+# 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>
+
+# 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

composer.json

@@ -50,6 +50,7 @@
     "swow/swow": "^1.4"
   },
   "require-dev": {
+    "bmitch/churn-php": "dev-master",
     "ergebnis/composer-normalize": "^2.37",
     "friendsofphp/php-cs-fixer": "^3.0",
     "hyperf/devtool": "~3.1.0",