Skip to content

PHPDocBlockChecker Plugin Detailed Error Logging #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
corpsee merged 2 commits into from
Feb 27, 2018
Merged

PHPDocBlockChecker Plugin Detailed Error Logging #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08cab04
PHPDocBlockChecker Plugin Detailed Error Logging
Dave13h Feb 26, 2018
17d9917
Ironically fix the docblock.
Dave13h Feb 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 38 additions & 7 deletions src/PHPCensor/Plugin/PhpDocblockChecker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,48 @@ public function execute()

/**
* Report all of the errors we've encountered line-by-line.
* @param $output
* @param array $output
*/
protected function reportErrors($output)

@php-censor-bot php-censor-bot Feb 26, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Class PHPCensor\Plugin\PhpDocblockChecker::reportErrors is missing a docblock.

@Dave13h Dave13h Feb 26, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^^ Exactly 😁

{
foreach ($output as $error) {
$message = 'Class ' . $error['class'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_LOW;

if ($error['type'] == 'method') {
$message = $error['class'] . '::' . $error['method'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
switch ($error['type']) {
case 'class':
$message = 'Class ' . $error['class'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
break;

case 'method':
$message = $error['class'] . '::' . $error['method'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
break;

case 'param-missing':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] . ' missing.';
$severity = BuildError::SEVERITY_LOW;
break;

case 'param-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] .
'(' . $error['doc-type'] . ') does not match method signature (' . $error['param-type'] . ')';
$severity = BuildError::SEVERITY_LOW;
break;

case 'return-missing':
$message = $error['class'] . '::' . $error['method'] . ' @return missing.';
$severity = BuildError::SEVERITY_LOW;
break;

case 'return-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @return ' . $error['doc-type'] .
' does not match method signature (' . $error['return-type'] . ')';
$severity = BuildError::SEVERITY_LOW;
break;

default:
$message = 'Class ' . $error['class'] . ' invalid/missing a docblock.';
$severity = BuildError::SEVERITY_LOW;
break;
}

$this->build->reportError(
Expand Down