Adding Analysis Action and Fixes to the Configuration (#72)

* Enhance report generation with new CI formats and refactor Markdown handling

- Added support for new CI report formats: Checkstyle, JUnit, SARIF, GitLab Code Quality, and GitHub Actions.
- Improved HTML and Markdown report generation with a single table configuration option.
- Refactored MarkdownReport for better file handling and class section management, enhancing code readability and maintainability.
- Updated tests to validate new report formats and configurations.

* Update output files to include configuration and cache status

- Added configuration file paths and cache status to various output files for improved clarity and debugging.
- Updated output formats for all relevant test cases to reflect the new configuration and cache information.

* Refactor configuration management and update file references

- Replaced instances of `config.yml` with `phpcca.yaml` across the codebase to standardize configuration file usage.
- Introduced a new `phpcca.yaml` file containing cognitive metrics configuration settings.
- Updated README.md to reflect the new copyright format.
- Adjusted GitHub Actions workflow to utilize the new configuration file.

* Update configuration file references to phpcca.yaml

- Changed all instances of cca.yaml to phpcca.yaml across documentation and codebase for consistency.
- Updated README.md, CI-Integration.md, and Configuration.md to reflect the new configuration file name.
- Modified InitCommand and related tests to create and reference phpcca.yaml instead of cca.yaml.

* Update cognitive metrics configuration in phpcca.yaml

- Changed the setting for showOnlyMethodsExceedingThreshold from false to true to enhance cognitive metrics reporting.

* Refactor CognitiveMetricsCommandCoverageTest to use a centralized test configuration method

- Introduced a private method `withTestConfig` to streamline the execution of tests with a specified configuration file.
- Updated all test cases in `CognitiveMetricsCommandCoverageTest` to utilize the new method for improved readability and maintainability.

Author: floriankraemer

.github/workflows/cognitive-code-analysis.yaml

@@ -0,0 +1,29 @@
+name: Cognitive Code Analysis
+
+on:
+  pull_request:
+    paths:
+      - '**/*.php'
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  analyse:
+    name: Cognitive Code Analysis
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: Phauthentic/cognitive-code-analysis-github-action@v1
+        with:
+          install-mode: phar
+          config: phpcca.yaml
+          post-comment: true
+          upload-artifact: true
+          emit-annotations: true
+          upload-sarif: false
+          fail-on-threshold: false

box.json.dist

@@ -9,7 +9,7 @@
         "KevinGH\\Box\\Compactor\\PhpScoper"
     ],
     "files": [
-        "config.yml",
+        "phpcca.yaml",
         "composer.json",
         "readme.md",
         "LICENSE"

docs/CI-Integration.md

@@ -13,7 +13,7 @@ A typical CI integration follows these steps:
 3. Run `bin/phpcca analyse` on those files only
 4. Publish the report (Markdown comment, SARIF upload, or quality gate)
 
-When `cca.yaml` exists in the project root, `analyse` loads it automatically. Use `--config=path/to/config.yaml` to override.
+When `phpcca.yaml` exists in the project root, `analyse` loads it automatically. Use `--config=path/to/config.yaml` to override.
 
 ## Report formats for CI
 
@@ -38,7 +38,7 @@ See [Baseline Analysis](./Baseline-Analysis.md) to compare metrics against a pre
 
 The workflow below runs on pull requests, analyses changed PHP files, posts a Markdown report as a PR comment, and uploads the report as an artifact.
 
-Add `--config=cca.yaml` if your config file is not named `cca.yaml` or not in the working directory.
+Add `--config=phpcca.yaml` if your config file is not named `phpcca.yaml` or not in the working directory.
 
 ```yaml
 name: Code Metrics
@@ -142,7 +142,7 @@ Then upload `results.sarif` using the [GitHub Code Scanning upload action](https
 
 The job below runs on merge requests, analyses changed PHP files, posts a Markdown report as an MR note, and stores the report as an artifact.
 
-Use `--config=cca.yaml` when your config file is not auto-discovered from the project root.
+Use `--config=phpcca.yaml` when your config file is not auto-discovered from the project root.
 
 ```yaml
 Code-Metrics:
@@ -166,7 +166,7 @@ Code-Metrics:
         CHANGED_FILES=$(find src/ -name "*.php" | tr '\n' ' ')
       fi
       if [ -n "$CHANGED_FILES" ]; then
-        bin/phpcca analyse $CHANGED_FILES --report-type=markdown --report-file=cca-report.md --config=cca.yaml
+        bin/phpcca analyse $CHANGED_FILES --report-type=markdown --report-file=cca-report.md --config=phpcca.yaml
         if [ -f "cca-report.md" ] && [ -s "cca-report.md" ]; then
           # Try with CI_JOB_TOKEN first, fallback to CI/CD variables
           if [ -n "$VALIDATOR" ]; then
@@ -237,7 +237,7 @@ GitLab picks up the Code Quality report automatically when configured in your pi
 
 ## Related
 
-- [Configuration](./Configuration.md) — project setup with `bin/phpcca init` and `cca.yaml`
+- [Configuration](./Configuration.md) — project setup with `bin/phpcca init` and `phpcca.yaml`
 - [Baseline Analysis](./Baseline-Analysis.md) — track complexity changes over time
 - [Creating Custom Reporters](./Creating-Custom-Reporters.md) — extend report output for custom CI integrations
 - [Issue #29](https://github.com/Phauthentic/cognitive-code-analysis/issues/29) — original feature discussion for GitHub Actions and branch comparison

docs/Configuration.md

@@ -2,15 +2,15 @@
 
 ## Creating a configuration file
 
-Run `init` to create a `cca.yaml` in your project:
+Run `init` to create a `phpcca.yaml` in your project:
 
 ```bash
 bin/phpcca init
 bin/phpcca init --silent
-bin/phpcca init --path=/path/to/cca.yaml
+bin/phpcca init --path=/path/to/phpcca.yaml
 ```
 
-When `cca.yaml` exists in the working directory, `analyse` and `churn` pick it up automatically. You only need `--config` for a custom path or filename.
+When `phpcca.yaml` exists in the working directory, `analyse` and `churn` pick it up automatically. You only need `--config` for a custom path or filename.
 
 ## Passing a configuration file
 
@@ -20,7 +20,7 @@ You can specify another configuration file by passing it to the config options:
 bin/phpcca analyse <path-to-folder> --config=<path-to-config-file>
 ```
 
-When both `cca.yaml` and `--config` are available, the explicit `--config` path takes precedence.
+When both `phpcca.yaml` and `--config` are available, the explicit `--config` path takes precedence.
 
 ## Excluding Classes and Methods
 

config.yml phpcca.yamlconfig.yml renamed to phpcca.yaml

@@ -2,7 +2,7 @@ cognitive:
   excludeFilePatterns:
   excludePatterns:
   scoreThreshold: 0.5
-  showOnlyMethodsExceedingThreshold: false
+  showOnlyMethodsExceedingThreshold: true
   showHalsteadComplexity: false
   showCyclomaticComplexity: false
   showDetailedCognitiveMetrics: true

readme.md

@@ -37,12 +37,12 @@ composer require --dev phauthentic/cognitive-code-analysis
 Create a project configuration file:
 
 ```bash
-bin/phpcca init                  # interactive setup → creates cca.yaml in current directory
+bin/phpcca init                  # interactive setup → creates phpcca.yaml in current directory
 bin/phpcca init --silent         # non-interactive, all defaults
-bin/phpcca init --path=/path/to/cca.yaml
+bin/phpcca init --path=/path/to/phpcca.yaml
 ```
 
-When `cca.yaml` exists in the current working directory, `analyse` and `churn` load it automatically. Use `--config` to specify a different file.
+When `phpcca.yaml` exists in the current working directory, `analyse` and `churn` load it automatically. Use `--config` to specify a different file.
 
 Cognitive Complexity Analysis
 
@@ -163,6 +163,6 @@ Especially the AST-parser used under the hood to analyse the code might have iss
 
 ## License ⚖️
 
-Copyright Florian Krämer
+Copyright [Florian Krämer](https://florian-kraemer.net/)
 
 Licensed under the [GPL3 license](LICENSE).

src/Application.php

@@ -192,7 +192,7 @@ private function registerUtilityServices(): void
             ->setArguments([
                 new Reference(Processor::class),
                 new Reference(ConfigLoader::class),
-                __DIR__ . '/../config.yml',
+                __DIR__ . '/../phpcca.yaml',
             ])
             ->setPublic(true);
 

src/Command/InitCommand.php

@@ -16,7 +16,7 @@
 
 #[AsCommand(
     name: 'init',
-    description: 'Create a default cca.yaml for cognitive code analysis.'
+    description: 'Create a default phpcca.yaml for cognitive code analysis.'
 )]
 class InitCommand extends Command
 {

src/Config/ConfigFileResolver.php

@@ -6,7 +6,7 @@
 
 class ConfigFileResolver
 {
-    public const DEFAULT_FILENAME = 'cca.yaml';
+    public const DEFAULT_FILENAME = 'phpcca.yaml';
 
     public function resolve(?string $explicitConfigPath): ?string
     {

src/Config/ConfigService.php

@@ -27,7 +27,7 @@ public function __construct(
     private function loadDefaultConfig(): void
     {
         $config = $this->processor->processConfiguration($this->configuration, [
-            Yaml::parseFile(__DIR__ . '/../../config.yml'),
+            Yaml::parseFile(__DIR__ . '/../../phpcca.yaml'),
         ]);
 
         $this->config = (new ConfigFactory())->fromArray($config);
@@ -38,7 +38,7 @@ private function loadDefaultConfig(): void
      */
     public function loadConfig(string $configFilePath): void
     {
-        $defaultConfig = Yaml::parseFile(__DIR__ . '/../../config.yml');
+        $defaultConfig = Yaml::parseFile(__DIR__ . '/../../phpcca.yaml');
         $providedConfig = Yaml::parseFile($configFilePath);
 
         $config = $this->processor->processConfiguration($this->configuration, [