Download the PHP package sirbrillig/phpcs-variable-analysis without Composer

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

Please rate this library. Is it a good library?

All versions of phpcs-variable-analysis with dependencies

Informations about the package phpcs-variable-analysis

PHP_CodeSniffer VariableAnalysis

CircleCI

Plugin for PHP_CodeSniffer static analysis tool that adds analysis of problematic variable use.

Installation

Requirements

VariableAnalysis requires PHP 5.4 or higher and PHP CodeSniffer version 3.5.0 or higher.

With PHPCS Composer Installer

This is the easiest method.

First, install phpcodesniffer-composer-installer for your project if you have not already. This will also install PHPCS.

Then install these standards.

You can then include the sniffs by adding a line like the following to your phpcs.xml file.

It should just work after that!

Standalone

  1. Install PHP_CodeSniffer (PHPCS) by following its installation instructions (via Composer, Phar file, PEAR, or Git checkout).

    Do ensure that PHP_CodeSniffer's version matches our requirements.

  2. Install VariableAnalysis. Download either the zip or tar.gz file from the VariableAnalysis latest release page. Expand the file and rename the resulting directory to phpcs-variable-analysis. Move the directory to a place where you'd like to keep all your PHPCS standards.

  3. Add the paths of the newly installed standards to the PHP_CodeSniffer installed_paths configuration. The following command should append the new standards to your existing standards (be sure to supply the actual paths to the directories you created above).

    phpcs --config-set installed_paths "$(phpcs --config-show|grep installed_paths|awk '{ print $2 }'),/path/to/phpcs-variable-analysis"

    If you do not have any other standards installed, you can do this more easily (again, be sure to supply the actual paths):

    phpcs --config-set installed_paths /path/to/phpcs-variable-analysis

Customization

There's a variety of options to customize the behaviour of VariableAnalysis, take a look at the included ruleset.xml.example for commented examples of a configuration.

The available options are as follows:

To set these these options, you must use XML in your ruleset. For details, see the phpcs customizable sniff properties page. Here is an example that ignores all variables that start with an underscore:

See Also

Original

This was forked from the excellent work in https://github.com/illusori/PHP_Codesniffer-VariableAnalysis

Contributing

Please open issues or PRs on this repository.

Any changes should be accompanied by tests and should pass linting and static analysis. Please use phpdoc (rather than actual types) for declaring types since this must run in PHP 5.4.

To run tests, make sure composer is installed, then run:

To run linting, use:

To run static analysis, use:


Version
Requires php Version >=5.4.0
squizlabs/php_codesniffer Version ^3.5

The package sirbrillig/phpcs-variable-analysis contains the following files

Loading the files please wait ....