Shortening the command

.gitignore

@@ -1,7 +1,7 @@
 /vendor/
 /bin/
-!/bin/cognitive-analysis
-!/bin/cognitive-analysis.bat
+!/bin/phpcca
+!/bin/phpcca.bat
 /.phive/
 /.phpunit.cache/
 /tmp/

Makefile

@@ -38,11 +38,7 @@ shell:
 
 self-test:
 	@echo "Running cognitive analyses self-test"
-	docker compose run php php analyse.php metrics:cognitive src
-
-self-test-halstead:
-	@echo "Running cognitive analyses self-test"
-	docker compose run php php analyse.php metrics:halstead src
+	docker compose run php bin/phpcca analyse src
 
 build-phar:
 	@echo "Building phar"

bin/cognitive-analysis.bat → bin/phpcca.bat

@@ -9,4 +9,4 @@ if "%PHP_PEAR_PHP_BIN%" neq "" (
     set PHPBIN=%PHP_PEAR_PHP_BIN%
 ) else set PHPBIN=php
 
-"%PHPBIN%" "%~dp0\cognitive-analysis" %*
+"%PHPBIN%" "%~dp0\phpcca" %*

box.json.dist

@@ -1,5 +1,5 @@
 {
     "main": "./analyse.php",
     "compression": "GZ",
-    "output": "cognitive-analysis.phar"
+    "output": "phpcca.phar"
 }

composer.json

@@ -42,7 +42,7 @@
         }
     },
     "bin": [
-        "bin/cognitive-analysis"
+      "bin/phpcca"
     ],
     "scripts": {
         "test": [

config.yml

@@ -2,7 +2,7 @@ cognitive:
   excludeFilePatterns:
   excludePatterns:
   scoreThreshold: 0.5
-  showOnlyMethodsExceedingThreshold: true
+  showOnlyMethodsExceedingThreshold: false
   metrics:
     lineCount:
       threshold: 60

docs/Configuration.md

@@ -5,27 +5,39 @@
 You can specify another configuration file by passing it to the config options:
 
 ```bash
-php analyse.php metrics:cognitive <path-to-folder> --config=<path-to-config-file>
+bin/phpcca analyse <path-to-folder> --config=<path-to-config-file>
 ```
 
 ## Excluding Classes and Methods
 
 You can exclude classes and methods via a regex in the configuration.
 
-The following configuration will exclude all constructors and all methods of classes that end with `Transformer`.
+The following configuration will exclude all constructors, `toArray` methods and all methods of classes that end with `Transformer`.
 
 ```yaml
 cognitive:
   excludePatterns:
     - '(.*)::__construct'
+    - '(.*)::toArray'
     - '(.*)Transformer::(.*)'
 ```
 
+## Exclude Files
+
+You can exclude files via a regex in the configuration.
+
+```yaml
+cognitive:
+  excludeFilePatterns:
+    - '.*Cognitive.*'
+    - '(.*)Test.php'
+```
+
 ## Tuning the calculation
 
 The configuration file can contain the following settings for the calculation of cognitive complexity.
 
-Feel free to adjust the values to your match your opinion on what makes code complex.
+Feel free to adjust the values to your match **your opinion** on what makes code complex. It is recommended to play with the values until you get weights that you are comfortable with. The default values are a good starting point.
 
 ```yaml
 cognitive:
@@ -55,15 +67,3 @@ cognitive:
         threshold: 1
         scale: 1.0
 ```
-
-It is recommended to play with the values until you get weights that you are comfortable with. The default values are a good starting point.
-
-## Excluding Files
-
-Regular expression patterns can be defined to exclude files from the analysis.
-
-```yaml
-cognitive:
-  excludeFilePatterns:
-    - '(.*)Test.php'
-```

readme.md

@@ -11,19 +11,19 @@ Cognitive Code Analysis is an approach to understanding and improving code by fo
 Cognitive Complexity Analysis
 
 ```bash
-bin/cognitive-analysis metrics:cognitive <path-to-folder>
+bin/phpcca analyse <path-to-folder>
 ```
 
 Generate a report, supported types are `json`, `csv`, `html`.
 
 ```bash
-bin/cognitive-analysis metrics:cognitive <path-to-folder> --report-type json --report-file cognitive.json
+bin/phpcca analyse <path-to-folder> --report-type json --report-file cognitive.json
 ```
 
 You can also pass a baseline file to compare the results to. The JSON report is used as baseline. The output will now show a delta if a value was changed.
 
 ```bash
-bin/cognitive-analysis metrics:cognitive <path-to-folder> --baseline cognitive.json
+bin/phpcca analyse <path-to-folder> --baseline cognitive.json
 ```
 
 ## Documentation

src/Command/CognitiveMetricsCommand.php

@@ -19,7 +19,7 @@
  * Command to parse PHP files or directories and output method metrics.
  */
 #[AsCommand(
-    name: 'metrics:cognitive',
+    name: 'analyse',
     description: 'Parse PHP files or directories and output method metrics.'
 )]
 class CognitiveMetricsCommand extends Command