Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sirbrillig/phpcs-import-detection

A set of phpcs sniffs to look for unused or unimported symbols.
https://github.com/sirbrillig/phpcs-import-detection

linting php phpcs

Last synced: 30 days ago
JSON representation

A set of phpcs sniffs to look for unused or unimported symbols.

Awesome Lists containing this project

README 

        
# ImportDetection



A set of [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) sniffs to look for unused or unimported symbols.



This adds a sniff which shows warnings if a symbol (function, constant, class) is used and is not defined directly, imported explicitly, nor has its namespace imported.



> [!WARNING]

> PHP 8 changed how `use` statements are tokenized, leading to [this bug](https://github.com/sirbrillig/phpcs-import-detection/issues/52) which basically breaks this sniff. This sniff also has fairly poor performance. I don't have time with my current work to continue to refactor this sniff at the moment and I wouldn't recommend it until at least that issue is fixed. If anyone wants to work on improvements, feel free to open a PR!



When code is moved around, it can be problematic if classes which are used in a relative or global context get moved to a different namespace. In those cases it's better if the classes use their fully-qualified namespace, or if they are imported explicitly using `use` (in which case they can be detected by a linter like this one). These warnings should help when refactoring code to avoid bugs.



It also detects imports which are _not_ being used.



For example:



```php

namespace Vehicles;

use Registry;

use function Vehicles\startCar;

use Chocolate; // this will be a warning because `Chocolate` is never used

class Car {

  public function drive() {

    startCar(); // this is fine because `startCar` is imported

    Registry\registerCar($this); // this is fine because `Registry` is imported

    \DrivingTracker\registerDrive($this); // this is fine because it's fully-qualified

    goFaster(); // this will be a warning because `goFaster` was not imported

  }

}

```



**Note:** This sniff is a lightweight syntax checker providing a scan of the current file and it doesn't know what other files might have defined. Therefore it will warn you about implicitly imported symbols even if they're in the same namespace. It's safe to import something from the same namespace and can even improve readability, but if you'd prefer to scan multiple files, I suggest using static analysis tools like [psalm](https://psalm.dev/) or [phpstan](https://github.com/phpstan/phpstan).



## Installation



To use these rules in a project which is set up using [composer](https://href.li/?https://getcomposer.org/), we recommend using the [phpcodesniffer-composer-installer library](https://href.li/?https://github.com/DealerDirect/phpcodesniffer-composer-installer) which will automatically use all installed standards in the current project with the composer type `phpcodesniffer-standard` when you run phpcs.



```

composer require --dev sirbrillig/phpcs-import-detection dealerdirect/phpcodesniffer-composer-installer

```



## Configuration



When installing sniff standards in a project, you edit a `phpcs.xml` file with the `rule` tag inside the `ruleset` tag. The `ref` attribute of that tag should specify a standard, category, sniff, or error code to enable. It’s also possible to use these tags to disable or modify certain rules. The [official annotated file](https://href.li/?https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml) explains how to do this.



```xml



 My library.

 



```



## Sniff Codes



There are two sniff codes that are reported by this sniff. Both are warnings.



- `ImportDetection.Imports.RequireImports.Symbol`: A symbol has been used but not imported

- `ImportDetection.Imports.RequireImports.Import`: A symbol has been imported and not used



In any given file, you can use phpcs comments to disable these sniffs. For example, if you have a global class called `MyGlobalClass` which you don't want to import, you could use it like this:



```php

doSomething();

```



For a whole file, you can ignore a sniff like this:



```php

doSomething();

```



For a whole project, you can use the `phpcs.xml` file to disable these sniffs or modify their priority. For example, to disable checks for unused imports, you could use a configuration like this:



```xml



 My library.

 

 

   0

 



```



## Ignoring Symbol Patterns



Oftentimes there might be global symbols that you want to use without importing or using a fully-qualified path.



(Remember that function call resolution first searches the current namespace, then the global namespace, but constant and class resolution only searches the current namespace! You still have to import things like `Exception` or use the fully-qualified `\Exception`.)



You can ignore certain patterns by using the `ignoreUnimportedSymbols` config option. It is a regular expression. Here is an example for some common WordPress symbols:



```xml



 My library.

 

 

   

    

  

 



```



Despite the name, you can also use the `ignoreUnimportedSymbols` pattern to ignore specific unused imports.



## Ignoring Global Symbols in Global Namespace



If a file is in the global namespace, then sometimes it may be unnecessary to import functions that are also global. If you'd like to ignore global symbol use in the global namespace, you can enable the `ignoreGlobalsWhenInGlobalScope` option, like this:



```xml



 My library.

 

 

   

    

  

 



```



## Ignoring WordPress Patterns



A common use-case is to ignore all the globally available WordPress symbols. Rather than trying to come up with a pattern to ignore them all yourself, you can set the config option `ignoreWordPressSymbols` which will ignore as many of them as it knows about. For example:



```xml



 My library.

 

 

   

    

  

 



```



## 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).



```

vendor/bin/phpcs -s src/MyProject/MyClass.php

```



## See Also



- [VariableAnalysis](https://github.com/sirbrillig/phpcs-variable-analysis): Find undefined and unused variables.