Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnapoli/pretty
✨ CLI command with sane defaults to simplify CodeSniffer and PHP-CS-Fixer
https://github.com/mnapoli/pretty
code-formatter coding-standards coding-style php psr-1 psr-2
Last synced: 10 days ago
JSON representation
✨ CLI command with sane defaults to simplify CodeSniffer and PHP-CS-Fixer
- Host: GitHub
- URL: https://github.com/mnapoli/pretty
- Owner: mnapoli
- License: mit
- Created: 2017-11-14T21:56:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-07T13:32:34.000Z (almost 4 years ago)
- Last Synced: 2024-10-27T05:12:45.176Z (14 days ago)
- Topics: code-formatter, coding-standards, coding-style, php, psr-1, psr-2
- Language: PHP
- Homepage: https://prettyci.com
- Size: 27.3 KB
- Stars: 108
- Watchers: 8
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://prettyci.com/)
**A single CLI command with sane defaults to simplify CodeSniffer and PHP-CS-Fixer.**
---
[PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) and [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) are powerful but using them is not simple. It is not always obvious which tool a project uses and whether there is a configuration file to use or whether you need to provide options to the CLI command.
Now it's easy, simply run:
```
pretty
```
*Pretty* will detect the configuration file that exist in the current directory and will run the correct tool. If no configuration file exist, *Pretty* will run PHP CodeSniffer with PSR-2 by default.
If errors are found, simply run:
```
pretty fix
```
Again, *Pretty* will run the appropriate tool (`php-cs-fixer` or `phpcbf`) to fix as many errors as possible in your code.
## Installation
If you have already [set up a global install of Composer](http://akrabat.com/php/global-installation-of-php-tools-with-composer/) just run:
```
composer global require mnapoli/pretty
```
*Pretty* comes with no dependencies so it should not bring any conflict in Composer.
You can also install it as a local dependency of your project with `composer require --dev mnapoli/pretty`. In that case you can start the tool with `vendor/bin/pretty`.
You will be able to update to new versions by running:
```
composer global update mnapoli/pretty
```
## Usage
Running an analysis is as simple as running:
```
pretty
```
This command will not change any code. To fix errors reported by this command, simply run:
```
pretty fix
```
In case you are running the analyses in CI you might want to run:
```
pretty ci
```
This will disable the caching option of PHP-CS-Fixer or CodeSniffer (because the cache will not be kept in CI).
## Hosted continuous integration
If you are using `pretty` in your daily development workflow you may be interested in [PrettyCI.com](https://prettyci.com/), the SaaS version of `pretty`.