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

Set default PHP_CodeSniffer configuration #38115

Open
wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

fredden
Copy link
Member

@fredden fredden commented Oct 24, 2023

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)

Resolved issues:

  1. resolves [Issue] Set default PHP_CodeSniffer configuration #38122: Set default PHP_CodeSniffer configuration

@m2-assistant
Copy link

m2-assistant bot commented Oct 24, 2023

Hi @fredden. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:
  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@m2-github-services m2-github-services added Partner: Youwe partners-contribution Pull Request is created by Magento Partner labels Oct 24, 2023
@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@engcom-Bravo
Copy link
Contributor

@magento create issue

@engcom-Bravo engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 25, 2023
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@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 Jul 15, 2024
@engcom-November engcom-November self-assigned this Sep 19, 2024
@engcom-Dash engcom-Dash self-assigned this Sep 19, 2024
@engcom-November
Copy link
Contributor

Hello @fredden,

Thanks for the collaboration & contribution!

✔️ QA Passed

Steps to reproduce:

  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

Before: ✖️ 

Both commends gave different outputs.
image
image

After: ✔️

Both commends gave same outputs.
image
image

Thank you.

@engcom-November
Copy link
Contributor

@magento run all tests

@engcom-November
Copy link
Contributor

Since builds are failed moving this to Extended testing.

@engcom-November
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests EE

@engcom-November
Copy link
Contributor

There are no repeating failures in Functional tests B2B.

Functional Tests B2B:
Run 1:
image

Run 2:
image

Hence moving this to Merge in progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Partner: Youwe partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: Merge in Progress
Development

Successfully merging this pull request may close these issues.

[Issue] Set default PHP_CodeSniffer configuration
6 participants