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

Composer: implement CS menu and extra commands #368

Merged
merged 1 commit into from
Dec 16, 2023
Merged

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Dec 16, 2023

Context

  • CI/Composer scripts improvement

Summary

This PR can be summarized in the following changelog entry:

  • CI/Composer scripts improvement

Relevant technical choices:

This adds a number of extra CS-related Composer scripts and handler functions.

This:

  • Uses the same menu as is already in use in the Free, Premium and several other plugins for predictability.
  • Where necessary, adjusts existing Composer scripts to, again, be in line with what is already in use in Free and Premium.

This also adds the ability to run CS with a Threshold. As the codebase is currently clean, this ability is not activated for CI for the time being, though it is likely that it will be activated once YoastCS 3.0 will be used.

Note: this change does mean that, in contrast to before, running check-cs will now return only errors. While this is new for this package, it is in line with the expected behaviour for the script as used in other packages.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Run composer check-cs-thresholds or any of the other new scripts to verify that things work as expected

This adds a number of extra CS-related Composer scripts and handler functions.

This:
* Uses the same menu as is already in use in the Free, Premium and several other plugins for predictability.
* Where necessary, adjusts existing Composer scripts to, again, be in line with what is already in use in Free and Premium.

This also adds the _ability_ to run CS with a Threshold. As the codebase is currently clean, this ability is not activated for CI for the time being, though it is likely that it will be activated once YoastCS 3.0 will be used.

Note: this change does mean that, in contrast to before, running `check-cs` will now return only errors.
While this is new for this package, it is in line with the expected behaviour for the script as used in other packages.
@jrfnl jrfnl added yoast cs/qa changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Dec 16, 2023
@jrfnl jrfnl added this to the 3.2 milestone Dec 16, 2023
@jrfnl jrfnl merged commit f120555 into develop Dec 16, 2023
16 checks passed
@jrfnl jrfnl deleted the JRF/add-cs-menu branch December 16, 2023 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog yoast cs/qa
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant