README

This package is meant to store all the linting rules for PHP projects at Programic. It contains the following linting tools at the moment:

• Larastan
• TLint
• PHPMD
• ECS with rules from:
  • PHP Coding Standards Fixer
  • Slevomat

✅ Compatibility

🏗️ Installing

1. Require the composer package

composer require --dev programic/php-linting-rules

2. Run the setup command

vendor/bin/programic-lint-setup

This command will:

• Setup the scripts to the consuming project it's composer.json
• Brings the config files to the workspace root, if not exists. This is required for the package to work properly.

Use --force to overwrite configuration files.

👷 Usage

After installing running the setup command, you can run the following commands to check your code:

composer lint
composer lint:tlint
composer lint:phpmd
composer lint:phpstan
composer lint:ecs
composer lint:fix

Editor Setup

Some tools have integrations to work with your editor. You can find the instructions for each tool below:

• TLint for PHPstorm, Sublime or VSCode