https://github.com/facile-it/facile-coding-standard
Repository with all coding standard ruleset used in Facile.it
https://github.com/facile-it/facile-coding-standard
code-style hacktoberfest php
Last synced: 6 months ago
JSON representation
Repository with all coding standard ruleset used in Facile.it
- Host: GitHub
- URL: https://github.com/facile-it/facile-coding-standard
- Owner: facile-it
- Created: 2017-02-01T18:08:11.000Z (almost 9 years ago)
- Default Branch: 1.x
- Last Pushed: 2025-05-30T22:34:41.000Z (7 months ago)
- Last Synced: 2025-05-31T09:22:21.897Z (7 months ago)
- Topics: code-style, hacktoberfest, php
- Language: PHP
- Homepage:
- Size: 420 KB
- Stars: 10
- Watchers: 25
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Facile.it PHP Coding Standard
[]( https://github.com/facile-it/facile-coding-standard/actions?query=workflow%3A%22Continuous+Integration%22+branch%3A1.x)
[](https://codecov.io/gh/facile-it/facile-coding-standard)
[](https://packagist.org/packages/facile-it/facile-coding-standard)
[](https://packagist.org/packages/facile-it/facile-coding-standard)
[](https://packagist.org/packages/facile-it/facile-coding-standard)
[](https://packagist.org/packages/facile-it/facile-coding-standard)
[](https://packagist.org/packages/facile-it/facile-coding-standard)
Repository with PHP coding standard ruleset, based on PHP-CS-Fixer.
## Installation
Currently, [Composer](https://getcomposer.org/) is the only supported installation tool.
```
$ composer require --dev facile-it/facile-coding-standard
```
When you install it, a plugin will ask you some questions to setup your project automatically.
The installer will add a `.php-cs-fixer.dist.php` file in your project root directory,
then you can edit manually if you need some changes.
The CS config will be configured to find your project files using
composer autoload sources.
Only `psr-0`, `psr-4` and `classmap` autoloads are supported.
The installer will also add two scripts in your `composer.json`;
```php
"scripts": {
"cs-check": "php-cs-fixer fix --dry-run --diff",
"cs-fix": "php-cs-fixer fix --diff"
}
```
## Configuration
The installation configuration should be enough to use it.
If you need to change the CS config file, we suggest to don't edit the main `.php-cs-fixer.dist.php` file.
You can create a new file `.php-cs-fixer.php` with something like this:
```php
setUsingCache(false);
return $config;
```
## Usage
To start code style check:
```
$ composer cs-check
```
To automatically fix code style:
```
$ composer cs-fix
```
## PhpCsFixer configuration
See [PhpCsFixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) GitHub page.
## Risky rules
Risky rules may be unstable, and cause unintended behavioral changes to your code. If you want to add these rules, you can create your own `.php-cs-fixer.php`
configuration:
```php
setRules($rulesProvider->getRules());
return $config;
```
## Generate configuration
If you have any problem updating to a new version, you can regenerate
the default `.php-cs-fixer.dist.php` with the command:
```
$ composer facile-cs-create-config
```
```
$ composer facile-cs-create-config --help
Usage:
facile-cs-create-config [options]
Options:
--no-dev Do not include autoload-dev directories
--no-risky Do not include risky rules
```