fuegas / vanilla-psr
A modified ruleset for Coding Style checks
Installs: 3 691
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
This package is not auto-updated.
Last update: 2024-08-25 06:25:32 UTC
README
A modified ruleset for Code Style checks. It is based on PSR-2 but allows to indent with 2 spaces instead of 4.
Known issues:
None for now. When you find an issue, please create an issue.
Usage:
You can reference the library
Composer
Vanilla-psr can be installed using using composer. Simply add fuegas/vanilla-psr
to your composer.json file.
{ "require": { "fuegas/vanilla-psr": "*" } }
PHPCS
You can use the ruleset with the command ``.
If you only want to type phpcs
you can create the file phpcs.xml
in the root of your project with contents like this:
<?xml version="1.0"?> <ruleset name="Vanilla PSR"> <description>Coding standard using vanilla PSR.</description> <file>src/FileToTest.php</file> <file>tests/*.php</file> <file>tests/**/*.php</file> <rule ref="<dir_to_ruleset>/vanilla-psr/ruleset.xml"/> </ruleset>
If you want to use the standard from cli you can use the following command:
vendor/bin/phpcs \
--standard=vanilla-psr \
--runtime-set installed_paths vendor/fuegas/vanilla-psr \
tests
Grunt
If you use Grunt to automate the check of coding style standards, the following option can be set to use vanilla-psr (assuming you installed vanilla-psr using composer):
phpcs: { options: { standard: './vendor/fuegas/vanilla-psr/vanilla-psr/ruleset.xml', } }
Changelog
Next
1.2.0
- Fix standard paths so they can be detected and included
1.1
- FIX multiline declarations of methods and switches, 2 spaces indenting can be used
- FIX multiline call, 2 spaces indenting can be used
1.0
- Base ruleset on PSR-2
- Allow indenting of 2 spaces instead of 4