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

feat: add toggle arg to xdebug command, fixes #3593 #5625

Merged

Conversation

GuySartorelli
Copy link
Collaborator

The Issue

How This PR Solves The Issue

Adds new "toggle" argument to the xdebug command

Manual Testing Instructions

  1. Run ddev xdebug toggle - see it enable xdebug
  2. Run ddev xdebug toggle - see it disable xdebug

Optionally run ddev xdebug status inbetween to see that the status has actually changed.

Automated Testing Overview

Added tests to validate that ddev xdebug toggle outputs the correct text to indicate the new status, and that running ddev xdebug status afterwards reports that the status was in fact toggled.

I'm not sure how to run tests locally so just wrote them blind and hoping they pass - but they're based on existing tests and it seems pretty straight forward so should be fine.

Related Issue Link(s)

#3593

Release/Deployment Notes

I don't think this has any other ramifications.

Other notes

I wanted to also change the default for ddev xdebug to be a shortcut for ddev xdebug toggle (it's currently a shortcut for ddev xdebug on) - but I figure that's probably a breaking change so if that does get done it should probably be done in a separate PR.

@GuySartorelli GuySartorelli requested review from a team as code owners December 13, 2023 08:32
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file already has a mix of tabs and spaces for indentation so I'm really not sure what the indentation should be - and there's no guidance on that (at least that I could find) in https://ddev.readthedocs.io/en/stable/developers/building-contributing/#coding-style

Let me know if you want something specific to be done with the indents in this file.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use spaces. You can add [skip ci] to the commit message to avoid running all the tests.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to make a commit here (will do a release soon, and want to merge it right now).

Copy link

Copy link
Member

@stasadev stasadev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GuySartorelli, thank you!

It looks like you've made all the necessary changes in all the necessary places.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use spaces. You can add [skip ci] to the commit message to avoid running all the tests.

@stasadev stasadev merged commit 21f0dfc into ddev:master Dec 13, 2023
9 checks passed
@GuySartorelli GuySartorelli deleted the 20231213_GuySartorelli_xdebug-toggle branch December 13, 2023 19:42
@GuySartorelli
Copy link
Collaborator Author

Awesome, thank you for the quick turn around! 💙

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants