sirbrillig/phpcs-variable-analysis

What's Changed

This is a large refactor which greatly increases the speed and accuracy of phpcs-variable-analysis by adding a dependency on phpcsutils.

Dependencies

• Add phpcsutils as a dependency
• Bump minimum phpcs version from 3.5.7 to 3.13.5 (8683965)

Refactoring (using phpcsutils)

• Simplify getUseIndexForUseImport using findContainingOpeningBracket() (948d77f)
• Replace findFunctionCallArguments custom loop with PassedParameters::getParameters() (3a0b6e4)
• Replace isConstructorPromotion manual scan with FunctionDeclarations::getParameters() (5b97e89)
• Replace areAnyConditionsAClass manual loop with Conditions::hasCondition() (f4ac147)
• Simplify getListAssignments using Lists::getAssignments (75768da)
• Replace findContainingOpeningBracket with phpcsutils equivalent (6b1bdda)
• Replace isVariableInsideUnset/isVariableInsideIssetOrEmpty with phpcsutils equivalents (6a30e89)
• Simplify arrow function detection by relying on T_FN (9da451f)
• Remove unnecessary isArrowFunction block in getScopeCloseForScopeOpen (4cc7f35)

Full Changelog: v2.13.0...v3.0.0

• Restore version and dependabot updates from 2.x branch (711a32c)

Full Changelog: v3.0.0-beta.9...v3.0.0-beta.10

• Restore version and dependabot updates from the 2.x branch.

What's Changed

This is preparing for a major 3.0 release which adds a dependency on PHPCSUtils. The new version should have the same functionality, fix some subtle bugs, and increase performance by over 2x.

Dependencies

• Add phpcsutils as a dependency
• Bump minimum phpcs version from 3.5.7 to 3.13.5 (8683965)

Refactoring (using phpcsutils)

• Simplify getUseIndexForUseImport using findContainingOpeningBracket() (948d77f)
• Replace findFunctionCallArguments custom loop with PassedParameters::getParameters() (3a0b6e4)
• Replace isConstructorPromotion manual scan with FunctionDeclarations::getParameters() (5b97e89)
• Replace areAnyConditionsAClass manual loop with Conditions::hasCondition() (f4ac147)
• Simplify getListAssignments using Lists::getAssignments (75768da)
• Replace findContainingOpeningBracket with phpcsutils equivalent (6b1bdda)
• Replace isVariableInsideUnset/isVariableInsideIssetOrEmpty with phpcsutils equivalents (6a30e89)
• Simplify arrow function detection by relying on T_FN (9da451f)
• Remove unnecessary isArrowFunction block in getScopeCloseForScopeOpen (4cc7f35)

Full Changelog: v2.13.0...v3.0.0-beta.9

This is preparing for a major 3.0 release which adds a dependency on PHPCSUtils. The new version should have the same functionality, fix some subtle bugs, and increase performance by over 2x.

Dependencies

• Add PHPCSUtils as a dependency.
• Bump minimum PHPCS version from 3.5.7 to 3.13.5.

Refactoring (using PHPCSUtils)

• Simplify getUseIndexForUseImport using findContainingOpeningBracket().
• Replace findFunctionCallArguments custom loop with PassedParameters::getParameters().
• Replace isConstructorPromotion manual scan with FunctionDeclarations::getParameters().
• Replace areAnyConditionsAClass manual loop with Conditions::hasCondition().
• Simplify getListAssignments using Lists::getAssignments.
• Replace findContainingOpeningBracket with the PHPCSUtils equivalent.
• Replace isVariableInsideUnset/isVariableInsideIssetOrEmpty with PHPCSUtils equivalents.
• Simplify arrow function detection by relying on T_FN.
• Remove unnecessary isArrowFunction block in getScopeCloseForScopeOpen.

What's Changed

• Ruleset: update schema URL by @jrfnl in #353
• Update for phpcs 4.0.0 by @sirbrillig in #356

Full Changelog: v2.12.0...v2.13.0

