Source of file HasReadMeFile.php
Size: 0,852 Bytes - Last Modified: 2021-12-23T10:42:13+00:00
/var/www/docs.ssmods.com/process/src/src/Commands/Checks/HasReadMeFile.php
1234567891011121314151617181920212223242526272829303132333435363738394041424344 | <?php namespace Sunnysideup\ModuleChecks\Commands\Checks; use Sunnysideup\ModuleChecks\Commands\ChecksAbstract; class HasReadMeFile extends ChecksAbstract { protected $options = [ 'README.md', 'README.MD', 'readme.md', ]; /** * should it be included by default? * @var bool */ private static $enabled = true; /** * @return boolean */ public function run(): bool { foreach ($this->options as $option) { $outcome = $this->hasFileOnGitHub($option); if ($outcome) { return true; } } return $this->hasError(); } /** * what does it do? * @return string */ public function getDescription(): string { return 'Does the module have a README file in root'; } } |