README

This is a linter for PHP with aim to implement all possible PSR rules.

This project was originally started as part of Hexlet's traineeship, but actually developed a long time after. However the hexlet- prefix remains unchanged.

Thanks to Roman Lakhtadyr for review. 🙏🏻

Installation

You can install the package globally:

composer global require sadovnik/hexlet-psr-linter

or locally:

composer require sadovnik/hexlet-psr-linter

If you're having trouble to run psr-linter after global install, make sure Composer's global binary dir is in the $PATH.

Usage

psr-linter [--fix] [--debug] <path>
psr-linter (-h | --help)
psr-linter --version

Example

psr-linter src/Symfony/Component/HttpKernel/Bundle/Bundle.php --fix

Roadmap

• Initiate boilerplate
• Function name rule
• Directory support
• Variable name rule
• «Either side-effects or definitions» rule
• Autofix using --fix flag
• JSON/YML output
• Make an interface for user rules
• Make a useful explanation of rules here in readme
• Make a friendly demo with cli usage
• Website with online linter