• Ruleset: update schema URL (#353).
• Update for PHPCS 4.0.0 (#356).

What's Changed

• GH Actions: use the xmllint-validate action runner by @jrfnl in #350
• Accept namespaces in sitePassByRefFunctions by @sirbrillig in #351

Full Changelog: v2.11.22...v2.12.0

• Accept namespaces in sitePassByRefFunctions (#351).
• GH Actions: use the xmllint-validate action runner (#350).

What's Changed

• Improve phpstan configuration by @szepeviktor in #344
• Add perf-guard github workflow by @sirbrillig in #345
• Allow finding arrow function variables when arrow function is in file scope by @sirbrillig in #347

New Contributors

• @szepeviktor made their first contribution in #344

Full Changelog: v2.11.21...v2.11.22

• Allow finding arrow function variables when the arrow function is in file scope (#347).
• Add perf-guard GitHub workflow (#345).
• Improve PHPStan configuration (#344).

What's Changed

• Only search for nested arrow functions if necessary by @sirbrillig in #342

Full Changelog: v2.11.20...v2.11.21

• Only search for nested arrow functions if necessary (#342).

What's Changed

• Support nested arrow functions by @sirbrillig in #334
• Simplify detecting class properties to improve detection for anonymous classes by @sirbrillig in #337
• Handle compact inside arrow functions by @sirbrillig in #339
• Support constructor promotion with namespaced and union typehints by @sirbrillig in #333

Minor Changes

• Composer: prevent a lock file from being created by @jrfnl in #326
• Composer: psalm 5 is out of beta by @jrfnl in #327
• Tests: allow for running on PHPUnit 10/11 by @jrfnl in #328
• GH Actions: PHP 8.4 has been released by @jrfnl in #336
• Run static-analysis Github action on PHP 8.1 by @sirbrillig in #338

Full Changelog: v2.11.19...v2.11.20

• Support nested arrow functions (#334).
• Simplify detecting class properties to improve detection for anonymous classes (#337).
• Handle compact inside arrow functions (#339).
• Support constructor promotion with namespaced and union typehints (#333).
• Various housekeeping: prevent a Composer lock file (#326), Psalm 5 (#327), PHPUnit 10/11 support (#328), PHP 8.4 in CI (#336), and run static analysis on PHP 8.1 (#338).

What's Changed

• GH Actions: work around intermittent apt-get errors by @jrfnl in #322
• fix: Process variable before the end of scope by @biinari in #324

New Contributors

• @biinari made their first contribution in #324

Full Changelog: v2.11.18...v2.11.19

• Fix: process variable before the end of scope (#324).
• GH Actions: work around intermittent apt-get errors (#322).

What's Changed

• Switch to PHPCSStandards/PHP_CodeSniffer by @jrfnl in #315
• Make sure that recursive search of list assignments stays inside them by @sirbrillig in #318
• Fix nullable constructor promotion detection by @sirbrillig in #321

Full Changelog: v2.11.17...v2.11.18

• Switch to PHPCSStandards/PHP_CodeSniffer (#315).
• Make sure that recursive search of list assignments stays inside them (#318).
• Fix nullable constructor promotion detection (#321).

• Do not close scope of ref reassignment when inside else (#306).

• Allow newlines in arrow functions (#301).

• Fix scope closer detection in arrow function detection (#298).

• Use custom logic for finding arrow function scope (#296).

• Support readonly constructor promotion (#294).

• Allow non-enum tokens called 'enum' (#293).

• Add support for enum methods (#289).

• Composer: allow for the 1.0.0 version of the Composer PHPCS plugin (#287).

• Prevent detecting static closures when looking for static variables (#281).

• Fix function call detection to exclude non-function tokens (#279).

• Place static arrow function body outside of scope on static declaration check (#276). Fixes a static variable regression from #267.

Bug fix release for two regressions caused by the new static function variable scanning added in #267.

• Ignore function call arguments on static declarations processing (#273).
• Fix scanning for static variables near start of file (#274).

• Allow for loop increment expression to use a variable defined inside the loop (#262).
• Support constructor promotion (#266).
• Improve static declaration checks (#267).
• Handle inline if list destructure (#268).
• Remove php_errormsg from superglobals list (#269).
• Ignore unused parameters when a function in an abstract class is empty (#270).

• Fix a deprecation notice in PHP 8.2 (#248), plus internal housekeeping.

• Update for Composer 2.2 (#242).

• Respect ignoring undefined variables in else blocks (#239).

• Allow parsing mixed HTML and PHP (#234, #236).
• Ignore double assignment by reference if the second is inside a condition (#235).

• Start inline block scope at end of condition rather than at keyword (#230).
• Add allowUnusedVariablesInFileScope option (#229).

• Treat writing to a by-reference foreach loop variable as a read (#221).
• Properly detect variables used in quotes inside arrow functions (#222).

• Performance: only check one parent for recursive list assignment (#218). In at least one example file this brought the speed from 7 minutes down to 0.3 seconds.

A large release that backports nearly all the improvements made on the 3.0 branch to the 2.x line, with the major exception of adding PHPCSUtils as a dependency.

Notable changes since 2.9:

• Fix array_walk pass-by-reference in 2.x (#216).
• Support for PHP 7.4 arrow functions (#179).
• Rewritten and more accurate scope detection.
• Allow undefined variables inside isset and empty (#204).
• Fix error in closures with namespace separators (#197).
• Fix complex default arguments (#198).
• Handle inline if/else (#199).
• Add allowUndefinedVariablesInFileScope option (#193).
• Add allowUnusedVariablesBeforeRequire option (#196).
• Support global scope (#190).
• Add validUndefinedVariableRegexp option (#173).
• Refactor and clean up reference variables (#187).
• Add special cases for variables used in else blocks (#189).

Note: this release intentionally excludes breaking changes from the 3.0 branch, namely replacing UnusedVariable with UnusedParameter for parameters (#195) and adding sniff codes for the array assignment shortcut (#205).

Backports some 3.x features to the 2.x line.

• Add allowUnusedVariablesBeforeRequire option (originally #196).
• Add allowUndefinedVariablesInFileScope option (originally #193).

• Downgrade requirements from PHP 5.6 to 5.4 (#191, backported to 2.x).

A backport of the bugfixes from 3.0.0-beta.1 into the 2.x version without any of the PHPCSUtils changes.

• Fix comment tolerance for many sniffs.
• Clean up package structure.
• Only allow unused values in associative foreach loops with option (#167).
• Fix unused-before-used detection (#171).

A small bug fix release with test and package clean-up.

• Make assignment of a reference variable be considered a use (#128).
• Bug fix: false negative unused var (#120).
• Bug fix: $this in nested function declaration (#119).
• Bug fix: recognize use of self/static within an anonymous class (#110).
• PHPStan: document run parameters in project ruleset (#122).
• Composer: update PHPCS Composer plugin dependency (#121), move PHPCS dependency to require (#106), update DealerDirect Composer plugin requirement (#112).
• Documentation: minor fixes (#123).
• Tests: simplify the PHPCS setup method (#115), allow them to work cross-platform (#108), add testsuite name to PHPUnit config (#113).
• Remove stray composer.lock file (#117).
• Composer: make the PHPUnit requirements more flexible (#114).
• PHPCS: document run parameters in project ruleset (#107).

• Add apcu_* functions to getPassByReferenceFunctions (#103).
• Add sniff codes to README (#100).
• Mention phpcs-changed in README (#97).
• Update README to include PHPStan and linting (#96).
• Refactor methods to have nullable return types (#95).
• Tests: make sure fixtures are valid PHP.

• Consider get_defined_vars() to be a read (#92).
• Use static analysis to remove edge case bugs (#94).

• Recognize that variable variables are not assignments (#88).

• Downgrade CircleCI image to PHP 5.6 (#86). Fixes a PHP 5.6 regression introduced in 2.6.2 and corrects the Composer minimum PHP version.

• Allow global var assignment to count as a read (#83).

• Improve check for static var defs inside functions (#80).
• Allow self and static references in a trait (#76).
• Add checks for class properties (#77).

• Enable allowUnusedForeachVariables and allowUnusedCaughtExceptions (#73).

• Add ignore unused foreach option (#66).
• Allow self within class method closures (#70).
• Add allowWordPressPassByRefFunctions option (#69).
• Document site pass by ref (#71).

• Handle variable class static refs (#63).
• Ignore numeric variables (#61).
• Make allowUnusedParametersBeforeUsed default to true (#59).

• Add allowUnusedParametersBeforeUsed option (#58).