DocBlockNoEmpty

Author: dereuromark

PSR2R/Sniffs/Commenting/DocBlockNoEmptySniff.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace PSR2R\Sniffs\Commenting;
+
+use PHP_CodeSniffer\Files\File;
+use PSR2R\Tools\AbstractSniff;
+
+/**
+ * No empty phpdoc tags and no empty @ tag.
+ */
+class DocBlockNoEmptySniff extends AbstractSniff {
+
+	/**
+	 * @inheritDoc
+	 */
+	public function register() {
+		return [
+			T_DOC_COMMENT_OPEN_TAG,
+		];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function process(File $phpcsFile, $stackPtr) {
+		$tokens = $phpcsFile->getTokens();
+
+		if (empty($tokens[$stackPtr]['comment_closer'])) {
+			return;
+		}
+
+		$endIndex = $tokens[$stackPtr]['comment_closer'];
+
+		$this->assertNonEmptyDocBlock($phpcsFile, $stackPtr, $endIndex);
+		$this->assertNoEmptyTag($phpcsFile, $stackPtr, $endIndex);
+	}
+
+	/**
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile
+	 * @param int $stackPtr
+	 * @param int $endIndex
+	 *
+	 * @return void
+	 */
+	protected function assertNonEmptyDocBlock(File $phpcsFile, $stackPtr, $endIndex) {
+		$nextIndex = $phpcsFile->findNext([T_WHITESPACE, T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_STAR], $stackPtr + 1, $endIndex - 1, true);
+		if ($nextIndex) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError('There should be no empty docblocks.', $stackPtr, 'Superfluous');
+		if ($fix) {
+			for ($i = $stackPtr; $i <= $endIndex; $i++) {
+				$phpcsFile->fixer->replaceToken($i, '');
+			}
+		}
+	}
+
+	/**
+	 * @param \PHP_CodeSniffer\Files\File $phpcsFile
+	 * @param int $stackPtr
+	 * @param int $endIndex
+	 *
+	 * @return void
+	 */
+	protected function assertNoEmptyTag(File $phpcsFile, $stackPtr, $endIndex) {
+		$tokens = $phpcsFile->getTokens();
+
+		$index = $stackPtr;
+		while ($index < $endIndex) {
+			$nextIndex = $phpcsFile->findNext([T_DOC_COMMENT_STRING], $index + 1, $endIndex);
+			if (!$nextIndex) {
+				return;
+			}
+			$index = $nextIndex;
+
+			if (empty($tokens[$index]['content']) || $tokens[$index]['content'] !== '@') {
+				continue;
+			}
+
+			$fix = $phpcsFile->addFixableError('Empty Doc Block Tag', $index, 'Empty');
+			if (!$fix) {
+				continue;
+			}
+
+			$phpcsFile->fixer->replaceToken($index, '');
+		}
+	}
+
+}

docs/sniffs.md

@@ -1,7 +1,7 @@
 # PSR2R Code Sniffer
 
 
-The PSR2R standard contains 123 sniffs
+The PSR2R standard contains 124 sniffs
 
 Generic (20 sniffs)
 -------------------
@@ -53,7 +53,7 @@ PSR2 (4 sniffs)
 - PSR2.Namespaces.NamespaceDeclaration
 - PSR2.Namespaces.UseDeclaration
 
-PSR2R (66 sniffs)
+PSR2R (67 sniffs)
 -----------------
 - PSR2R.Classes.BraceOnSameLine
 - PSR2R.Classes.ClassCreateInstance
@@ -64,6 +64,7 @@ PSR2R (66 sniffs)
 - PSR2R.Classes.TraitName
 - PSR2R.Commenting.DocBlock
 - PSR2R.Commenting.DocBlockEnding
+- PSR2R.Commenting.DocBlockNoEmpty
 - PSR2R.Commenting.DocBlockParam
 - PSR2R.Commenting.DocBlockParamAllowDefaultValue
 - PSR2R.Commenting.DocBlockParamArray