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.

tutor/commands/config.py

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

tutor/commands/config.py

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

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.

Thank you for spelling out those caveats.

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

Could you catch this error, and if --save was provided, warn the user that the editor exited non-zero and thus their config changes were not applied?

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.

Ah, this one is a bit worrying. Visual editors often will accept a flag that blocks the command until the editor is exited, e.g. subl --wait for Sublime Text. That would be useful for this particular scenario, e.g.,:

tutor config edit -s -e 'subl --wait'

This will fail with your current code, but could be fixed by running shlex.split on the -e argument.

All that said, with all details and nuances that these new flags make us consider, I feel that we are delaying the tutor config edit feature more than we need to. It would be nice to have the base command Sumac. @tecoholic how would you feel about omitting -s and -e for now, and opening a follow-up PR to add them?

@kdmccormick Thanks for taking another look. I agree with your assessment about the flags being a bit suboptimal. That's the reason, I initially only considered them as future improvements.

So, I will roll back those bits and leave the bare command alone in this PR.

tutor/commands/config.py

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

Co-authored-by: Kyle McCormick <[email protected]>

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.

changelog.d/20241114_115534_arunmozhi_add_config_edit_command.md

tutor/commands/config.py

tecoholic · 2024-11-28T00:37:52Z

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

kdmccormick · 2024-11-14T13:00:28Z

tutor/commands/config.py

+        click.echo(
+            click.style(
+                "💡 You can automatically update the environment after editing by setting the flag -s.\n"
+                "e.g., `tutor config edit -s`",
+                fg="blue",
+            )
+        )


Since the command's helptext already explains this, and we do not want to overwhelm the user with information, I don't think this message is necessary.

Suggested change

click.echo(

click.style(

"💡 You can automatically update the environment after editing by setting the flag -s.\n"

"e.g., `tutor config edit -s`",

fg="blue",

)

)

kdmccormick · 2024-12-02T15:53:06Z

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


Thank you for spelling out those caveats.

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

Could you catch this error, and if --save was provided, warn the user that the editor exited non-zero and thus their config changes were not applied?

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.

Ah, this one is a bit worrying. Visual editors often will accept a flag that blocks the command until the editor is exited, e.g. subl --wait for Sublime Text. That would be useful for this particular scenario, e.g.,:

tutor config edit -s -e 'subl --wait'

This will fail with your current code, but could be fixed by running shlex.split on the -e argument.

All that said, with all details and nuances that these new flags make us consider, I feel that we are delaying the tutor config edit feature more than we need to. It would be nice to have the base command Sumac. @tecoholic how would you feel about omitting -s and -e for now, and opening a follow-up PR to add them?

tecoholic · 2024-12-03T23:20:16Z

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

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

tutor/commands/config.py Outdated Show resolved Hide resolved

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

tutor/commands/config.py Show resolved Hide resolved

tutor/commands/config.py Outdated Show resolved Hide resolved

tutor/commands/config.py Outdated Show resolved Hide resolved

tutor/commands/config.py Outdated Show resolved Hide resolved

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 <[email protected]>

refactor: improve missing config exception error message

f850784

Co-authored-by: Kyle McCormick <[email protected]>

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

changelog.d/20241114_115534_arunmozhi_add_config_edit_command.md Outdated Show resolved Hide resolved

DawoudSheraz reviewed Nov 22, 2024

View reviewed changes

changelog.d/20241114_115534_arunmozhi_add_config_edit_command.md Outdated Show resolved Hide resolved

DawoudSheraz reviewed Nov 22, 2024

View reviewed changes

tutor/commands/config.py Outdated Show resolved Hide resolved

fix: address review comments

f008f92

DawoudSheraz requested a review from kdmccormick November 28, 2024 13:13

DawoudSheraz approved these changes Nov 28, 2024

View reviewed changes

kdmccormick requested changes Dec 2, 2024

View reviewed changes

refactor: rollback the extra flags in the command

6295887

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 commented Aug 7, 2024

kdmccormick commented Aug 9, 2024

kdmccormick commented Sep 23, 2024

tecoholic commented Sep 23, 2024

regisb commented Sep 24, 2024

kdmccormick left a comment

tecoholic commented Nov 10, 2024

DawoudSheraz left a comment

kdmccormick left a comment

kdmccormick Nov 12, 2024

tecoholic Nov 14, 2024

kdmccormick Dec 2, 2024

tecoholic Dec 3, 2024 •

edited

Loading

tecoholic commented Nov 14, 2024 •

edited

Loading

tecoholic commented Nov 28, 2024

kdmccormick Nov 14, 2024

kdmccormick Dec 2, 2024

tecoholic commented Dec 3, 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

tecoholic commented Aug 7, 2024

kdmccormick commented Aug 9, 2024

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

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

Choose a reason for hiding this comment

tecoholic Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

tecoholic commented Nov 14, 2024 • edited Loading

tecoholic commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tecoholic commented Dec 3, 2024

feat: adds `tutor config edit` #1099

feat: adds `tutor config edit` #1099

tecoholic commented Jul 24, 2024 •

edited

Loading

tecoholic Dec 3, 2024 •

edited

Loading

tecoholic commented Nov 14, 2024 •

edited

Loading