SavinMikhail\CommentsDensity\ComposerPlugin\CommentsDensityPlugin

Complexity

Total Complexity

7

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	deactivate()	0	2	1
A	getSubscribedEvents()	0	5	1
A	uninstall()	0	2	1
A	activate()	0	2	1
A	promptForConfigFile()	0	15	2
A	promptForSetup()	0	5	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\ComposerPlugin;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;

use function file_put_contents;

final class CommentsDensityPlugin implements PluginInterface, EventSubscriberInterface
{
    private const CONFIG = <<<'PHP'
        <?php

        return [
            'directories' => [
                'src', // Directories to be scanned for comments
            ],
            'exclude' => [
                'src/DTO', // Directories to be ignored during scanning
            ],
            'thresholds' => [
                // Limit occurrences of each comment type
                'docBlock' => 90, 
                'regular' => 5,
                'todo' => 5,
                'fixme' => 5,
                'missingDocBlock' => 10,
                // Additional metrics thresholds
                'Com/LoC' => 0.1, // Comments per Lines of Code
                'CDS' => 0.1, // Comment Density Score
            ],
            'only' => [
                'missingDocblock', // Only this type will be analyzed; set to empty array for full statistics
            ],
            'output' => [
                'type' => 'console', // Supported values: 'console', 'html'
                'file' => 'output.html', // File path for HTML output (only used if type is 'html')
            ],
            'missingDocblock' => [
                'class' => true, // Check for missing docblocks in classes
                'interface' => true, // Check for missing docblocks in interfaces
                'trait' => true, // Check for missing docblocks in traits
                'enum' => true, // Check for missing docblocks in enums
                'property' => true, // Check for missing docblocks in properties
                'constant' => true, // Check for missing docblocks in constants
                'function' => true, // Check for missing docblocks in functions
                 // If false, only methods where @throws tag or generic can be applied will be checked
                'requireForAllMethods' => true,
            ],
            'use_baseline' => true, // Filter collected comments against the baseline stored in baseline.php
        ];

        PHP;

    public static function getSubscribedEvents(): array
    {
        return [
            ScriptEvents::POST_INSTALL_CMD => 'promptForSetup',
            ScriptEvents::POST_UPDATE_CMD => 'promptForSetup',
        ];
    }

    public static function promptForSetup(Event $event): void
    {
        $interface = $event->getIO();

        self::promptForConfigFile($interface);
    }

    private static function promptForConfigFile(IOInterface $interface): void
    {
        $interface->write('Run configuration file setup');
        $shouldCreateConfig = $interface
            ->askConfirmation('Do you want to create a default configuration file? [y/n]');

        if (!$shouldCreateConfig) {
            $interface->write('Configuration file setup skipped.');

            return;
        }

        file_put_contents('comments_density.php', self::CONFIG);

        $interface->write('Default configuration file created.');
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function activate(Composer $composer, IOInterface $io): void
    {
        // No activation logic needed
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function deactivate(Composer $composer, IOInterface $io): void
    {
        // No deactivation logic needed
    }

    /**
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function uninstall(Composer $composer, IOInterface $io): void
    {
        // No uninstallation logic needed
    }
}