feat: adds tutor config edit

[tecoholic]

Quickly launch the default YAML editor for editing the config.yml file.

Background

As a developer working with multiple projects, I am constantly changing the tutor config and re-running the tutor dev launch to update the devstack. While it is as simple as running vim $(tutor config printroot)/config.yml, I often found myself wanting to simply express this better using tutor config edit. So this is an attempt at cross-platform solution doing the same. It might not be the best solution, but something to start with if someone else finds this useful and improves their DevEx.

Caveat: I have only tested this on Linux (both open and xdg-open works in mine, so it could be said Unix).

[tecoholic]

@regisb Hi, Thanks for the review comments. I hoped to have addressed them by now. Somehow haven't found the time. I will handle the comments this week.

[kdmccormick]

I have nothing to add beyond Regis's review--just want to say that this is a great idea and thank you for the contribution 👍🏻

[kdmccormick]

Hi @tecoholic . I'm looking forward to this change! Looks like there are just a couple minor change requests left, and then we're good to merge this.

[tecoholic]

@kdmccormick Hi, thanks for the ping. I was waiting on @regisb for more details about read only editor. Can we skip that scenario for now?

[regisb]

@kdmccormick I am less interested in this feature than you seem to be -- mostly because (IMHO) it doesn't bring anything more than a .bashrc alias. E.g: alias tutor-config-edit='vim "$(tutor config printroot)/env.yml"'. So I'd rather defer to you for review.

[kdmccormick]

Thanks for the patience @tecoholic . If you can rebase and address these comments, I'll be happy to merge this.

[tecoholic]

@kdmccormick Thank you for your comments and your patience with this PR. I have addressed your comments to my best. Kindly take another look when you can.

[DawoudSheraz]

Please add a changelog entry for this change.

[kdmccormick]

I tested locally, works great on Ubuntu! I also commented out the which("open") block in order to confirm that xdg-open also works.

In addition to Dawoud's request to add a changelog entry, I have just one more change request and one optional suggestion ⬇️

[tecoholic]

@kdmccormick Thank you for the feedback. I added a changelog entry, new options -s and -e (explanation here), made the messages a bit more verbose. Kindly take a look.

[tecoholic]

@DawoudSheraz I have addressed your comments about the docs and updated the PR.

[tecoholic]

@kdmccormick Updated the PR with simpler version.

P.S: I left a reply to the comment in the review. But, it doesn't show up here. So, adding a note here, just in case.

[kdmccormick]

Just one issue, looks and works great otherwise. Thanks for proposing and working through this!

[kdmccormick]

Sorry @tecoholic , one last thing: could you change the PR's base to release and rebase? In order to get improvements out to the biggest set of users, the Tutor convention is to merge to release if there is nothing breaking, risky, or specific to Open edX's master branches.

[tecoholic]

@kdmccormick Hi, thanks for letting me correct the branch. I couldn't move all the commits and the history with it. So, I just squashed everything and based it on the release branch. I have applied the fix you pointed out as well.

[kdmccormick]

Thank you @tecoholic !