This repository contains the coding style followed by Worksome.
It includes configuration for ECS, PHPStan, and Rector.
Install this Composer package:
composer require --dev worksome/coding-style
Run the generate command for generating the config files:
composer generate-coding-style-stubs
Add the following section to your composer.json file:
"scripts": {
"ecs": "vendor/bin/ecs",
"ecs:fix": "vendor/bin/ecs --fix",
"phpstan": "vendor/bin/phpstan analyse",
"rector": "vendor/bin/rector process --dry-run --ansi",
"rector:fix": "vendor/bin/rector process --ansi"
},To use it, simply run one of the scripts added to composer.
$ composer ecs
$ composer ecs:fix
$ composer phpstan
$ composer rector
$ composer rector:fix
The Worksome code style extends the PSR-12 base rule set.
Note: Customised rules have a ⚙️ icon.
ArraySyntaxFixerBinaryOperatorSpacesFixer⚙️ClassDefinitionFixerLineEndingFixerListSyntaxFixerNoEmptyCommentFixerNoEmptyPhpdocFixerOperatorLinebreakFixer⚙️OrderedImportsFixer⚙️PhpdocAlignFixer⚙️PhpdocSeparationFixerSingleTraitInsertPerStatementFixerShortScalarCastFixerNoEmptyStatementFixerNoUnneededImportAliasFixerNoUnusedImportsFixerTypesSpacesFixer
CommentedOutCodeSniff⚙️ForbiddenFunctionsSniff⚙️SpaceAfterNotSniffEndFileNewlineSniffMethodDeclarationSniffSpaceAfterCastSniffLowercaseDeclarationSniffInlineControlStructureSniffLowerCaseKeywordSniffLanguageConstructSpacingSniff
ClassConstantVisibilitySniffClassMemberSpacingSniffDisallowGroupUseSniffEmptyLinesAroundClassBracesSniff⚙️ForbiddenAnnotationsSniff⚙️MethodSpacingSniffModernClassNameReferenceSniffNamespaceDeclarationSniffParameterTypeHintSpacingSniffPropertyDeclarationSniffPropertySpacingSniffRequireMultiLineCallSniffRequireMultiLineConditionSniffRequireMultiLineMethodSignatureSniffRequireMultiLineTernaryOperatorSniff⚙️RequireOneNamespaceInFileSniffRequireShortTernaryOperatorSniffRequireTrailingCommaInDeclarationSniffReturnTypeHintSpacingSniffUselessConstantTypeHintSniffUselessInheritDocCommentSniff
ConfigFilenameKebabCaseSniffDisallowBladeOutsideOfResourcesDirectorySniffDisallowCompactUsageSniffDisallowEnvUsageSniffDisallowHasFactorySniffDisallowParamNoTypeOrCommentSniffDisallowTodoCommentsSniffEventListenerSuffixSniffExceptionSuffixSniffPropertyDollarSignSniffPascalCasingEnumCasesSniffSpaceInGenericsFixer
The Worksome code style includes the following custom PHPStan rules.
Rules that are applied to all projects.
This rule is used to ensure that all PHP files include with the declare(strict_types=1) statement.
This rule prevents PHPUnit tests in favour of Pest PHP. It will allow abstract TestCase classes.
Sets up configuration for suffixing the following namespaces
App\Events:EventApp\Listener:ListenerApp\Policies:PolicyApp\Jobs:Job
This makes sures events, listeners, policies and jobs has the same suffix.
Rules that are only applied in a Laravel context.
This rule disallows the usage of the Route::resource method when combined with only or except. Instead,
partial route resources should be split into multiple routes.
Similar to DisallowPartialRouteVariableResourceRule, but prevents partial resource usage when used in a route group.
This rule will enforce the use of kebab-case for Artisan commands.
This rule will prevent checking the application environment, instead preferring that a driver based approach is used.
The Worksome code style includes various custom PHP_CodeSniffer sniffs where auto-fixers via PHP CS Fixer are not possible.
This ensures that all enum cases use pascal-casing (e.g. Case::PascalCase).
All custom sniffs specific to Laravel.
Checks if all config files are written in kebab case.
Makes sure that compact() isn't used in code.
Makes sure that you don't use env helper in your code, except for config files.
Ensures that the HasFactory trait is not used on models, this ensures that the factory class is called directly.
Enforces event listeners to end with a specific suffix, this suffix is defaulted to Listener.
| parameters | defaults |
|---|---|
| suffix | Listener |
Makes sure no .blade.php files exist outside of Laravel's resources directory.
| parameters | defaults |
|---|---|
| resourcesDirectory | {YOUR_PROJECT}/resources |
This ensures that all Exception classes should have a suffix of Exception.
All custom sniffs which are not specific to Laravel.
Makes sure that you always have a dollar sign in your properties defined in phpdoc.
/**
* @property string $name
*/
class User {}This removes all @param tags which has not specified a type or comment.
/**
* @param string $name
* @param $type some random type
* @param $other // <-- will be removed
*/
public function someMethod($name, $type, $other): void
{}This is mainly because PHPStan requires this before it sees the property as valid.
This ensures that all to-do comments are blocked from use. Jira should be used instead.
This ensures that generics types in PHPDoc comments contain a single space after the comma.
The Worksome code style includes custom Rector rules for automatically refactoring code.
This ensures that specified PHP attributes are automatically removed when they are not allowed.
- Worksome
- Kuba Werłos for the initial code for
SpaceInGenericsFixer - All Contributors