worksome / coding-style
Worksomes coding style
Installs: 540 397
Dependents: 29
Suggesters: 0
Security: 0
Stars: 47
Watchers: 18
Forks: 3
Open Issues: 0
Type:composer-plugin
Requires
- php: ^8.2
- composer-plugin-api: ^2.0
- canvural/larastan-strict-rules: ^2.1.10
- jetbrains/phpstorm-attributes: ^1.0
- larastan/larastan: ^2.9.7
- phpstan/phpstan: ^1.11
- phpstan/phpstan-mockery: ^1.1.2
- rector/rector: ^1.0
- slevomat/coding-standard: ^8.14.1
- spaze/phpstan-disallowed-calls: ^2.16
- symplify/easy-coding-standard: ^12.1.10
- thecodingmachine/safe: ^2.5
Requires (Dev)
- composer/composer: ^2.7
- friendsofphp/php-cs-fixer: ^3.53
- orchestra/testbench: ^9.5
- pestphp/pest: ^2.34
- spatie/invade: ^1.1.1
- squizlabs/php_codesniffer: ^3.8
- dev-main
- v2.15.0
- v2.14.0
- v2.13.0
- v2.12.0
- v2.11.0
- v2.10.2
- v2.10.1
- v2.10.0
- v2.9.0
- v2.8.0
- v2.7.0
- v2.6.2
- v2.6.1
- v2.6.0
- v2.5.1
- v2.5.0
- v2.4.2
- v2.4.1
- v2.4.0
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.0
- v2.1.0
- v2.0.0
- v1.1.0
- v1.0.0
- v0.29.0
- v0.28.0
- v0.27.0
- v0.26.0
- v0.25.0
- v0.24.1
- v0.24.0
- v0.23.0
- v0.22.0
- v0.21.2
- v0.21.1
- v0.21.0
- v0.20.0
- v0.19.0
- v0.18.0
- v0.17.0
- v0.16.0
- v0.15.0
- v0.14.0
- v0.13.0
- v0.12.1
- v0.12.0
- v0.11.0
- v0.10.0
- v0.9.0
- v0.8.3
- v0.8.2
- v0.8.1
- v0.8.0
- v0.7.0
- v0.6.2
- v0.6.1
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.13
- v0.3.12
- v0.3.11
- v0.3.10
- v0.3.9
- v0.3.8
- v0.3.7
- v0.3.6
- v0.3.5
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.0
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
- v0.1.0
- dev-bugfix/without-timestamps
- dev-feature/ci-ecs
- dev-feature/ci-deprecations
- dev-feat/update-require-without-timestamps
- dev-feature/php-8.3-ci
- dev-docs/add-require-without-timestamps
- dev-JIRA-13731-add-without-timestamps-phpstan-rule
- dev-sniff_out_contracts_with_interface_suffix
- dev-feature/todo-comments-phpstan
- dev-sets
- dev-prevent_global_rules
- dev-JIRA-6316_add-rule-to-disallow-todos
- dev-update_code_sniffer_version
This package is auto-updated.
Last update: 2024-10-18 07:29:45 UTC
README
This repository contains the coding style followed by Worksome.
It includes configuration for ECS, PHPStan, and Rector.
Setup
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" },
Usage
To use it, simply run one of the scripts added to composer.
$ composer ecs
$ composer ecs:fix
$ composer phpstan
$ composer rector
$ composer rector:fix
ECS Rules
The Worksome code style extends the PSR-12 base rule set.
Excluded / Skipped Rules
Additional / Customised Rules
Note: Customised rules have a ⚙️ icon.
PhpCsFixer
ArraySyntaxFixer
BinaryOperatorSpacesFixer
⚙️BlankLineBeforeStatementFixer
⚙️ClassAttributesSeparationFixer
ClassDefinitionFixer
LineEndingFixer
ListSyntaxFixer
NoEmptyCommentFixer
NoEmptyPhpdocFixer
OperatorLinebreakFixer
⚙️OrderedImportsFixer
⚙️PhpdocAlignFixer
⚙️PhpdocNoUselessInheritdocFixer
PhpdocSeparationFixer
PhpdocTrimFixer
SingleQuoteFixer
SingleTraitInsertPerStatementFixer
ShortScalarCastFixer
StandardizeNotEqualsFixer
NoEmptyStatementFixer
NoUnneededImportAliasFixer
NoUnusedImportsFixer
TrailingCommaInMultilineFixer
TypesSpacesFixer
PHP CodeSniffer
CommentedOutCodeSniff
⚙️ForbiddenFunctionsSniff
⚙️SpaceAfterNotSniff
EndFileNewlineSniff
MethodDeclarationSniff
SpaceAfterCastSniff
LowercaseDeclarationSniff
InlineControlStructureSniff
LowerCaseKeywordSniff
LanguageConstructSpacingSniff
Slevomat Coding Standard
ClassConstantVisibilitySniff
ClassMemberSpacingSniff
DisallowGroupUseSniff
EmptyLinesAroundClassBracesSniff
⚙️ForbiddenAnnotationsSniff
⚙️MethodSpacingSniff
ModernClassNameReferenceSniff
NamespaceDeclarationSniff
ParameterTypeHintSpacingSniff
PropertyDeclarationSniff
PropertySpacingSniff
RequireMultiLineCallSniff
RequireMultiLineConditionSniff
RequireMultiLineMethodSignatureSniff
RequireMultiLineTernaryOperatorSniff
⚙️RequireOneNamespaceInFileSniff
RequireShortTernaryOperatorSniff
RequireTrailingCommaInDeclarationSniff
ReturnTypeHintSpacingSniff
UselessConstantTypeHintSniff
UselessInheritDocCommentSniff
Symplify Coding Standard
Worksome
ConfigFilenameKebabCaseSniff
DisallowBladeOutsideOfResourcesDirectorySniff
DisallowCompactUsageSniff
DisallowEnvUsageSniff
DisallowHasFactorySniff
DisallowParamNoTypeOrCommentSniff
DisallowTodoCommentsSniff
EventListenerSuffixSniff
ExceptionSuffixSniff
PropertyDollarSignSniff
PascalCasingEnumCasesSniff
SpaceInGenericsFixer
Custom PHPStan rules
The Worksome code style includes the following custom PHPStan rules.
Generic
Rules that are applied to all projects.
DeclareStrictTypes
Identifier: worksome.declareStrictTypes
This rule is used to ensure that all PHP files include with the declare(strict_types=1)
statement.
DisallowPHPUnit
Identifier: worksome.disallowPhpunit
This rule prevents PHPUnit tests in favour of Pest PHP. It will allow abstract TestCase
classes.
NamespaceBasedSuffix
Identifier: worksome.namespaceBasedSuffix
Sets up configuration for suffixing the following namespaces
App\Events
:Event
App\Listener
:Listener
App\Policies
:Policy
App\Jobs
:Job
This makes sures events, listeners, policies and jobs has the same suffix.
Laravel
Rules that are only applied in a Laravel context.
DisallowEnvironmentCheckRule
Identifier: worksome.laravel.disallowEnvironmentCheck
This rule will prevent checking the application environment, instead preferring that a driver based approach is used.
DisallowPartialRouteFacadeResource
Identifier: worksome.laravel.disallowPartialRouteResource
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.
DisallowPartialRouteVariableResourceRule
Identifier: worksome.laravel.disallowPartialRouteResource
Similar to DisallowPartialRouteVariableResourceRule
, but prevents partial resource usage when used in a route group.
EnforceKebabCaseArtisanCommandsRule
Identifier: worksome.laravel.kebabCaseArtisanCommands
This rule will enforce the use of kebab-case for Artisan commands.
RequireWithoutTimestampsRule
Identifier: worksome.laravel.requireWithoutTimestamps
This rule enforces that all update
, insert
, save
, saveQuietly
, delete
, restore
, method calls within Laravel migration files are properly enclosed in a withoutTimestamps()
context.
Custom PHP_CodeSniffer sniffs
The Worksome code style includes various custom PHP_CodeSniffer sniffs where auto-fixers via PHP CS Fixer are not possible.
Generic
Pascal-casing enum cases
This ensures that all enum cases use pascal-casing (e.g. Case::PascalCase
).
Laravel
All custom sniffs specific to Laravel.
Config filename kebab case
Checks if all config files are written in kebab case.
Disallow compact
usage
Makes sure that compact()
isn't used in code.
Disallow env
usage
Makes sure that you don't use env
helper in your code, except for config files.
Disallow HasFactory
usage
Ensures that the HasFactory
trait is not used on models, this ensures that the factory class is called directly.
Event listener suffix
Enforces event listeners to end with a specific suffix, this suffix is defaulted to Listener
.
Disallow blade outside the resources
directory
Makes sure no .blade.php
files exist outside of Laravel's resources
directory.
Exception suffix
This ensures that all Exception
classes should have a suffix of Exception
.
PhpDoc
All custom sniffs which are not specific to Laravel.
Property dollar sign
Makes sure that you always have a dollar sign in your properties defined in phpdoc.
/** * @property string $name */ class User {}
Param tags with no type or comment
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.
Disallow TODO
comments
This ensures that all to-do comments are blocked from use. Jira should be used instead.
Space in generics
This ensures that generics types in PHPDoc comments contain a single space after the comma.
Custom Rector rules
The Worksome code style includes custom Rector rules for automatically refactoring code.
Generic
Disallowed Attributes
This ensures that specified PHP attributes are automatically removed when they are not allowed.
Credits
- Worksome
- Kuba Werłos for the initial code for
SpaceInGenericsFixer
- All Contributors