https://github.com/rask/php-coding-standard
PHPCS coding standard additions that please rask
https://github.com/rask/php-coding-standard
code-style coding-standard coding-standards formatting php phpcs
Last synced: 12 months ago
JSON representation
PHPCS coding standard additions that please rask
- Host: GitHub
- URL: https://github.com/rask/php-coding-standard
- Owner: rask
- License: mit
- Created: 2019-07-15T21:53:01.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T23:42:22.000Z (about 2 years ago)
- Last Synced: 2025-01-13T21:24:45.881Z (about 1 year ago)
- Topics: code-style, coding-standard, coding-standards, formatting, php, phpcs
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# rask/coding-standard
Opinionated PHP coding standard rules to be used with PHP_CodeSniffer.
## Installation
$ composer require --dev rask/coding-standard
In your `phpcs.xml`:
## Sniffs
### RaskCodingStandard.NamingConventions.VariableNaming
Variable names must be `snake_case`, must contain only `a-z`, `0-9`, and `_`, must not begin or end with an underscore, and must not contain two consecutive underscores. This also applies to properties within classes.
OK:
$hello_world_1_how_are_you2
ERROR:
$hello__World_how_are_you_
### RaskCodingStandard.NamingConventions.FunctionNaming
Function names must be `snake_case`, must contain only `a-z`, `0-9`, and `_`, must not begin or end with an underscore, and must not contain two consecutive underscores. This only applies to "loose" functions, not methods.
OK:
function hello_world() { ... }
ERROR:
function helloWorld() { ... }
## Todo
[ ] Add proper tests, the PHPCS test setup is wonky to use, maybe write a new one or copy from some place else
## License
MIT License. See [LICENSE.md](./LICENSE.md).