Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[CS] Enforces null type hint on last position in phpDocs #28675

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.

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

Merged
merged 1 commit into from
Oct 2, 2018
Merged

[CS] Enforces null type hint on last position in phpDocs #28675

merged 1 commit into from
Oct 2, 2018

Conversation

carusogabriel
Copy link
Contributor

Q A
Branch? 2.8
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets -
License MIT
Doc PR -

As a majority in our codebase, the null typehint usually comes in the last position in phpDocs.

Copy link
Contributor

@ro0NL ro0NL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can/does php-cs-fixer cover it?

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this is rejected because of the "merge conflicts" ... but I wish this is merged because it's great for consistency. Thanks Gabriel.

@nicolas-grekas nicolas-grekas added this to the 2.8 milestone Oct 2, 2018
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(would be great to have php-cs-fixer do it for us)

@nicolas-grekas
Copy link
Member

Thank you @carusogabriel.

@nicolas-grekas nicolas-grekas merged commit efbba25 into symfony:2.8 Oct 2, 2018
nicolas-grekas added a commit that referenced this pull request Oct 2, 2018
… (carusogabriel)

This PR was merged into the 2.8 branch.

Discussion
----------

[CS] Enforces null type hint on last position in phpDocs

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | no
| New feature?  | no <!-- don't forget to update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | -   <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | - <!-- required for new features -->

As a majority in our codebase, the `null` typehint usually comes in the last position in phpDocs.

Commits
-------

efbba25 [CS] Enforces null type hint on last position in phpDocs
@carusogabriel carusogabriel deleted the null-type-hint branch October 2, 2018 12:08
@TomasVotruba
Copy link
Contributor

@ro0NL No need to. NullTypeHintOnLastPositionSniff can

services:
    SlevomatCodingStandard\Sniffs\TypeHints\NullTypeHintOnLastPositionSniff: ~
vendor/bin/ecs check src/Symfony --fix

@jvasseur
Copy link
Contributor

jvasseur commented Oct 7, 2018

php-cs-fixer can do it with the phpdoc_types_order fixer.

@carusogabriel
Copy link
Contributor Author

@jvasseur Thanks for that. Gonna open a PR adding that to all current active branches.

fabpot added a commit that referenced this pull request Oct 11, 2018
This PR was merged into the 2.8 branch.

Discussion
----------

[CS] Enable phpdoc_types_order

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | no
| New feature?  | no <!-- don't forget to update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- don't forget to update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | -   <!-- #-prefixed issue number(s), if any -->
| License       | MIT
| Doc PR        | -

As suggested by @jvasseur in #28675 (comment), we can use the `phpdoc_types_order` rule from PHP-CS-Fixer to ensure that `null` is always on the last position in phpDocs as proposed in #28675.

Commits
-------

c340502 [CS] Enable phpdoc_types_order
SpacePossum added a commit to PHP-CS-Fixer/PHP-CS-Fixer that referenced this pull request Oct 18, 2018
…abriel)

This PR was merged into the 2.14-dev branch.

Discussion
----------

Add phpdoc_types_order rule to Symfony's ruleset

As suggested by @julienfalque in symfony/symfony#28780, besides add this new rule due to symfony/symfony#28675, we should also enforces it in Symfony's ruleset here too 😊

Commits
-------

c2ccec2 Add phpdoc_types_order rule to Symfony's ruleset
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.