Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Beautified phpcs.xml #7041

Merged
merged 17 commits into from Dec 1, 2021
Merged

Beautified phpcs.xml #7041

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
732d738
Add a description.
Dec 1, 2021
1ab0f48
Move include section
Dec 1, 2021
cca1b0b
Move exclude section
Dec 1, 2021
164f061
Move generic ruleset
Dec 1, 2021
be2cb57
Move PSR2 ruleset
Dec 1, 2021
58291cf
Move Squiz ruleset
Dec 1, 2021
21796e2
Move SlevomatCodingStandard ruleset
Dec 1, 2021
5fc24f9
Combine file include/exclude section
Dec 1, 2021
3c00485
Add a URL
Dec 1, 2021
dee8203
Add some documentation
Dec 1, 2021
5210a1d
Unify endtag
Dec 1, 2021
d84617c
Add configuration section
Dec 1, 2021
d975f82
Rename ruleset to standard
Dec 1, 2021
dad2f08
Add more doc
Dec 1, 2021
064a07c
Add basepath for better readability
Dec 1, 2021
be50fc3
Remove test-case
Dec 1, 2021
d34f963
Uh, a colon too much
Dec 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
109 changes: 88 additions & 21 deletions phpcs.xml
View file
Open in desktop
Expand Up @@ -4,9 +4,78 @@
xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
name="Psalm coding standard"
>
<description>The coding standard for Psalm.</description>

<!-- **************************************************************************************************************
* Configuration *
************************************************************************************************************** -->

<config name="installed_paths" value="../../slevomat/coding-standard"/>
<rule ref="PSR2" />
<!-- Forbid usage of a function or a class constant via fallback global name -->

<arg name="basepath" value="."/>

<!-- **************************************************************************************************************
* Files to include/exclude *
************************************************************************************************************** -->

<file>bin/</file>
<file>src/</file>
<file>tests/</file>

<exclude-pattern>src/Psalm/Internal/Visitor/SimpleNameResolver.php</exclude-pattern>
<!-- These are just examples and stub classes/files, so it doesn't really matter if they're PSR-2 compliant. -->
<exclude-pattern>src/Psalm/Internal/Stubs/</exclude-pattern>
<exclude-pattern>tests/fixtures/</exclude-pattern>


<!-- **************************************************************************************************************
* STANDARD: Generic *
************************************************************************************************************** -->

<!--
Restrict line length.
https://github.com/squizlabs/PHP_CodeSniffer/blob/master/src/Standards/Generic/Docs/Files/LineLengthStandard.xml
-->
<rule ref="Generic.Files.LineLength">
<exclude-pattern>tests</exclude-pattern>
<exclude-pattern>src/Psalm/Internal/Type/TemplateStandinTypeReplacer.php</exclude-pattern>
</rule>


<!-- **************************************************************************************************************
* STANDARD: PSR2 *
************************************************************************************************************** -->

<rule ref="PSR2"/>

<!--
Namespace Declarations.
https://github.com/squizlabs/PHP_CodeSniffer/blob/master/src/Standards/PSR2/Docs/Namespaces/UseDeclarationStandard.xml
-->
<rule ref="PSR2.Namespaces.UseDeclaration">
<exclude-pattern>*</exclude-pattern>
</rule>


<!-- **************************************************************************************************************
* STANDARD: Squiz *
************************************************************************************************************** -->

<!--
The self keyword should be used instead of the current class name.
https://github.com/squizlabs/PHP_CodeSniffer/blob/master/src/Standards/Squiz/Docs/Classes/SelfMemberReferenceStandard.xml
-->
<rule ref="Squiz.Classes.SelfMemberReference"/>


<!-- **************************************************************************************************************
* STANDARD: SlevomatCodingStandard *
************************************************************************************************************** -->

<!--
Handle imports from namespaces.
https://github.com/slevomat/coding-standard#slevomatcodingstandardnamespacesreferenceusednamesonly-
-->
<rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly">
<properties>
<property name="allowFallbackGlobalConstants" value="false"/>
Expand All @@ -15,40 +84,38 @@
<property name="allowFullyQualifiedGlobalFunctions" value="true"/>
<property name="allowFullyQualifiedGlobalClasses" value="true"/>
</properties>
<exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.ReferenceViaFullyQualifiedName"/>
</rule>

<rule ref="Generic.Files.LineLength">
<exclude-pattern>tests</exclude-pattern>
<exclude-pattern>src/Psalm/Internal/Type/TemplateStandinTypeReplacer.php</exclude-pattern>
</rule>
<rule ref="PSR2.Namespaces.UseDeclaration">
<exclude-pattern>*</exclude-pattern>
<exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.ReferenceViaFullyQualifiedName"/>
</rule>

<!--
Looks for unused imports from other namespaces.
https://github.com/slevomat/coding-standard#slevomatcodingstandardnamespacesunuseduses-
-->
<rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
<properties>
<property name="searchAnnotations" value="true"/>
</properties>
</rule>

<!--
Checks whether uses at the top of a file are alphabetically sorted.
https://github.com/slevomat/coding-standard#slevomatcodingstandardnamespacesalphabeticallysorteduses-
-->
<rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
<properties>
<property name="caseSensitive" value="true" />
<property name="caseSensitive" value="true"/>
</properties>
</rule>

<!--
Enforces configurable number of lines before/after/between use.
https://github.com/slevomat/coding-standard#slevomatcodingstandardnamespacesusespacing-
-->
<rule ref="SlevomatCodingStandard.Namespaces.UseSpacing">
<properties>
<property name="linesCountBetweenUseTypes" value="1" />
<property name="linesCountBetweenUseTypes" value="1"/>
</properties>
</rule>
<rule ref="Squiz.Classes.SelfMemberReference" />
<file>bin/</file>
<file>src/</file>
<file>tests/</file>

<exclude-pattern>src/Psalm/Internal/Visitor/SimpleNameResolver.php</exclude-pattern>

<!-- These are just examples and stub classes/files, so it doesn't really matter if they're PSR-2 compliant. -->
<exclude-pattern>src/Psalm/Internal/Stubs/</exclude-pattern>
<exclude-pattern>tests/fixtures/</exclude-pattern>
</ruleset>