Merge pull request #17 from sirbrillig/add/test-for-allowed-unused-import

Clarify ignoreUnimportedSymbols works for unused imports

Author: sirbrillig

README.md

@@ -106,6 +106,8 @@ You can ignore certain patterns by using the `ignoreUnimportedSymbols` config op
 </ruleset>
 ```
 
+Despite the name, you can also use the `ignoreUnimportedSymbols` pattern to ignore specific unused imports.
+
 ## Usage
 
 Most editors have a phpcs plugin available, but you can also run phpcs manually. To run phpcs on a file in your project, just use the command-line as follows (the `-s` causes the sniff code to be shown, which is very important for learning about an error).

tests/Sniffs/Imports/RequireImportsAllowedPatternFixture.php

@@ -4,6 +4,7 @@
 namespace CAR_APP\Vehicles\Greatness;
 
 use function whitelisted_function;
+use function unused_function;
 
 class GreatClass {
 	private function activate() {

tests/Sniffs/Imports/RequireImportsSniffTest.php

@@ -56,13 +56,14 @@ public function testRequireImportsSniffFindsUnimportedFunctionsWithNoConfig() {
 		$phpcsFile->process();
 		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
 		$expectedLines = [
-			11,
+			7,
 			12,
+			13,
 		];
 		$this->assertEquals($expectedLines, $lines);
 	}
 
-	public function testRequireImportsSniffIgnoresAllowedImports() {
+	public function testRequireImportsSniffIgnoresWhitelistedUnimportedSymbols() {
 		$fixtureFile = __DIR__ . '/RequireImportsAllowedPatternFixture.php';
 		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
 		$helper = new SniffTestHelper();
@@ -74,7 +75,23 @@ public function testRequireImportsSniffIgnoresAllowedImports() {
 		);
 		$phpcsFile->process();
 		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
-		$expectedLines = [ 12 ];
+		$expectedLines = [ 7, 13 ];
+		$this->assertEquals($expectedLines, $lines);
+	}
+
+	public function testRequireImportsSniffIgnoresWhitelistedUnusedImports() {
+		$fixtureFile = __DIR__ . '/RequireImportsAllowedPatternFixture.php';
+		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
+		$helper = new SniffTestHelper();
+		$phpcsFile = $helper->prepareLocalFileForSniffs($sniffFile, $fixtureFile);
+		$phpcsFile->ruleset->setSniffProperty(
+			'ImportDetection\Sniffs\Imports\RequireImportsSniff',
+			'ignoreUnimportedSymbols',
+			'/^(unused_function)$/'
+		);
+		$phpcsFile->process();
+		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
+		$expectedLines = [ 12, 13 ];
 		$this->assertEquals($expectedLines, $lines);
 	}