dngb / phalcon-coding-standard
CodeSniffer ruleset for the Phalcon coding standard (PCG Cube flavor)
Installs: 61 045
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:coding-standard
Requires
Conflicts
- squizlabs/php_codesniffer: <3 || >=4
This package is not auto-updated.
Last update: 2025-03-02 07:53:39 UTC
README
A coding standard to check against the Phalcon coding standards, with slight modifications.
Important note: Please be careful using this library, as it is for internal usage, and probably will not be maintained
Project fork from: (https://github.com/karen-nalbandian/phalcon-coding-standard) + exclude NamingConventions.ValidVariableName.NotCamelCaps
Differences
The following standards has been modified:
- added the Phalcon.Commenting.FunctionComment.MissingParamType
- removed the Phalcon.Commenting.FunctionComment.SpacingAfterParamType
- removed the Phalcon.Commenting.Annotations.Invalid
- removed the Phalcon.Functions.Arguments.Invalid
- removed the Squiz.Strings.ConcatenationSpacing.PaddingFound
- removed the PSR2.Classes.PropertyDeclaration.Underscore
- removed the Zend.NamingConventions.ValidVariableName.ContainsNumbers
- removed the Zend.NamingConventions.ValidVariableName.MemberVarContainsNumbers
- removed the Zend.NamingConventions.ValidVariableName.NotCamelCaps
- removed the Generic.Files.LineEndings.InvalidEOLChar
Installation
Composer
This standard can be installed with the Composer dependency manager.
-
Install the coding standard as a dependency of your project
composer require --dev dngb/phalcon-coding-standard:dev-master
-
Add the coding standard to the PHP_CodeSniffer install path
vendor/bin/phpcs --config-set installed_paths vendor/dngb/phalcon-coding-standard
-
Check the installed coding standards for "Phalcon"
vendor/bin/phpcs -i
-
Done!
vendor/bin/phpcs /path/to/code
### Stand-alone
-
Install PHP_CodeSniffer
-
Checkout this repository
git clone https://github.com/dngb/phalcon-coding-standard.git
-
Add the coding standard to the PHP_CodeSniffer install path
phpcs --config-set installed_paths /path/to/phalcon-coding-standard
Or copy/symlink this repository's "Phalcon"-folder inside the phpcs
Standards
directory -
Check the installed coding standards for "Phalcon"
phpcs -i
-
Done!
phpcs /path/to/code