feat: adds `tutor config edit` #1099

tecoholic · 2024-07-24T06:58:40Z

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).

regisb · 2024-07-30T07:20:51Z

tutor/commands/config.py

+@click.command(name="edit", help="Edit config.yml of the current environment")
+@click.pass_obj
+def edit(context: Context) -> None:
+    config_file = os.path.join(context.root, "config.yml")


Use config.config_path(context.root) instead.

regisb · 2024-07-30T07:22:06Z

tutor/commands/config.py

+    elif which("start"):  # Windows
+        open_cmd = ["start", '""', config_file]
+    else:
+        click.echo(


This command should fail if neither open commands are available. You could for instance raise exceptions.TutorError.

regisb · 2024-07-30T07:24:14Z

tutor/commands/config.py

+
+    open_cmd = None
+
+    if which("open"):  # MacOS


Let's amend the comment. open is also available on Ubuntu, for instance.

I have another, more important problem with this command. According to my testing, when I run open file.txt on a headless server (for instance: a remote production server), it opens a read-only editor. How can we fix this command to open a write-capable editor? (xdg-open is not available on servers without a Desktop) Note that $EDITOR is set to "vim" on this server.

@regisb I wanted to test this scenario to evaluate the options. However, the server image I used (ubuntu based) didn't have a open at all. And my desktop with Ubuntu seems to just ship xdg-open as open.

❯ which open /usr/bin/open ❯ open --version xdg-open 1.1.3

when I run open file.txt on a headless server (for instance: a remote production server), it opens a read-only editor.

Which version of open is this, and what's the editor that it opens?

On the topic of a "writable editor", MacOS's open implements -a flag, which allows specifying the application to open the file. I am wondering if something similar can be added to this command, that can force a specific editor to be launched. tutor config edit -a vim maybe? What do think about this?

I think this can be a good option, this gives control to the user. For instance, if someone wants to open the file in Sublime/VScode, they can override the default utils the command is checking.

regisb · 2024-07-30T07:30:37Z

tutor/commands/config.py

+        open_cmd = ["start", '""', config_file]
+    else:
+        click.echo(
+            "Cannot find a way to open the editor automatically. Kindly open the file manually: "


Let's rephrase that along the lines of: "Failed to detect an adequate text file editor". (mode concise, no need for "kindly")

tutor/commands/config.py

tecoholic · 2024-08-07T11:32:44Z

@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 · 2024-08-09T17:15:15Z

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 👍🏻

DawoudSheraz · 2024-08-20T07:39:33Z

tutor/commands/config.py

+    elif which("start"):  # Windows
+        open_cmd = ["start", '""', config_file]
+    else:
+        raise exceptions.TutorError(f"Failed to find utility to launch an editor.")


In the error message, we can specify which utilities are used by the command internally so that user can install them on the system if needed (not all the users of Tutor are dev, some are operators who might not want to delve into code to see what is happening under the hood).

After some research, it seems to me that Windows will always have start, macOS will always have open, and Linux desktop environments will always have xdg-open. That leaves only non-desktop Linux users and perhaps BSD users. I think those users will know their systems better then we will, and they will be capable of figuring out how to open a yaml file as long as we tell them where it is 😄 @tecoholic , rather than letting them know what to install, could you just enhance this error message a bit just to let users know that they can edit configuration at {config_file}?

kdmccormick · 2024-09-23T14:02:02Z

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 · 2024-09-23T21:19:09Z

@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 · 2024-09-24T07:27:03Z

@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.

tutor/commands/config.py

kdmccormick · 2024-10-24T16:45:26Z

tutor/commands/config.py

+    elif which("start"):  # Windows
+        open_cmd = ["start", '""', config_file]
+    else:
+        raise exceptions.TutorError(f"Failed to find utility to launch an editor.")


After some research, it seems to me that Windows will always have start, macOS will always have open, and Linux desktop environments will always have xdg-open. That leaves only non-desktop Linux users and perhaps BSD users. I think those users will know their systems better then we will, and they will be capable of figuring out how to open a yaml file as long as we tell them where it is 😄 @tecoholic , rather than letting them know what to install, could you just enhance this error message a bit just to let users know that they can edit configuration at {config_file}?

tutor/commands/config.py

tecoholic · 2024-11-10T05:35:43Z

@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 ⬇️

kdmccormick · 2024-11-12T15:09:38Z

tutor/commands/config.py

@@ -255,9 +259,41 @@ def patches_show(context: Context, name: str) -> None:
        print(rendered)


+@click.command(name="edit", help="Edit config.yml of the current environment")


Optional: What do you think about adding a -s/--save flag here? If supplied, then instead of reminding the user to run tutor config save, it would just save config automatically.

This was something I thought of adding later based on user feedback. Now that you have pointed it out, I have taken it as the feeback and added 2 features I think are QOL improvments.

-s automatically updating the environment after a successful save. The caveat here is "successful save". More on them below.

-e to specify an editor of choice. The annoying thing about desktop systems is, installing new software somehow messes up file associations. I discovered after installing KDE that my YAML files now open in Kate Editor. Now I do tutor config edit -e (vim|emacs|..) to open the file in a specific editor.

Save caveats:

Sometimes, when I do :wq in Neovim (Lazyvim config), it returns a non-zero error code. This prevents the "save" from happening.

When the file gets opened in a GUI editor like Kate, it opens it as an independent process, instead of subprocess. So the utils.execute() returns as soon as the editor is launched instead of return after the editor is closed. So, the environment is updated with config before editing.

tutor/commands/config.py

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

Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>

tecoholic · 2024-11-14T02:45:56Z

@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.

DawoudSheraz · 2024-11-22T07:27:02Z

changelog.d/20241114_115534_arunmozhi_add_config_edit_command.md

+<!--
+Create a changelog entry for every new user-facing change. Please respect the following instructions:
+- Indicate breaking changes by prepending an explosion 💥 character.
+- Prefix your changes with either [Bugfix], [Improvement], [Feature], [Security], [Deprecation].
+- You may optionally append "(by @<author>)" at the end of the line, where "<author>" is either one (just one)
+  of your GitHub username, real name or affiliated organization. These affiliations will be displayed in
+  the release notes for every release.
+-->
+
+<!-- - 💥[Feature] Foobarize the blorginator. This breaks plugins by renaming the `FOO_DO` filter to `BAR_DO`. (by @regisb) -->
+<!-- - [Improvement] This is a non-breaking change. Life is good. (by @billgates) -->


please remove the default text from changelog.

DawoudSheraz · 2024-11-22T07:27:25Z

changelog.d/20241114_115534_arunmozhi_add_config_edit_command.md

+
+<!-- - 💥[Feature] Foobarize the blorginator. This breaks plugins by renaming the `FOO_DO` filter to `BAR_DO`. (by @regisb) -->
+<!-- - [Improvement] This is a non-breaking change. Life is good. (by @billgates) -->
+[Feature] Adds `tutor config edit`. This opens the active tutor environment's config.yaml in an editor for manual editing. (by @tecoholic)


nit: Please add - at the start so that it renders as a list item.

DawoudSheraz · 2024-11-22T07:30:56Z

tutor/commands/config.py

+    "-e",
+    "--editor",
+    default="",
+    help="Editor to open the config.yaml file.",


nit: the help text should mention if this is name or path to editor (or both).

DawoudSheraz requested review from regisb and kdmccormick July 30, 2024 07:03

regisb requested changes Jul 30, 2024

View reviewed changes

kdmccormick removed their request for review August 9, 2024 17:14

tecoholic force-pushed the tecoholic/add-config-edit-command branch from ecf0b53 to 853e51e Compare August 12, 2024 01:06

tecoholic requested a review from regisb August 12, 2024 01:11

DawoudSheraz reviewed Aug 20, 2024

View reviewed changes

tecoholic force-pushed the tecoholic/add-config-edit-command branch from 853e51e to c095e45 Compare September 2, 2024 12:45

kdmccormick self-requested a review September 24, 2024 13:09

kdmccormick reviewed Oct 24, 2024

View reviewed changes

tecoholic force-pushed the tecoholic/add-config-edit-command branch from c095e45 to 2b00211 Compare November 10, 2024 05:12

DawoudSheraz reviewed Nov 12, 2024

View reviewed changes

kdmccormick requested changes Nov 12, 2024

View reviewed changes

tecoholic and others added 9 commits November 14, 2024 13:32

feat: adds tutor config edit

487d9a1

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

refactor: improve error handling

2b4bfc5

docs: add comment to explain windows command

62baff6

Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>

refactor: improve missing config exception error message

f850784

Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>

refactor: add message at the end of command

1616d9d

docs: adds changelog entry

28949d8

fix: use tutor utils.execute instead of subprocess call

c164596

feat: adds the -e and -s flags to the edit command

83478e8

refactor: handle the editor missing scenario with a better message

d3cd4c0

tecoholic force-pushed the tecoholic/add-config-edit-command branch from 00565bb to d3cd4c0 Compare November 14, 2024 02:32

DawoudSheraz reviewed Nov 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds `tutor config edit` #1099

feat: adds `tutor config edit` #1099

tecoholic commented Jul 24, 2024 •

edited

Loading

regisb Jul 30, 2024

regisb Jul 30, 2024

regisb Jul 30, 2024

tecoholic Aug 12, 2024

tecoholic Aug 12, 2024 •

edited

Loading

DawoudSheraz Aug 20, 2024

regisb Jul 30, 2024

tecoholic commented Aug 7, 2024

kdmccormick commented Aug 9, 2024

DawoudSheraz Aug 20, 2024

kdmccormick Oct 24, 2024

kdmccormick commented Sep 23, 2024

tecoholic commented Sep 23, 2024

regisb commented Sep 24, 2024

kdmccormick left a comment

kdmccormick Oct 24, 2024

tecoholic commented Nov 10, 2024

DawoudSheraz left a comment

kdmccormick left a comment

kdmccormick Nov 12, 2024

tecoholic Nov 14, 2024

tecoholic commented Nov 14, 2024 •

edited

Loading

DawoudSheraz Nov 22, 2024

DawoudSheraz Nov 22, 2024

DawoudSheraz Nov 22, 2024

		@@ -255,9 +259,41 @@ def patches_show(context: Context, name: str) -> None:
		print(rendered)


		@click.command(name="edit", help="Edit config.yml of the current environment")

feat: adds tutor config edit #1099

Are you sure you want to change the base?

feat: adds tutor config edit #1099

Conversation

tecoholic commented Jul 24, 2024 • edited Loading

Background

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tecoholic Aug 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tecoholic commented Aug 7, 2024

kdmccormick commented Aug 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kdmccormick commented Sep 23, 2024

tecoholic commented Sep 23, 2024

regisb commented Sep 24, 2024

kdmccormick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tecoholic commented Nov 10, 2024

DawoudSheraz left a comment

Choose a reason for hiding this comment

kdmccormick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tecoholic commented Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: adds `tutor config edit` #1099

feat: adds `tutor config edit` #1099

tecoholic commented Jul 24, 2024 •

edited

Loading

tecoholic Aug 12, 2024 •

edited

Loading

tecoholic commented Nov 14, 2024 •

edited

Loading