Download the PHP package mnapoli/sniff without Composer
On this page you can find all versions of the php package mnapoli/sniff. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mnapoli/sniff
More information about mnapoli/sniff
Files in mnapoli/sniff
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sniff
Sniff
Simpler PHP code sniffer, built on top of PHP-CS-Fixer.
This project has been replaced by Pretty
Why?
PHP-CS-Fixer can validate and fix the formatting of your code.
Sniff is a command that wraps php-cs-fixer to make it easier to use and configure.
It boils down to a simple .sniff.json file and 3 commands:
Validates that your code complies with your coding standard. Useful in CI to run on each pull request or commit.
Validates that your code complies with your coding standard and outputs the diff necessary to fix the errors. Useful to review the fixes before applying them.
Fix your code to make it compliant with your coding standard.
Installation
You can then invoke the command with:
You can also install it globally with Composer to be able to call it with sniff:
composer global require mnapoli/sniff- add the
~/.composer/binpath to yourPATH
Configuration
Sniff is configured using a .sniff.json file:
paths(mandatory): list of directories or files to analyzerules(default:@PSR2): list of rules to enable (detailed below)allow-risky(default: no): allows you to set whether risky rules may run (a risky rule is a rule which could change the code's behaviour)
The complete list of rules is detailed in PHP-CS-Fixer's documentation.
Below is an example that enables PSR-2 + Symfony's coding standard, along with a few custom options:
Contributing
To run the tests:
Credits
This project is only a small wrapper above PHP-CS-Fixer, a huge thanks to the contributors of that tool.
Sniff is heavily inspired from Coke, a nice wrapper for PHP Code Sniffer.
License
Sniff is licensed under the MIT license.
