Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.04 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.04 KB

PHP Tools

Static analysis tools for PHP projects

Provides php-cs-fixer, phpstan, psalm, rector, & twigcs as isolated composer installs within your project. This eliminates the need to worry about any underlying conflicts with tool dependencies and your own project dependencies.

Install

All commands are run from your root project directory. e.g. path/to/your-project

  1. Run composer install -d tools

  2. Run git submodule add https://github.com/rushlow-development/php-tools tools. This will "clone" the php-tools repo into path-to-project/tools.

  3. Run tools/bin/install which will run composer upgrade in each of the tool directories.

  4. Copy and paste the contents of scripts.json into your root composer.json file. This will allow you to run composer tools:run from your project root directory.

In the future

I'd like to use composer plugins / custom installers to automate this. Allowing one to run composer require --dev rushlow-development/php-tools and then the tools would be installed as needed...