Skip to content
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

Enforce method to not have docblock #237

Open
wants to merge 6 commits into
base: 8.3.x
Choose a base branch
from
Open

Enforce method to not have docblock #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9cab8c
First try
claudiu-cristea Sep 27, 2024
e478364
Coding standards
claudiu-cristea Sep 27, 2024
f87d421
PHPStan issue
claudiu-cristea Sep 27, 2024
5e40039
Use placeholder in message
claudiu-cristea Sep 28, 2024
e0ef19b
Tests
claudiu-cristea Sep 28, 2024
b3cedcc
Better code
claudiu-cristea Sep 28, 2024
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
26 changes: 22 additions & 4 deletions coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@
class FunctionCommentSniff implements Sniff
{

/**
* List of methods that are prohibited to have docblock.
*
* @var array<string>
*/
public $commentProhibitedFunctions = [];

/**
* A map of invalid data types to valid ones for param and return documentation.
*
Expand Down Expand Up @@ -94,13 +101,24 @@ public function process(File $phpcsFile, $stackPtr)
break;
}

// Constructor methods are exempt from requiring a docblock.
// @see https://www.drupal.org/project/coder/issues/3400560.
$methodName = $phpcsFile->getDeclarationName($stackPtr);
if ($methodName === '__construct'
&& $tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
&& $tokens[$commentEnd]['code'] !== T_COMMENT
) {
if ($methodName === '__construct') {
Copy link
Collaborator

Choose a reason for hiding this comment

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

we must not treat constructors in a special way. Comments on constructors are good and we need to allow them.

// Constructor methods are exempt from requiring a docblock.
// @see https://www.drupal.org/project/coder/issues/3400560.
return;
}
} else if (in_array($methodName, $this->commentProhibitedFunctions, true) === true) {
// Method prohibited to have docblock.
$fix = $phpcsFile->addFixableError("It's forbidden to document %s function", $stackPtr, 'ForbiddenDocBlock', [$methodName]);
if ($fix === true) {
for ($i = $tokens[$commentEnd]['comment_opener']; $i <= $commentEnd; $i++) {
$phpcsFile->fixer->replaceToken($i, '');
}
}

return;
}

Expand Down
11 changes: 11 additions & 0 deletions tests/Drupal/Commenting/FunctionCommentUnitTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* @file
* Some function comment tests.
* phpcs:set Drupal.Commenting.FunctionComment commentProhibitedFunctions[] docblock_is_not_allowed
*/

/**
Expand Down Expand Up @@ -976,3 +977,13 @@ function return_some_array(): array {
});
return [];
}

/**
* Don't document this function.
*
* @return bool
* Something.
*/
function docblock_is_not_allowed(): bool {
return TRUE;
}
5 changes: 5 additions & 0 deletions tests/Drupal/Commenting/FunctionCommentUnitTest.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* @file
* Some function comment tests.
* phpcs:set Drupal.Commenting.FunctionComment commentProhibitedFunctions[] docblock_is_not_allowed
*/

/**
Expand Down Expand Up @@ -1002,3 +1003,7 @@ function return_some_array(): array {
});
return [];
}

function docblock_is_not_allowed(): bool {
return TRUE;
}
93 changes: 47 additions & 46 deletions tests/Drupal/Commenting/FunctionCommentUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,55 +23,56 @@ protected function getErrorList(string $testFile): array
switch ($testFile) {
case 'FunctionCommentUnitTest.inc':
return [
12 => 1,
14 => 1,
33 => 1,
43 => 1,
53 => 1,
62 => 1,
71 => 1,
78 => 1,
87 => 1,
92 => 1,
101 => 1,
113 => 1,
126 => 2,
147 => 1,
148 => 2,
187 => 1,
195 => 1,
205 => 1,
215 => 1,
13 => 1,
15 => 1,
34 => 1,
44 => 1,
54 => 1,
63 => 1,
72 => 1,
79 => 1,
88 => 1,
93 => 1,
102 => 1,
114 => 1,
127 => 2,
148 => 1,
149 => 2,
188 => 1,
196 => 1,
206 => 1,
216 => 1,
225 => 3,
233 => 1,
235 => 1,
237 => 1,
248 => 1,
250 => 1,
252 => 1,
254 => 1,
256 => 1,
298 => 1,
308 => 1,
311 => 1,
321 => 1,
324 => 1,
334 => 1,
345 => 1,
357 => 1,
360 => 1,
371 => 1,
389 => 2,
217 => 1,
226 => 3,
234 => 1,
236 => 1,
238 => 1,
249 => 1,
251 => 1,
253 => 1,
255 => 1,
257 => 1,
299 => 1,
309 => 1,
312 => 1,
322 => 1,
325 => 1,
335 => 1,
346 => 1,
358 => 1,
361 => 1,
372 => 1,
390 => 2,
401 => 1,
414 => 1,
416 => 1,
426 => 2,
391 => 2,
402 => 1,
415 => 1,
417 => 1,
427 => 2,
538 => 1,
540 => 1,
941 => 1,
428 => 2,
539 => 1,
541 => 1,
942 => 1,
987 => 1,
];
case 'FunctionCommentUnitTest.1.inc':
return [];
Expand Down
Loading