Skip to content

feat: Add exclusion rules for the Magento2 coding standards #62

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

Merged
leonhelmus merged 4 commits into from
Dec 24, 2025
Merged

feat: Add exclusion rules for the Magento2 coding standards #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df9e6a1
feat: Add exclusion rules for the Magento2 coding standards
l-helmus-youwe Dec 24, 2025
edb1af2
fix: allow grumphp to run git in all directories
l-helmus-youwe Dec 24, 2025
7aab843
fix: prevent error by not installing specific version of package
l-helmus-youwe Dec 24, 2025
50177dd
refactor: Add changelog about phpcs rules changed
l-helmus-youwe Dec 24, 2025
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
1 change: 1 addition & 0 deletions .github/workflows/testing-suite.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:

- name: Install Dependencies
run: |
git config --global --add safe.directory "*"
composer2 install --dev --prefer-dist --no-scripts --no-progress --optimize-autoloader --no-interaction -vvv
composer2 show
shell: bash
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Commit Message validator to validate the commit message adheres to the
[Conventional Commit Message structure](https://cheatography.com/albelop/cheat-sheets/conventional-commits/)
and that the commit message contains a Jira ticket number it relates to.
- Prevent installation of `phpro/grumphp-shim:2.18.0` to prevent error "symfony/cache" conflicts with extension `redis`
, see [github link](https://github.com/phpro/grumphp-shim/issues/30)

### Changed
- [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`
Expand Down Expand Up @@ -52,6 +54,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Default Pimcore coding standards disables PHPCS in favour of PHP CS Fixer.
- JSON Lint will ignore folders `.ddev/` and `tests/fixtures/`.
- Added Symfony function `dump()` to the git blacklist for all project types
- Added new excludes to magento 2 phpcs rules.

### Removed
- Removed support for EOL PHP versions. Projects running PHP < 8.1 can stick to version 2 of the testing-suite.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"php-cs-fixer/shim": "@stable",
"php-parallel-lint/php-parallel-lint": "^1.4",
"phpmd/phpmd": "^2.15 || 3.x-dev",
"phpro/grumphp-shim": "^2.15",
"phpro/grumphp-shim": "^2.15 !=2.18.0",
"phpstan/phpstan": "@stable",
"squizlabs/php_codesniffer": "^3.12.0",
"youwe/composer-dependency-installer": "^2.0",
Expand Down
14 changes: 12 additions & 2 deletions config/magento2/ruleset.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,15 @@
<!-- Use default Youwe coding standards for PHP projects. -->
<rule ref="../default" />
<!-- Magento coding standards -->
<rule ref="Magento2" />
</ruleset>
<rule ref="Magento2" >
<!-- Not all functions require doc blocks -->
<exclude name="Magento2.Annotation.MethodAnnotationStructure.NoCommentBlock"/>
<!-- Not all class properties require doc blocks -->
<exclude name="Magento2.Commenting.ClassPropertyPHPDocFormatting.Missing"/>
<!--
This conflicts with PSR12.ControlStructures.ControlStructureSpacing.FirstExpressionLine
Which is used when a line is too long.
-->
<exclude name="PSR2.ControlStructures.ControlStructureSpacing.SpacingAfterOpenBrace"/>
</rule>
</ruleset>