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.

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

[Issue] Set default PHP_CodeSniffer configuration #38122

Open
5 tasks done
m2-assistant bot opened this issue Oct 25, 2023 · 4 comments · May be fixed by #38115
Open
5 tasks done

[Issue] Set default PHP_CodeSniffer configuration #38122

m2-assistant bot opened this issue Oct 25, 2023 · 4 comments · May be fixed by #38115
Assignees
Labels
Area: Framework Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@m2-assistant
Copy link

m2-assistant bot commented Oct 25, 2023

This issue is automatically created based on existing pull request: #38115: Set default PHP_CodeSniffer configuration


Description

When running vendor/bin/phpcs (or vendor/bin/phpcbf) without any arguments, and error is shown. When running vendor/bin/phpcs on a specific file, the "wrong" standard is applied. This pull request sets the "correct" defaults for PHP_CodeSniffer so that both of these scenarios work as expected - ie, that they scan the expected files with the Magento2Framework standard.

See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file

Manual testing scenarios

  1. Run vendor/bin/phpcs without any arguments.
  2. Run vendor/bin/phpcs app/bootstrap.php
    • Compare with vendor/bin/phpcs --standard=Magento2Framework app/bootstrap.php

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)
@m2-assistant m2-assistant bot linked a pull request Oct 25, 2023 that will close this issue
6 tasks
@m2-community-project m2-community-project bot added Issue: ready for confirmation Priority: P2 A defect with this priority could have functionality issues which are not to expectations. labels Oct 25, 2023
@engcom-Bravo engcom-Bravo added the Reported on 2.4.x Indicates original Magento version for the Issue report. label Oct 25, 2023
@engcom-Bravo engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Oct 25, 2023
@engcom-Hotel engcom-Hotel self-assigned this Oct 25, 2023
@m2-assistant
Copy link
Author

m2-assistant bot commented Oct 25, 2023

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
  • 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
  • 4. Verify that the issue is reproducible on 2.4-develop branch
    Details- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
  • 5. Add label Issue: Confirmed once verification is complete.
  • 6. Make sure that automatic system confirms that report has been added to the backlog.

@engcom-Hotel
Copy link
Contributor

Hello @fredden,

Thanks for the report and collaboration!

We have tried to reproduce the issue in the Magento 2.4-develop instance and it seems the issue reproducible for us. Please have a look our findings on this issue:

  • While running vendor/bin/phpcs command, it shows the below error:
    image

  • In case running for specific file vendor/bin/phpcs app/bootstrap.php, it shows the below warnings and errors:
    image

  • And if we pass with --standard=Magento2Framework with the command vendor/bin/phpcs --standard=Magento2Framework app/bootstrap.php, it is not showing any error, that means while not passing any standard, it is not using Magento2Framework as a standard:

image

Hence confirming the issue.

Thanks

@engcom-Hotel engcom-Hotel added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework and removed Issue: ready for confirmation labels Oct 25, 2023
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-9842 is successfully created for this GitHub issue.

@m2-assistant
Copy link
Author

m2-assistant bot commented Oct 25, 2023

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: Pull Request In Progress
Development

Successfully merging a pull request may close this issue.

4 participants