Set of rules for PHP_CodeSniffer and PHP-CS-Fixer used by Symplify projects.
They run best with EasyCodingStandard.
composer require symplify/coding-standard --dev
composer require symplify/easy-coding-standard --dev
- Run with ECS:
# ecs.php
use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
return static function (ECSConfig $ecsConfig): void {
+ $ecsConfig->sets([SetList::SYMPLIFY]);
Indexed PHP array item has to have one line per item
-$value = ['simple' => 1, 'easy' => 2];
+$value = ['simple' => 1,
+'easy' => 2];
Indexed PHP array opener [ and closer ] must be on own line
-$items = [1 => 'Hey'];
+$items = [
+1 => 'Hey'
+];
Strict type declaration has to be followed by empty line
declare(strict_types=1);
+
namespace App;
Array items, method parameters, method call arguments, new arguments should be on same/standalone line to fit line length.
๐ง configure it!
-function some($veryLong, $superLong, $oneMoreTime)
-{
+function some(
+ $veryLong,
+ $superLong,
+ $oneMoreTime
+) {
}
-function another(
- $short,
- $now
-) {
+function another($short, $now) {
}
Each chain method call must be on own line
-$someClass->firstCall()->secondCall();
+$someClass->firstCall()
+->secondCall();
Fixes @param, @return, @var
and inline @var
annotations broken formats
/**
- * @param string
+ * @param string $name
*/
function getPerson($name)
{
}
Remove "Created by PhpStorm" annotations
-/**
- * Created by PhpStorm.
- * User: ...
- * Date: 17/10/17
- * Time: 8:50 AM
- */
class SomeClass
{
}
Remove useless PHPStorm-generated @todo
comments, redundant "Class XY" or "gets service" comments etc.
-/**
- * class SomeClass
- */
class SomeClass
{
- /**
- * SomeClass Constructor.
- */
public function __construct()
{
- // TODO: Change the autogenerated stub
- // TODO: Implement whatever() method.
}
}
Add space after nowdoc and heredoc keyword, to prevent bugs on PHP 7.2 and lower, see https://laravel-news.com/flexible-heredoc-and-nowdoc-coming-to-php-7-3
$values = [
<<<RECTIFY
Some content
-RECTIFY,
+RECTIFY
+,
1000
];
Constructor param should be on a standalone line to ease git diffs on new dependency
final class PromotedProperties
{
- public function __construct(int $age, string $name)
- {
+ public function __construct(
+ int $age,
+ string $name
+ ) {
}
}
Indexed arrays must have 1 item per line
-$friends = [1 => 'Peter', 2 => 'Paul'];
+$friends = [
+ 1 => 'Peter',
+ 2 => 'Paul'
+];
Promoted property should be on standalone line
final class PromotedProperties
{
- public function __construct(public int $age, private string $name)
- {
+ public function __construct(
+ public int $age,
+ private string $name
+ ) {
}
}
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.