Add namespace spacing sniff

Author: dereuromark

PSR2R/Sniffs/WhiteSpace/NamespaceSpacingSniff.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace PSR2R\Sniffs\WhiteSpace;
+
+use PHP_CodeSniffer\Files\File;
+use PSR2R\Tools\AbstractSniff;
+
+/**
+ * Checks that the namespace declaration and body has correct spacing.
+ *
+ * @author Mark Scherer
+ * @license MIT
+ */
+class NamespaceSpacingSniff extends AbstractSniff {
+
+	/**
+	 * @inheritDoc
+	 */
+	public function register() {
+		return [T_NAMESPACE];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function process(File $phpcsFile, $stackPtr) {
+		$tokens = $phpcsFile->getTokens();
+
+		$beforeIndex = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
+		$beforeLine = $tokens[$beforeIndex]['line'];
+
+		if ($beforeLine === $tokens[$stackPtr]['line'] - 2) {
+			return;
+		}
+
+		$error = 'There must be one blank line before the namespace declaration';
+		$fix = $phpcsFile->addFixableError($error, $stackPtr, 'BlankLineBefore');
+		if (!$fix) {
+			return;
+		}
+
+		if ($beforeLine < $tokens[$stackPtr]['line'] - 2) {
+			$phpcsFile->fixer->beginChangeset();
+			$phpcsFile->fixer->replaceToken($stackPtr - 1, '');
+			$phpcsFile->fixer->endChangeset();
+
+			return;
+		}
+
+		$phpcsFile->fixer->beginChangeset();
+		$phpcsFile->fixer->addNewline($beforeIndex);
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

PSR2R/Tools/Traits/CommentingTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace PSR2R\Tools\Traits;
 
 use PHP_CodeSniffer\Files\File;

PSR2R/Tools/Traits/NamespaceTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace PSR2R\Tools\Traits;
 
 use PHP_CodeSniffer\Files\File;

docs/sniffs.md

@@ -1,7 +1,7 @@
 # PSR2R Code Sniffer
 
 
-The PSR2R standard contains 127 sniffs
+The PSR2R standard contains 128 sniffs
 
 Generic (21 sniffs)
 -------------------
@@ -55,7 +55,7 @@ PSR2 (4 sniffs)
 - PSR2.Namespaces.NamespaceDeclaration
 - PSR2.Namespaces.UseDeclaration
 
-PSR2R (68 sniffs)
+PSR2R (69 sniffs)
 -----------------
 - PSR2R.Classes.BraceOnSameLine
 - PSR2R.Classes.ClassCreateInstance
@@ -120,6 +120,7 @@ PSR2R (68 sniffs)
 - PSR2R.WhiteSpace.EmptyLines
 - PSR2R.WhiteSpace.LanguageConstructSpacing
 - PSR2R.WhiteSpace.MethodSpacing
+- PSR2R.WhiteSpace.NamespaceSpacing
 - PSR2R.WhiteSpace.ObjectAttributeSpacing
 - PSR2R.WhiteSpace.OperatorSpacing
 - PSR2R.WhiteSpace.TabAndSpace