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

[New Rule] Implement sniff for class properties PHPDoc formatting #58

Closed
lenaorobei opened this issue Mar 8, 2019 · 6 comments · Fixed by #140
Closed

[New Rule] Implement sniff for class properties PHPDoc formatting #58

lenaorobei opened this issue Mar 8, 2019 · 6 comments · Fixed by #140
Assignees
@konarshankar07
Labels
accepted New rule is accepted new rule New feature implementation Progress: done

Comments

@lenaorobei
Copy link
Contributor

lenaorobei commented Mar 8, 2019 •
edited
Loading

Rule

PHPDoc formatting for class properties.

Acceptance Criteria:

Class attributes must have type declaration using @var tag.

  • Rule covered by unit test.
<severity>5</severity>
<type>warning</type>
@lenaorobei lenaorobei added enhancement Improvements to existing rules accepted New rule is accepted Progress: good first issue Issues is easy to get started with labels Mar 8, 2019
@lenaorobei lenaorobei changed the title [New Rule] Implement sniff for variable doc comment formatting [New Rule] Implement sniff for variable PHPDoc formatting Mar 8, 2019
This was referenced Mar 13, 2019
Merged
Closed
Closed
@lenaorobei lenaorobei mentioned this issue Apr 15, 2019
Merged
4 tasks
@lenaorobei lenaorobei added new rule New feature implementation and removed enhancement Improvements to existing rules labels May 31, 2019
@lenaorobei lenaorobei mentioned this issue May 31, 2019
Merged
@lenaorobei lenaorobei changed the title [New Rule] Implement sniff for variable PHPDoc formatting [New Rule] Implement sniff for class properties PHPDoc formatting May 31, 2019
@lenaorobei
Copy link
Contributor Author

Hi @ryantfowler! How is your progress with this ticket? Do you need any help?

@ryantfowler
Copy link
Contributor

Hi @lenaorobei , I should have an update by this weekend. I've been tied up with work. Thanks

@lenaorobei
Copy link
Contributor Author

@ryantfowler sorry, unassigning you from this issue since no updates.
Feel free to assign yourself again if you want to continue working on this task. Thanks.

@konarshankar07 konarshankar07 self-assigned this Sep 4, 2019
@konarshankar07
Copy link
Contributor

Hello @lenaorobei ,
Can we just add Squiz.Commenting.VariableCommentSniff in our ruleset?

@lenaorobei
Copy link
Contributor Author

@konarshankar07 need to check if it complies with DevDocs. I checked long time ago, and there was differences. But anyway, it can be taken as a good basis.

@konarshankar07
Copy link
Contributor

@lenaorobei no problem, I'll create new rule for class properties

@konarshankar07 konarshankar07 mentioned this issue Sep 9, 2019
Merged
magento-devops-reposync-svc pushed a commit that referenced this issue Sep 7, 2021
@svera
Merge pull request #55 from magento-commerce/imported-magento-magento…
3bd8317 
…-coding-standard-140

[Imported] #58 : Implement sniff for class properties PHPDoc formatting
magento-devops-reposync-svc pushed a commit that referenced this issue Sep 8, 2021
@jcuerdo
Merge pull request #58 from magento-commerce/imported-magento-magento…
e3f4d87 
…-coding-standard-261

[Imported] AC-667: Create phpcs static check for EmailTemplateTest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@konarshankar07 konarshankar07

Labels
accepted New rule is accepted new rule New feature implementation Progress: done
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#58 : Implement sniff for class properties PHPDoc formatting konarshankar07/magento-coding-standard
3 participants
@ryantfowler @lenaorobei @konarshankar07