https://github.com/uzulla/phpstorm-inspect-code-cli-runner
CLI tool that runs PhpStorm's code inspections and outputs structured results for easier refactoring and find bugs.
https://github.com/uzulla/phpstorm-inspect-code-cli-runner
codequality php phpstorm refactoring-tools
Last synced: about 1 month ago
JSON representation
CLI tool that runs PhpStorm's code inspections and outputs structured results for easier refactoring and find bugs.
- Host: GitHub
- URL: https://github.com/uzulla/phpstorm-inspect-code-cli-runner
- Owner: uzulla
- License: other
- Created: 2025-03-18T17:50:37.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-03-18T18:24:34.000Z (about 1 month ago)
- Last Synced: 2025-03-18T18:50:53.606Z (about 1 month ago)
- Topics: codequality, php, phpstorm, refactoring-tools
- Language: PHP
- Homepage:
- Size: 740 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phpstorm-inspect-code-cli-runner
This package enables you to comfortably use PhpStorm as a CLI tool for static analysis.
## Features
* Wrapper for PhpStorm's `inspect.sh` script with additional functionality
* Waits for PhpStorm to finish already running inspections
* Clears PhpStorm's cache before every run to prevent stale cache issues
* Parses XML output generated by PhpStorm and presents it in a readable form
* Supports both text and checkstyle output formats
* Modern PHP 8.3 implementation with Symfony Console integration
* Tested with PHPStorm 2024.3
## Installation
```bash
composer require shopsys/phpstorm-inspect
```
## Usage
```bash
vendor/bin/phpstorm-inspect inspect \
--inspect-sh=/path/to/PhpStorm/bin/inspect.sh \
--system-path=/path/to/.WebIde*/system \
--project-path=/path/to/project \
--profile=/path/to/project/.idea/inspectionProfiles/Project_Default.xml \
--directory=/path/to/inspect \
--format=text
```
### Arguments
* `--inspect-sh`: Path to `inspect.sh` script
* `--system-path`: Path to `.WebIde*/system` directory
* `--project-path`: Path to project directory (that contains `.idea` directory)
* `--profile`: Path to inspection profile XML file
* `--directory`: Path in which are the inspected sources
* `--format`: Format of output result, accepted values: "text" (default) / "checkstyle"
### Environment Configuration
You can configure PhpStorm binary paths using a `.env` file:
1. Copy the `.env.example` file to `.env` in the project root:
```bash
cp .env.example .env
```
2. Edit the `.env` file with your specific paths:
```
PHPSTORM_INSPECT_SH=/path/to/PhpStorm/bin/inspect.sh
PHPSTORM_SYSTEM_PATH=/path/to/.WebIde*/system
```
When environment variables are set, you can omit the corresponding command-line options:
```bash
vendor/bin/phpstorm-inspect inspect \
--project-path=/path/to/project \
--profile=/path/to/project/.idea/inspectionProfiles/Project_Default.xml \
--directory=/path/to/inspect \
--format=text
```
## Example Usage
### Creating a Simple Inspection Profile
If you don't have an existing inspection profile, you can create a simple one:
```xml
```
Save this to a file named `inspection-profile.xml` in your project directory.
### Running the Inspection
You can run the inspection on your project's source code:
```bash
php bin/phpstorm-inspect --project-path=$(pwd) --profile=$(pwd)/inspection-profile.xml --directory=$(pwd)/src
```
### Self-Inspection Example
A good way to test the tool is to use it to inspect its own code:
```bash
# Create a simple inspection profile
cat > inspection-profile.xml << 'EOF'
EOF
# Run the inspection on the tool's own code
php bin/phpstorm-inspect --project-path=$(pwd) --profile=$(pwd)/inspection-profile.xml --directory=$(pwd)/src
```
### Sample Output (Text Format)
When running the self-inspection example above, you'll get output similar to this:
```
File: /path/to/project/src/PhpStormInspect/Command/InspectCommand.php
--------------------------------------------------------------------------------
Found 15 problems
--------------------------------------------------------------------------------
Line 25: Missing PHPDoc comment: Missing PHPDoc comment for class
Line 27: Class constant type is missing: Class constant type is missing
Line 28: Class constant type is missing: Class constant type is missing
Line 30: Missing parent call for method: Missing parent method call
Line 30: unused declaration: Method is never used.
Line 72: Missing parent call for method: Missing parent method call
Line 72: unused declaration: Method is never used.
Line 83: Fully qualified name usage: Qualifier can be replaced with an import
Line 89: Fully qualified name usage: Qualifier can be replaced with an import
Line 110: Fully qualified name usage: Qualifier can be replaced with an import
Line 120: Fully qualified name usage: Qualifier can be replaced with an import
Line 125: Fully qualified name usage: Qualifier can be replaced with an import
Line 142: Fully qualified name usage: Qualifier can be replaced with an import
Line 152: Fully qualified name usage: Qualifier can be replaced with an import
Line 165: Fully qualified name usage: Qualifier can be replaced with an import
--------------------------------------------------------------------------------
File: /path/to/project/src/PhpStormInspect/Inspection/InspectionRunner.php
--------------------------------------------------------------------------------
Found 5 problems
--------------------------------------------------------------------------------
Line 10: Missing PHPDoc comment: Missing PHPDoc comment for class
Line 12: Class constant type is missing: Class constant type is missing
Line 13: Class constant type is missing: Class constant type is missing
Line 69: Fully qualified name usage: Qualifier can be replaced with an import
Line 73: Fully qualified name usage: Qualifier can be replaced with an import
--------------------------------------------------------------------------------
... (more files and issues) ...
```
This output shows various code quality issues that PhpStorm's inspection has found, such as:
- Missing PHPDoc comments
- Missing class constant types
- Missing parent method calls
- Fully qualified name usage that could be replaced with imports
- Unused declarations
- And more
### Sample Output (Checkstyle Format)
You can also get the output in checkstyle format, which is useful for integration with CI tools:
```bash
php bin/phpstorm-inspect --project-path=$(pwd) --profile=$(pwd)/inspection-profile.xml --directory=$(pwd)/src --format=checkstyle
```
Output:
```xml
```
The checkstyle format is particularly useful for integrating with CI/CD pipelines and other tools that can process this standard format.
## Tips for Effective Usage
### Customizing Inspection Profiles
For more comprehensive code quality checks, you can create a custom inspection profile in PhpStorm:
1. Open your project in PhpStorm
2. Go to Settings/Preferences → Editor → Inspections
3. Configure the inspections you want to enable/disable
4. Click the gear icon and select "Export" to save your profile as an XML file
5. Use this exported file with the `--profile` option
### Integrating with CI/CD
To integrate with CI/CD pipelines:
1. Use the checkstyle output format (`--format=checkstyle`)
2. Save the output to a file: `php bin/phpstorm-inspect ... --format=checkstyle > phpstorm-inspection.xml`
3. Use a tool like [checkstyle-formatter](https://www.npmjs.com/package/checkstyle-formatter) to convert the output to HTML or other formats
4. Configure your CI system to fail the build if certain types or numbers of issues are found
### Performance Considerations
- The first run may take longer as PhpStorm builds its indexes
- For large projects, consider inspecting specific directories rather than the entire project
- Clearing the cache (which this tool does automatically) helps prevent stale cache issues but may increase inspection time
## License
MIT License (see LICENSE file)
> This is a modernized version of [shopsys/phpstorm-inspect](https://github.com/shopsys/phpstorm-inspect) updated for PHP 8.3.