Merge remote-tracking branch 'remotes/origin/master' into develop

Author: dereuromark

PSR2R/Sniffs/Commenting/FullyQualifiedClassNameInDocBlockSniff.php

@@ -190,6 +190,8 @@ protected function findInSameNameSpace(File $phpCsFile, $className) {
 		if (!$currentNameSpace) {
 			return null;
 		}
+		$currentNameSpaceInfo = $this->getNamespaceInfo($phpCsFile);
+		$currentNameSpace = $currentNameSpaceInfo['namespace'];
 
 		$file = $phpCsFile->getFilename();
 		$dir = dirname($file) . DIRECTORY_SEPARATOR;

PSR2R/Sniffs/Namespaces/UnusedUseStatementSniff.php

@@ -54,7 +54,7 @@ public function process(File $phpcsFile, $stackPtr) {
 			return;
 		}
 
-		$classUsed = $phpcsFile->findNext(T_STRING, ($classNameIndex + 1), null, false, $tokens[$classNameIndex]['content']);
+		$classUsed = $phpcsFile->findNext([T_STRING, T_RETURN_TYPE], ($classNameIndex + 1), null, false, $tokens[$classNameIndex]['content']);
 
 		while ($classUsed !== false) {
 			$beforeUsage = $phpcsFile->findPrevious(
@@ -74,7 +74,7 @@ public function process(File $phpcsFile, $stackPtr) {
 				return;
 			}
 
-			$classUsed = $phpcsFile->findNext(T_STRING, ($classUsed + 1), null, false, $tokens[$classNameIndex]['content']);
+			$classUsed = $phpcsFile->findNext([T_STRING, T_RETURN_TYPE], ($classUsed + 1), null, false, $tokens[$classNameIndex]['content']);
 		}
 
 		$warning = 'Unused use statement';

README.md

@@ -69,9 +69,19 @@ For Win OS you should be using `\` as separator:
 vendor\bin\sniff -v
 ```
 
-#### Hook it into your IDE for live-correction
-You can easily make a "watcher" for your IDE, so any file you work on, will be auto-corrected when (auto-)saving.
-For PHPStorm, for example, make sure you switch `Show Console` to `never` to not be disturbed by it all the time.
+#### Include it in your IDE via hotkey
+E.g. for PHPStorm:
+* Open Settings -> Tools -> External Tools
+* Add a new tool named "cs-sniffer" and set Program to `$ProjectFileDir$/vendor/bin/phpcs`, Parameters to `--standard=$ProjectFileDir$/vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml -p $FilePath$` and Working directoy to `$ProjectFileDir$`.
+* Add a new tool named "cs-fixer" and set Program to `$ProjectFileDir$/vendor/bin/phpcbf`, Parameters to `--standard=$ProjectFileDir$/vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml -v $FilePath$` and Working directoy to `$ProjectFileDir$`.
+* Optionally uncheck "Open console" if you don't want to see any output here for the fixer.
+* Now set up your hotkeys under Settings -> Keymap (search for cs-sniffer and cs-fixer). E.g. `Control + Comma` for sniffing, and `Control + Dot` for fixing.
+
+##### Hook it into your IDE for live-correction
+You can also easily make a "watcher" for your IDE, so any file you work on, will be auto-corrected when (auto-)saving.
+But here you should better only whitelist certain sniffs that only add things and don't remove anything.
+
+Note: For PHPStorm, for example, make sure you switch `Show Console` to `never` to not be disturbed by it all the time.
 
 ### Writing new sniffs
 You can contribute by adding new sniffs as per PSR-2-R standard.

bin/sniff.php

@@ -1,15 +1,14 @@
 #!/usr/bin/php -q
 <?php
 
-/**
- * Bin stub.
- */
 $options = [
-	__DIR__ . '/../../../autoload.php',
-	__DIR__ . '/../../autoload.php',
 	__DIR__ . '/../vendor/autoload.php',
 	__DIR__ . '/vendor/autoload.php'
 ];
+if (!empty($_SERVER['PWD'])) {
+	array_unshift($options, $_SERVER['PWD'] . '/vendor/autoload.php');
+}
+
 foreach ($options as $file) {
 	if (file_exists($file)) {
 		define('SNIFFER_COMPOSER_INSTALL', $file);

bin/tokenize.php

@@ -1,15 +1,14 @@
 #!/usr/bin/php -q
 <?php
 
-/**
- * Bin stub.
- */
 $options = [
-	__DIR__ . '/../../../autoload.php',
-	__DIR__ . '/../../autoload.php',
 	__DIR__ . '/../vendor/autoload.php',
 	__DIR__ . '/vendor/autoload.php'
 ];
+if (!empty($_SERVER['PWD'])) {
+	array_unshift($options, $_SERVER['PWD'] . '/vendor/autoload.php');
+}
+
 foreach ($options as $file) {
 	if (file_exists($file)) {
 		define('SNIFFER_COMPOSER_INSTALL', $file);

composer.json

@@ -2,6 +2,8 @@
 	"name": "fig-r/psr2r-sniffer",
 	"license": "MIT",
 	"description": "Code-Sniffer, Auto-Fixer and Tokenizer for PSR-2-R",
+	"type": "phpcodesniffer-standard",
+    "keywords": ["cs", "codesniffer"],
 	"authors": [
 		{
 			"name": "Mark Scherer",

docs/README.md

@@ -111,11 +111,17 @@ You can also test specific methods per Test file using `--filter=testNameOfMetho
 ### Running own sniffs on this project
 There is a convenience script to run all sniffs for this repository:
 ```
-sh phpcs.sh
+composer cs-check
 ```
 If you want to fix the fixable errors, use
 ```
-sh phpcs.sh -f
+composer cs-fix
 ```
 Make sure the root folder name is the same as the GitHub repository name (psr2r-sniffer) to exclude vendor as expected.
 Once everything is green you can make a PR with your changes.
+
+### Updating docs
+Run
+```
+composer docs
+```

docs/sniffs.md

@@ -1,7 +1,7 @@
 # PSR2R Code Sniffer
 
 
-The PSR2R/ruleset.xml standard contains 101 sniffs
+The PSR2R/ruleset.xml standard contains 102 sniffs
 
 Generic (13 sniffs)
 -------------------
@@ -25,7 +25,7 @@ PEAR (3 sniffs)
 - PEAR.Functions.ValidDefaultValue
 - PEAR.NamingConventions.ValidClassName
 
-PSR2R (64 sniffs)
+PSR2R (65 sniffs)
 -----------------
 - PSR2R.Classes.BraceOnSameLine
 - PSR2R.Classes.ClassCreateInstance
@@ -38,6 +38,7 @@ PSR2R (64 sniffs)
 - PSR2R.Commenting.DocBlockParamAllowDefaultValue
 - PSR2R.Commenting.DocBlockParamArray
 - PSR2R.Commenting.DocBlockParamNoOp
+- PSR2R.Commenting.DocBlockParamNotJustNull
 - PSR2R.Commenting.DocBlockParam
 - PSR2R.Commenting.DocBlockPipeSpacing
 - PSR2R.Commenting.DocBlockReturnSelf