SilverStripe\ModuleRatings\Check\ReadmeCheck

Complexity

Total Complexity

3

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Importance

Changes	1
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	getKey()	0	3	1
A	run()	0	8	1

<?php

namespace SilverStripe\ModuleRatings\Check;

class ReadmeCheck extends AbstractFileCheck
{
    public function getKey()
    {
        return 'has_readme';
    }

    public function getDescription()
    {
        return 'Has a readme file';
    }

    public function run()
    {
        $files = $this->getFinder()
            ->files()
            ->in($this->getSuite()->getModuleRoot())
            ->name('/readme(?:\.md|\.txt)?$/i');

        $this->setSuccessful(count($files) > 0);
    }
}