Coding Standard Laravel Package
doctrine/coding-standard
Doctrine Coding Standard provides a shared PHP_CodeSniffer ruleset used across Doctrine projects. Based heavily on Slevomat, it helps enforce consistent formatting, naming, and best practices in PHP codebases via an easy-to-install package.
Release Notes for 14.0.0
Backwards incompatible release (major)
14.0.0
- Total issues resolved: 0
- Total pull requests resolved: 1
- Total contributors: 1
Dependencies
Release Notes for 13.0.1
13.0.x bugfix release (patch)
13.0.1
-
Total issues resolved: 0
-
Total pull requests resolved: 1
-
Total contributors: 1
-
339: fix: update rule for language construct spacing thanks to @simPod
Release Notes for 13.0.0
Backwards incompatible release (major)
13.0.0
-
Total issues resolved: 0
-
Total pull requests resolved: 2
-
Total contributors: 1
-
327: feat: enable SlevomatCodingStandard.TypeHints.ClassConstantTypeHint thanks to @simPod
BC break,Improvement,New sniff
Release Notes for 12.0.0
Backwards incompatible release (major)
12.0.0
- Total issues resolved: 0
- Total pull requests resolved: 4
- Total contributors: 2
New rule
- 311: Configure "SlevomatCodingStandard.Commenting.AnnotationName" rule thanks to @phansys
- 310: Disallow string property fetch thanks to @greg0ire
Dependencies
Improvement
Release Notes for 11.1.0
Feature release (minor)
11.1.0
- Total issues resolved: 0
- Total pull requests resolved: 2
- Total contributors: 2
Improvements
Release Notes for 11.0.0
Backwards incompatible release (major)
11.0.0
-
Total issues resolved: 0
-
Total pull requests resolved: 6
-
Total contributors: 2
-
304: String interpolation: don't suggest
sprintf()thanks to @derrabus -
295: feat: handle blank lines between class properties thanks to @simPod
BC break,CI,New rule
- 298: Add attribute sniffs thanks to @simPod
BC break,Improvement
- 294: refactor: replace RequireOneLinePropertyDocComment with RequireOneLineDocComment thanks to @simPod
BC break,Improvement,New rule
Release Notes for 10.0.0
Backwards incompatible release (major)
10.0.0
- Total issues resolved: 0
- Total pull requests resolved: 10
- Total contributors: 2
New rules
- 283: Require constructor property promotion thanks to @greg0ire
- 277: feat: run PropertyDeclaration on promoted properties thanks to @simPod
- 281: feat: require non-capturing catch thanks to @simPod
- 268: feat: add rules for trailing commas in function declarations thanks to @simPod
- 278: feat: add space CS for BackedEnums thanks to @simPod
- 270: feat: add rules for trailing commas in function calls and closure
usethanks to @simPod
Dependencies
- 264: chore: require slevomat/coding-standard v8 and squizlabs/php_codesniffer v3.7 thanks to @simPod
Internal
This release is the same as 9.0.0, in order to "cancel" 9.0.1, which had many breaking changes.
Release Notes for 9.0.1
9.0.x bugfix release (patch)
9.0.1
-
Total issues resolved: 0
-
Total pull requests resolved: 5
-
Total contributors: 1
-
269: fix: use tmp-patch file name thanks to @simPod
-
264: chore(deps): require slevomat/coding-standard v8 and squizlabs/php_codesniffer v3.7 thanks to @simPod
-
257: Add tests for PHP 8 thanks to @simPod
Release Notes for 9.0.0
9.0.0
-
Total issues resolved: 0
-
Total pull requests resolved: 1
-
Total contributors: 1
-
238: Add psalm-prefixed annotations to param and return group thanks to @simonberger
Release Notes for 8.2.1
8.2.x bugfix release (patch)
8.2.1
-
Total issues resolved: 0
-
Total pull requests resolved: 2
-
Total contributors: 2
-
237: Remove SlevomatCodingStandard.Classes.UnusedPrivateElements thanks to @morozov
documentation
- 234: fix docs link thanks to @sinacek
Release Notes for 6.0.1
Dependencies
Release Notes for 8.2.0
8.2.0
-
Total issues resolved: 0
-
Total pull requests resolved: 9
-
Total contributors: 6
-
226: Still works on PHP 7.1 thanks to @beberlei
-
220: Drop Travis thanks to @greg0ire
-
195: Makefile improvements thanks to @greg0ire
documentation
- 221: Move website config to default branch thanks to @SenseException
- 205: Update PSR-2 refs on docs to PSR-12 thanks to @gmponos
- 202: Trivial comment change from PSR2 to PSR12 thanks to @gmponos
Dependencies
CI,bug
- 210: Fix exit code handling thanks to @lcobucci
New rule
Release 8.1.0
8.1.0
-
Total issues resolved: 0
-
Total pull requests resolved: 1
-
Total contributors: 1
-
213: Composer: update PHPCS Composer plugin dependency thanks to @jrfnl
Release 8.0.0
This new major version includes rules that make this repository of standards fully compatible with PSR-12 and additional rules for PHP 7.4.
8.0.0
- Total issues resolved: 0
- Total pull requests resolved: 21
- Total contributors: 6
Improvement
-
194: Update tests expectations based on bugfix in dependencies thanks to @carusogabriel
-
176: Remove dead sniffs autoload thanks to @WyriHaximus
-
170: Improve diff while running
test-reportthanks to @carusogabriel -
169: Ensure that spacing around
casesare consistent thanks to @carusogabriel -
159: Normalize documentation comments thanks to @mathieu-bour
-
157: Improve diff while running
test-fixthanks to @carusogabriel -
151: Remove usless interface and trait comments thanks to @BackEndTea
-
192: Allow PHP 8 thanks to @greg0ire
-
147: Use stable version of PHP 7.4 in Travis CI thanks to @carusogabriel
New rule
- 175: Add rule to ensure Arrow Functions declaration format thanks to @carusogabriel
- 174: Add rule forbidding more than one constant declared per statement thanks to @carusogabriel
- 171: Introduce rule requiring Null Coalesce Equal Operator thanks to @carusogabriel
- 166: Ensure that Typed Properties are spaced correctly thanks to @carusogabriel
- 155: Use
SingleLineArrayWhitespaceto ensure single line arrays spacing thanks to @carusogabriel - 154: Use
NegationOperatorSpacingSniffto ensure no space before-thanks to @carusogabriel - 148: Adopt PSR-12 as base coding standard thanks to @carusogabriel
PSR-12
- 164: Adopt PSR-12 for imports statements separation thanks to @carusogabriel
- 163: Adopt PSR-12 for return types thanks to @carusogabriel
CI
Dependencies,Improvement
- 160: Introduce Dependabot thanks to @carusogabriel
CI,Improvement
Release 7.0.2
7.0.2
- Total issues resolved: 0
- Total pull requests resolved: 2
- Total contributors: 2
bug
- 146: Do not require space after case thanks to @simPod
bug,duplicate
Release 7.0.1
7.0.1
- Total issues resolved: 0
- Total pull requests resolved: 1
- Total contributors: 1
bug
- 146: Do not require space after case thanks to @simPod
Release 7.0.0
- Total issues resolved: 1
- Total pull requests resolved: 12
- Total contributors: 5
Improvement,release blocker
release blocker
Improvement
- 139: Crumble removed TypeHintDeclaration sniff thanks to @simPod
- 137: Require space after Block Control Structures thanks to @simPod
- 132: Update to PHPCS v3.5.x thanks to @carusogabriel
- 131: Drop psr12Compatible false, default is true thanks to @simPod
- 129: Add doctrine/phpcr-odm annotations support thanks to @Lctrs
- 121: Bump
composer.jsonmasterbranch-alias to7.0.x-devthanks to @Ocramius
New rule
- 136: Require space before throw, yield and yield from thanks to @simPod
- 128: Camel case vars thanks to @simPod
documentation
-
127: Drop PHP 7.1, add 7.4 to Travis thanks to @simPod
New sniff,RFC
This new major release brings in some new default rules:
- disallowed
Abstract,Trait,Exception,Interfaceprefixes along with suffixes - forbid multiple lines between declared functions
- disallow
/** class Foo */forclass Foocomments (some editors add it by default, and it is not useful) - disallow PHPStorm/IntelliJ default file header including author name
- forbid duplicate variable assignments, such as
$foo = $foo = bar() - enforce spacing between the type declaration and the variadic declaration of a function parameter:
function (int $foo) - forbid late static binding for constants:
$foo::BARis now a violation - require an empty line before a
returnstatement when not directly within a flow control construct - intersection and generic types support, thanks to Slevomat CS 5
Total issues resolved: 19
- 38: Forbid
Abstract,ExceptionandInterfaceprefixing too thanks to @greg0ire - 52: Exclude Squiz.Commenting.FunctionComment.ThrowsNotCapital sniff thanks to @deeky666
- 90: CI: Test against PHP 7.3 thanks to @Majkl578
- 94: Add test script to make it easier to run the tests thanks to @carusogabriel
- 95: Add sniff to forbid multiple lines between functions thanks to @carusogabriel
- 96: Link to Slack instead of Gitter thanks to @greg0ire
- 97: Disallow "Class <name>" as class comment thanks to @linaori
- 98: Remove IDEA/Phpstorm default file template properly thanks to @ostrolucky
- 99: Update to PHPCS 3.4 and use new Sniffs thanks to @carusogabriel
- 101: Use Ubuntu 16.04 thanks to @carusogabriel
- 104: Forbid duplicated variables assignments thanks to @carusogabriel
- 105: Add rule to force simplification of returns thanks to @carusogabriel
- 108: Make all annotations useful by default thanks to @Majkl578
- 109: Upgrade to Slevomat CS 5.0 thanks to @Majkl578
- 111: Enable SpreadOperatorSpacing sniff thanks to @Majkl578
- 112: Forbid LSB for constants thanks to @Majkl578
- 114: Forbid "Trait" suffix thanks to @Majkl578
- 115: Trigger CI failure when phpcbf cannot fix the file thanks to @ostrolucky
- 120: Require newline before return thanks to @ostrolucky
In this version we address the issue regarding formatting associative arrays and upgraded composer installer dependency.
- Total issues resolved: 0
- Total pull requests resolved: 3
- Total contributors: 3
Bug
- 103: Add failing test to reproduce bug with associative arrays thanks to @vladyslavstartsev
- 91: Fix annotation groups usage thanks to @lcobucci
Improvement
5.0.0
- Total pull requests resolved: 37
- Total contributors: 5
New sniff
- 39: Add ShortList sniff thanks to @carusogabriel
- 43: [RFC] Reference global classes via
usethanks to @deeky666 - 51: Enable UseSpacing sniff thanks to @Majkl578
- 59: Enable NamespaceSpacing sniff thanks to @Majkl578
- 65: Use new Generic.PHP.LowerCaseType Sniff thanks to @carusogabriel
- 68: UselessAliasSniff to report unnecessaries alias thanks to @carusogabriel
- 69: Add UselessSemicolon sniff thanks to @carusogabriel
- 70: Add UselessParentheses sniff thanks to @carusogabriel
- 71: Add Sniff for force null type hint to be on the last position on annotations thanks to @carusogabriel
- 72: Add Sniff to report useless variables thanks to @carusogabriel
- 73: Add Sniff to reported unused variables passed to closures thanks to @carusogabriel
- 76: Enable StaticClosure sniff thanks to @Majkl578
- 78: Enable ModernClassNameReference sniff thanks to @Majkl578
- 80: Enable TraitUseDeclarationSniff & TraitUseSpacingSniff thanks to @Majkl578
- 82: Enable UselessConstantTypeHintSniff thanks to @Majkl578
- 83: Add sniff to require assignment operators when possible thanks to @carusogabriel
- 88: phpDoc annotation spacing thanks to @Majkl578
- 89: Enable OptimizedFunctionsWithoutUnpacking sniff thanks to @Majkl578
Documentation
- 81: Update homepage thanks to @Majkl578
- 86: Document how to customize rules thanks to @Majkl578
Improvement
- 45: Remove constraint version thanks to @yourwebmaker
- 46: Forbidden usage of settype function thanks to @carusogabriel
- 48: Forbidden usage of extract thanks to @carusogabriel
- 49: Forbidden usage of compact thanks to @carusogabriel
- 50: Remove early return duplicated entry thanks to @carusogabriel
- 53: Use SemicolonSpacing Sniff thanks to @carusogabriel
- 54: Add Generic.Arrays.ArrayIndent sniff thanks to @deeky666
- 55: Use PHPCS XML schema definition thanks to @deeky666
- 61: Improve short list syntax rule description thanks to @carusogabriel
- 62: Update to PHCS 3.3 and Slevomat/CS 4.6.1 thanks to @carusogabriel
- 64: Remove duplicated ShortOpenTags thanks to @carusogabriel
- 66: Add some docs to the doctrine/coding-standard project. thanks to @jwage
- 74: Require reviews from code owners for CS changes thanks to @Majkl578
- 77: Bump patch versions of dependencies thanks to @carusogabriel
- 79: Add .doctrine-project.json to root of the project. thanks to @jwage
- 84: Use new PHPCS array syntax thanks to @carusogabriel
- 85: Validate ruleset against XML schema thanks to @Majkl578
Total issues resolved: 7
- 28: [RFC] Add more forbiddenAnnotations thanks to @carusogabriel
- 29: [RFC] Add SlevomatCodingStandard.PHP.TypeCast thanks to @carusogabriel
- 31: Add rules about exception types naming thanks to @greg0ire
- 32: Allow using doesNotPerformAssertions annotations thanks to @alcaeus
- 34: Enable EmptyComment sniff thanks to @Majkl578
- 35: Enable RequireOneLinePropertyDocComment sniff thanks to @Majkl578
- 36: Remove checkmark on unenforceable rule thanks to @greg0ire
This release introduces a few new additional checks that are enabled by default:
- Use the "Null Coalesce" (
??) operator where applicable - Enforce usage of parentheses together with the
newstatement - Enforce early return where applicable
- Forbid usage of core function aliases
Total issues resolved: 7
- 18: Propose semantic versioning of the library thanks to @Ocramius
- 19: Add Null Coalesce Operator thanks to @carusogabriel
- 20: New with parentheses thanks to @carusogabriel
- 22: Early return sniff thanks to @carusogabriel
- 23: ForbiddenFunctions: Add more basic blackisted aliases thanks to @Majkl578
- 24: Enable ForbiddenComments sniff thanks to @Majkl578
- 25: Whitelist
[@requires](https://github.com/requires)annotation thanks to @Majkl578
This release adds sniffs to import global functions and constants.
Total issues resolved: 3
Improvement
Version 2.0.0 incorporates many new sniffs for code safety, predictable behavior and consistent code look, Most notably:
- no more useless annotations that i.e. duplicate Git information,
- space after not operator (
!), - short arrays only,
- no assignments in conditions,
- alphabetically sorted
uses, - no long type names (
intvs.integer), - and more.
We're also moving towards PHP 7.1/7.2 standards and strict code. As part of this, we're now including checks for:
declare(strict_types=1)in every file,- native scalar types where possible,
- scalar hints in parameter and return types,
- defining the contents of iterable types in phpDoc,
- no redundant phpDoc annotations when types are expressed natively,
Changelog:
- Total issues resolved: 0
- Total pull requests resolved: 4
- Total contributors: 2
Improvement
- 12: Update README with newer rules thanks to @Majkl578
- 11: Add more new sniffs thanks to @Majkl578
- 10: Removing license header thanks to @mikeSimonson
- 9: Import advanced PHP 7.1 sniffs thanks to @Majkl578
This release makes this project compatible with PHPCS v3.0 and implements some missing sniffs (also making sure that we can apply automatic fixes with PHPCBF).
Total issues resolved: 1
First development release.
This is an intermediate release aimed at people relying on PHP_CodeSniffer 1.*. It is required in order for us to transition to PHP_CodeSniffer 2.* support.
How can I help you explore Laravel packages today?