Code Sniffer Laravel Package

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.33...0.17.34

Improvements

• Fixed CommentingTrait::hasInheritDoc() so now it recognizes the inline {[@inheritDoc](https://github.com/inheritDoc)} form as doc-block inheritance.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.32...0.17.33

Improvements

• Fixed CommentingTrait::hasInheritDoc() so now it recognizes the inline {[@inheritDoc](https://github.com/inheritDoc)} form as doc-block inheritance.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.30...0.17.31

Improvements

• Added phpstan/phpstan new ^2.* module version support.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.29...0.17.30

Improvements

• Added PHP 8.4 support.

Checklist

• I agree with the Code Contribution License Agreement in CONTRIBUTING.md

Fixes

• Fixed usage of deprecated Sniffer rules. by @stereomon in https://github.com/spryker/code-sniffer/pull/383
• Fixed doc block default value matching by @tsybenko in https://github.com/spryker/code-sniffer/pull/385

New Contributors

• @tsybenko made their first contribution in https://github.com/spryker/code-sniffer/pull/385

Full Changelog: https://github.com/spryker/code-sniffer/compare/0.17.28...0.17.29

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.27...0.17.28

Fixes

• Temporary locked the usage version for phpstan/phpdoc-parser used in the tool.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.26...0.17.27

Improvements

• Enabled the usage of null safe object operators.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.25...0.17.26

Improvements

• Added SprykerFeature module types to supported namespaces.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.24...0.17.25

Improvements

• Added PHP 8.3 support.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.23...0.17.24

Fixes

• Adjusted DocBlockApiAnnotationSniff to fix the false negative errors when declaring the Specification annotation.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.22...0.17.23

Fixes

• Adjusted QueryContainerMethodAnnotationSniff to remove deprecated getQueryContainer() annotation validation.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.21...0.17.22

Fixes

• Adjusted configuration so it supports Constructor Property Promotion.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.20...0.17.21

Fixes

• Adjusted rules Spryker/ruleset.xml to fix false negative error.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.19...0.17.20

Fixes

• Adjusted SprykerStrict/ruleset.xml to fix ERROR: Ruleset invalid. Property "enableNeverTypeHint" does not exist on sniff SprykerStrict.TypeHints.ParameterTypeHint error.

Included commits: https://github.com/spryker/code-sniffer/compare/0.17.18...0.17.19

Improvements

• Added PHP 8.2 support.
• Allow Spryker.Namespaces.SprykerNamespace to be used in a more generic context.
• Any custom repository using PSR-4 namespacing can now also be used with this to check the namespace vs file name.

    <rule ref="Spryker.Namespaces.SprykerNamespace">
        <properties>
            <property name="namespace" value="App"/>
            <property name="isRoot" value="true"/>
        </properties>
    </rule>

It would then validate your class files within src/:

• file name src/Some/Sub/MyClass.php would then have to match FQCN App\\Some\\Sub\\MyClass inside

Note: If not further specific, it will still only check Spryker core files here for now and skip all other class files.

Fixes

Fix up DocBlockParamAllowDefaultValueSniff to not error on nullable annotation for mixed type.

Fixes

The previous fix didn't fix all issues around the PHP anti-pattern of mixed type including null. Now DocBlockReturnNullableTypeSniff does not prematurely add null for a mixed return type annotation, as well.

Fixes

DocBlockReturnNullableTypeSniff does not falsely remove null for a mixed return type annotation.

Fixes

• Fixed up 7.4+ safety rules. They can always be muted for PHP 8.0+ repositories. E.g. for a PHP 8.0 project, set this to allow ?-> and have improved diff output for changes now:

    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse"/>

    <rule ref="SlevomatCodingStandard.ControlStructures.DisallowNullSafeObjectOperator">
        <severity>0</severity>
    </rule>
    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration">
        <severity>0</severity>
    </rule>
    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse">
        <severity>0</severity>
    </rule>

Fixes

Fixed false positive on usage of list<\Type>

Improvements

Now PHP 7.4+ and tested on PHP 8.2.

Fixes

Fixed sniffs around param type parsing and errors with new PHPStan versions.

Fixes

The else if to elseif sniff and fixer so far was always just a warning, which usually didn't show the issue. This has been fixed with a Spryker sniff that now enforces this on an error level. It will auto-fix itself for code that doesn't yet follow the coding guidelines.

Improvements

Projects as well as libraries can now enable strict_types for PHP files.

    <rule ref="Spryker.PHP.DeclareStrictTypesAfterFileDoc">
        <properties>
            <property name="strictTypesMandatory" value="true"/>
        </properties>
    </rule>

Please note: This can have side effects as type casting is now not happening anymore in some cases.

Also: declare(strict_types=1); is now consistently placed within a PHP file, after the file doc block as per PSR-12 specification.

Fixes

• Allow class-string to pass as string type in docblocks, including class-string<\Some\Class\Name>.

Improvements

• Added SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse sniff

Fixes

Fixed DocBlockVar sniff to handle and allow list<type> documentation for array collections.

Fixes

Adjusted the SprykerStrict sniffers as per our minimum PHP version to ensure that no accidents happen in regards to signature changes that are not PHP version compatible.

Improvements

Allow for new slevomat/coding-standard 8.x. This is to allow for all new fixes of that series to be used by everyone.

Please note You need to add the php_version config in your root phpcs.xml file before upgrading.

E.g. if you are using >= 7.4 in composer as PHP min requirement:

<config name="php_version" value="70400"/>

The reason is that it would otherwise execute your local PHP version (e.g. 8.1) and modify the code according to "too new language features".

What's Changed

• Fix DisallowArrayTypeHintSyntaxSniff by @szepeviktor in https://github.com/spryker/code-sniffer/pull/332
• Change namespace of tests to Spryker\Test by @szepeviktor in https://github.com/spryker/code-sniffer/pull/342
• Fix order of CI steps by @szepeviktor in https://github.com/spryker/code-sniffer/pull/343
• Check XML files against schema by @szepeviktor in https://github.com/spryker/code-sniffer/pull/331
• Remove Composer tool installation related code by @szepeviktor in https://github.com/spryker/code-sniffer/pull/347
• Improve bootstrap.php by @szepeviktor in https://github.com/spryker/code-sniffer/pull/348
• Enhancement: Allow installation of slevomat/coding-standard:^8.0.1 by @localheinz in https://github.com/spryker/code-sniffer/pull/345
• Fix: Sort packages by @localheinz in https://github.com/spryker/code-sniffer/pull/346

New Contributors

• @szepeviktor made their first contribution in https://github.com/spryker/code-sniffer/pull/332
• @localheinz made their first contribution in https://github.com/spryker/code-sniffer/pull/345

Full Changelog: https://github.com/spryker/code-sniffer/compare/0.17.7...0.17.8

Fixes

• Fixed fatal error for class exists checks
• Fixed newline issue for file docblock
• Fixed FQCN to use statements for properties

Fixes

• Fixed missing newline separation for class constants.
• Fixed method annotation sniff when using final classes - thanks to @alfredbez.

Improvements

• Full generics support for all object collections.
• Improved method annotation sniff - thanks to @alfredbez

For generics please make sure:

• To have updated all non-generic docblocks first. \SomeObject|some-type[] that is actually a true "object or array" case must be noted as \SomeObject|array<some-type>. If you do not do this before this update, it will change it as per expectation regarding legacy syntax.
• You update your PHPStan files to either include checkGenericClassInNonGenericObjectType: false or to adjust your docblocks to specify the type of generic class/object.

For project annotations:

• If you have a custom namespace and do not use the default and recommended Pyz namespace, you need to add a few configs to let the sniffer know about this and make the correct class usage assessment: https://github.com/spryker/code-sniffer#configure-custom-namespaces

Fixes

• Fix throw annotation sniff regarding static calls.
• Fix UseStatement sniff to not false positive on method attributes at start of the class or interface.
• Add Countable into sorting of TypeHintSniff.

Fixes

• Fixed DocBlockThrows sniff to make sure FQCN adds no extra leading backslash.
• Fixed DocBlockReturnTag sniff for more complex generics.

Improvements

Added Spryker.PHP.DisallowTrailingCommaInSingleLine to avoid side effects with other sniffs.

Added Spryker.ControlStructures.DisallowCloakingCheck to remove unnecessary anti-pattern of cloaking (silencing of non-existence), regarding variables and properties. This is also in sync with stricter 8.2+ in the future, but already now can spot a few typos and no-ops.

Make sure to always declare local variables or class properties before using. Using isset()/empty() is only useful when the key of an array is possibly undefined. This is never the case on local variables or normal class properties. It has a strict mode (default off) which would also disallow some edge cases and silencing for dynamic property access.

We don't want to go quite as far as this article and say never, but there are some use cases where more appropriate solutions are possible:

$x = !empty($this->property) !== false;
// should be
$x = (bool)$this->property;
 
if (isset($this->property)) {}
// should be
if ($this->property !== null) {}
 
if (empty($myTransfer->getFoo()) {}
// should be
if (!$myTransfer->getFoo()) {}

For further reference see guidelines.

Fixes

Fixed InlineDocBlock sniff to handle annotations with a comments above.

Fixes

• Removed silencing of method signature whitespace issues, especially around multiline signatures. They can be auto-fixed now.
• Fixed [@throws](https://github.com/throws) annotation fixing using full FQCN string.