Skip to content

feat(PSR12.Operators.OperatorSpacing): Add documentation for perCompatible setting #86

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

Open
klausi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(PSR12.Operators.OperatorSpacing): Add documentation for perCompatible setting #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion wiki/Customisable-Sniff-Properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,15 +1093,43 @@ This sniff checks the depth of imported namespaces inside compound use statement
</rule>
```

<p align="right"><a href="#table-of-contents">back to top</a></p>
### PSR12.Operators.OperatorSpacing

| Property Name | Type | Default | Available Since |
| ------------- | ------ | ------- | --------------- |
| perCompatible | string | 1.0 | 4.0.2 |

This sniff checks the spacing around operators. By default, this sniff is compatible with [PER Coding Style](https://www.php-fig.org/per/coding-style/) 1.0. The setting `perCompatible` can be set to 3.0 or higher to get different behaviour for spacing around multi-catch `|` operators.

```xml
<rule ref="PSR12.Operators.OperatorSpacing">
<properties>
<property name="perCompatible" value="3.0" />
</properties>
</rule>
```

Valid: no spaces around the '|' operator in a multi-catch with 'perCompatible=3.0' (or higher):
```php
try {
} catch (Exception|RuntimeException $e) {
}
```
Invalid: spaces around the '|' operator in a multi-catch with 'perCompatible=3.0' (or higher).
```php
try {
} catch (Exception | RuntimeException $e) {
}
```

<!--
While PSR12.Operators.OperatorSpacing inherits the `ignoreNewlines` and `ignoreSpacingBeforeAssignments` properties
from the `Squiz.WhiteSpace.OperatorSpacing` sniff, these properties are not handled in the PSR12 sniff,
so are deliberately not mentioned in this documentation.
-->

<p align="right"><a href="#table-of-contents">back to top</a></p>


## Squiz Sniffs

Expand Down