PHP download

Download the PHP package shopsys/phpstorm-inspect without Composer

On this page you can find all versions of the php package shopsys/phpstorm-inspect. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download shopsys/phpstorm-inspect
More information about shopsys/phpstorm-inspect
Files in shopsys/phpstorm-inspect

Vendor shopsys
Package phpstorm-inspect
Short Description Package for running PhpStorm's inspections from CLI and displaying results
License MIT

Keywords inspection phpstorm code quality

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of shopsys/phpstorm-inspect

Informations about the package phpstorm-inspect

phpstorm-inspect

This package enables you to comfortably use PhpStorm as a CLI tool for static analysis.

Basically, it is a wrapper for PhpStorm's inspect.sh script that does some extra work:

waits for PhpStorm to finish already running inspections (because PhpStorm cannot run more instances of inspect.sh in simultaneously; see IDEA-150272)
clears PhpStorm's cache before every run in order to prevent stale cache issues (otherwise PhpStorm sometimes fails to see new files when switching GIT branches)
parses XML output generated by PhpStorm and presents it in a readable form (similar to tools like PHP CodeSniffer, PHPMD or PHP CS Fixer)

Usage

Arguments description

inspectShExecutableFilepath - path to inspect.sh script
phpstormSystemPath - path to .WebIde*/system directory
projectPath - path to project directory (that contains .idea directory)
inspectionProfileFilepath - path to inspection profile XML file
inspectedDirectory - path in which are the inspected sources
format (optional) - format of output result, accepted values: "text" (default value) / "checkstyle"

Example (text format)

Output

Example (checkstyle format)

Content of report.xml

FAQ / Issues

Why should I use this package when I can simply run the inspections from IDE?

This package comes handy in environments where you do not have graphical interface.

For example, you can run static code analysis on your Continuous Integration server (eg. Jenkins).

Does CLI inspections work when PhpStorm IDE is running?

Unfortunately not. PhpStorm currently does not support running inspect.sh script when IDE is running. You need to close the IDE when you want to run inspections from CLI.

What PhpStorm versions are supported?

The package was tested with PhpStorm 8.0 (139.732) but the newer versions will probably work too.

All versions of phpstorm-inspect with dependencies

PHP Build Version

Package Version

Version v1.1.1 Release 11. Sep 2017
create-project require 1 people choosed require and
0 people choosed create-project.

Download

Download latest version of phpstorm-inspect from vendor shopsys

Requires php Version >=5.4
arvenil/ninja-mutex Version 0.4.1
symfony/filesystem Version @stable

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package shopsys/phpstorm-inspect contains the following files

Loading the files please wait ....