Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flaconi/phpcs-coding-standard
Flaconi Coding Standard
https://github.com/flaconi/phpcs-coding-standard
php phpcs ruleset
Last synced: about 5 hours ago
JSON representation
Flaconi Coding Standard
- Host: GitHub
- URL: https://github.com/flaconi/phpcs-coding-standard
- Owner: Flaconi
- License: mit
- Created: 2018-09-05T07:37:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T21:05:57.000Z (over 1 year ago)
- Last Synced: 2024-11-16T07:36:25.010Z (about 15 hours ago)
- Topics: php, phpcs, ruleset
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 22
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Flaconi Coding Standard
[](https://packagist.org/packages/flaconi/coding-standard)
[](https://packagist.org/packages/flaconi/coding-standard)
[](https://travis-ci.org/Flaconi/phpcs-coding-standard)
[](https://coveralls.io/github/Flaconi/phpcs-coding-standard?branch=master)
Flaconi Coding Standard for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) provides sniffs that fall for now in one category:
* Test - improving the code style of phpunit test cases
## Table of contents
1. [Sniffs included in this standard](#sniffs-included-in-this-standard)
- [Test - improving the code style of phpunit test cases](#test---improving-the-code-style-of-phpunit-test-cases)
2. [Installation](#installation)
3. [How to run the sniffs](#how-to-run-the-sniffs)
- [Choose which sniffs to run](#choose-which-sniffs-to-run)
- [Using all sniffs from the standard](#using-all-sniffs-from-the-standard)
4. [Fixing errors automatically](#fixing-errors-automatically)
5. [Suppressing sniffs locally](#suppressing-sniffs-locally)
6. [Contributing](#contributing)
## Sniffs included in this standard
🔧 = [Automatic errors fixing](#fixing-errors-automatically)
### Test - improving the code style of phpunit test cases
#### FlaconiCodingStandard.Test.UseMethodPrefixInTestcase 🔧
* Checks for `@test` and force to use `test` Prefix
#### FlaconiCodingStandard.Test.UseStaticCallsForAssertInTestcase 🔧
Reports usage of non static assert method class
## Installation
The recommended way to install Flaconi Coding Standard is [through Composer](http://getcomposer.org).
```console
composer require --dev flaconi/coding-standard
```
## How to run the sniffs
You can choose one of two ways to run only selected sniffs from the standard on your codebase:
### Choose which sniffs to run
Mention Flaconi Coding Standard in your project's `ruleset.xml`:
```xml
```
When running `phpcs` [on the command line](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage), use the `--sniffs` option to list all the sniffs you want to use separated by a comma:
```
vendor/bin/phpcs --standard=ruleset.xml \
--sniffs=FlaconiCodingStandard.Test.UseStaticCallsForAssertInTestcase,FlaconiCodingStandard.Test.UseMethodPrefixInTestcase \
--extensions=php --encoding=utf-8 --tab-width=4 -sp src tests
```
Or write your own ruleset.xml by referencing the selected sniffs. This is a sample ruleset.xml:
```xml
```
Then run the `phpcs` executable the usual way:
```
vendor/bin/phpcs --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests
```
## Fixing errors automatically
Sniffs in this standard marked by the 🔧 symbol support [automatic fixing of coding standard violations](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Fixing-Errors-Automatically). To fix your code automatically, run phpcbf instead of phpcs:
```
vendor/bin/phpcbf --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests
```
Always remember to back up your code before performing automatic fixes and check the results with your own eyes as the automatic fixer can sometimes produce unwanted results.
## Contributing
To make this repository work on your machine, clone it and run these two commands in the root directory of the repository:
```
composer install
composer code-style
composer tests
```
After writing some code and editing or adding unit tests, run phing again to check that everything is OK:
```
composer code-style
composer tests
```
We are always looking forward for your bugreports, feature requests and pull requests. Thank you.