https://github.com/brainbits/phpcs-standard
The brainbits PHP coding standard.
https://github.com/brainbits/phpcs-standard
Last synced: 12 months ago
JSON representation
The brainbits PHP coding standard.
- Host: GitHub
- URL: https://github.com/brainbits/phpcs-standard
- Owner: brainbits
- Created: 2017-09-19T14:30:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T09:43:58.000Z (about 2 years ago)
- Last Synced: 2024-04-25T03:02:25.743Z (almost 2 years ago)
- Language: PHP
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
How to Use
==========
Global
------
1. Clone repository
2. Install dependencies
```bash
composer install
```
3. Configure standard:
```bash
{install-dir}/vendor/bin/phpcs --config-set default_standard BrainbitsCodingStandard
```
4. Execute:
```bash
{install-dir}/vendor/bin/phpcs {src-dir}
```
In Project
----------
1. Add the standard to your project:
```bash
composer require brainbits/phpcs-standard
```
2. Configure standard:
```bash
vendor/bin/phpcs --config-set default_standard BrainbitsCodingStandard
```
3. Execute:
```bash
vendor/bin/phpcs {src-dir}
```
In Project with Ruleset Customization
-------------------------------------
1. Add the standard to your project:
```bash
composer require brainbits/phpcs-standard
```
2. Create phpcs.xml (See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage)
1. Include brainbits ruleset:
```xml
```
2. Add default src-dir:
```xml
{src-dir}
```
3. Tweak to your needs, for example add rules or disable rules included in the brainbits standard.
3. Execute:
```bash
vendor/bin/phpcs
```
Docker
------
1. docker run -it --rm -v $PWD:/app brainbits/phpcs-standard {src-dir}
Used Code Styles
================
- Slevomat https://github.com/slevomat/coding-standard
- Doctrine https://github.com/doctrine/coding-standard