Add option to specify other shell(Arg) #3299

J-Kappes · 2024-02-02T12:14:59Z

PR Description
if os.shell is not empty it replaces the default "bash" shell and os.shellArg replaces the default "-c" argument.
started writing test but don't know how to check stdout or command log.
Please check if the PR fulfills these requirements

Cheatsheets are up-to-date (run go generate ./...)
Code has been formatted (see here)
Tests have been added/updated (see here for the integration test guide)
Text is internationalised (see here)
Docs (specifically docs/Config.md) have been updated if necessary
You've read through your own file changes for silly mistakes etc

karimkhaleel

Thanks for the PR. I tested it out, and it seems to work as advertised. Left a couple of comments that I think could help.

karimkhaleel · 2024-03-17T06:49:50Z

pkg/gui/gui.go

+	shell := gui.UserConfig.OS.Shell
+	if shell != "" {
+		osCommand.Platform.Shell = shell
+		osCommand.Platform.ShellArg = gui.UserConfig.OS.ShellArg
+	}


Would it be better to move this logic into NewOsCommand? We want all os commands to inherit that setting, right? Or do we only want the command runner for custom commands to use the shell and shellArgs from the userconfig?

Sounds good. I don't know how to access config.OS from there, though 😕

On second thought, I think it would make more sense to pass the OSConfig struct into oscommands.GetPlatform and get that function to extract the shell and shellArg values from there and use them there directly.

Sounds good. I don't know how to access config.OS from there, though 😕

You would be able to access the config through the Common struct that's passed into NewOsCommand function.

karimkhaleel · 2024-03-17T06:52:37Z

pkg/integration/tests/custom_commands/custom_shell.go

I am not sure, but perhaps an integration test is not the right thing for this feature? Maybe this should just be a unit test in pkg/commands/oscommands/os_test.go

karimkhaleel · 2024-03-17T06:53:53Z

schema/config.json

+        },
+        "shell": {
+          "type": "string",
+          "description": "Shell and ShellArg are the shell and corresponding argument to be used for executing custom commands.\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-clipboard"


The URL here needs to point to the "Custom Shell for executing arbitrary commands" section of the Config.md file.

This reverts commit dadfcbd.

karimkhaleel

Looking good. Just one last comment.

karimkhaleel · 2024-03-17T18:48:27Z

pkg/commands/oscommands/os_default_platform.go

+	if osConfig.Shell != "" {
+		platform.Shell = osConfig.Shell
+		platform.ShellArg = osConfig.ShellArg
+	}


I think at this point, we should probably just consider setting bash and -c as default parameters for Shell and ShellArg in the user_config file. That way, we can just directly take the values from osConfig and use them in the Platform literal.

yam-liu · 2024-08-02T08:48:35Z

@J-Kappes Hi there,

I hope you're doing well. I wanted to check on the status of your PR for the feature we've been eagerly awaiting. Are you still able to work on it?

If you're too busy, I'd be happy to help move it forward. No pressure either way - just let me know what works best for you.

Thanks for your efforts on this!

J-Kappes · 2024-08-02T09:21:30Z

Oh, yes, I'm fine.

I'm happy with the feature itself but I don't intend on finishing the test tbh.

stefanhaller · 2024-08-02T09:46:05Z

I just looked at this for the first time in more detail.

I like the feature and would like to have it myself. As I said in #3749 though, I'd prefer it if we could have this automatically with no user config, like in #2096. If people want to spend more effort on this topic, I think it would be a good idea to first spend some more time to research what was the problem with #2096 (I don't remember, and don't have time to invest in that right now myself).

Another thought: currently, the NewShell function that is being modified here is used for a ton of things, including opening files in an editor, opening links, cop&paste, updating the window title on Windows, and others. I think it could be a good idea to use the -i shell only for invoking custom commands, but not for any of the others. I'm not totally sure we really need to make this distinction, just feels better to me. Opinions welcome (ping @jesseduffield).

And finally: if we do take the approach of this PR, then I would like to wait with finishing the PR until #3787 is done, and find ways to make the new config hot-reloadable, which it currently isn't. See d3c91ac.

jesseduffield · 2024-08-02T12:35:18Z

Another thought: currently, the NewShell function that is being modified here is used for a ton of things, including opening files in an editor, opening links, cop&paste, updating the window title on Windows, and others. I think it could be a good idea to use the -i shell only for invoking custom commands, but not for any of the others. I'm not totally sure we really need to make this distinction, just feels better to me. Opinions welcome (ping @jesseduffield).

I agree: custom commands typically commands you would otherwise run in your shell, so using -i makes sense. It sucks that it's then inconsistent with how we invoke commands in other contexts, but I think it's a good tradeoff (obvious downside of -i is that it can slow things down)

stefanhaller · 2024-08-03T13:25:13Z

@yam-liu I opened a new PR that solves this without a config setting: #3793. Can you please check if this addresses your needs?

@J-Kappes Since your PR description doesn't say why you opened this PR or what problem it solves, I'm not totally sure if this addresses your needs. Can you please check?

yam-liu · 2024-08-04T03:19:57Z

@stefanhaller I tested it. It's just what I want.👍🏼

J-Kappes · 2024-08-04T09:48:12Z

@J-Kappes Since your PR description doesn't say why you opened this PR or what problem it solves, I'm not totally sure if this addresses your needs. Can you please check?

I haven't tried it but the description sounds exaclty like what I want: being able to use my fish abbreviations.

- **PR Description** When executing an interactive custom command, use the user's shell rather than "bash", and pass the -i flag. This makes it possible to use shell aliases or shell functions which are not available in non-interactive shells. In previous attempts to solve this, concerns were brought up: [this one](#2096 (comment)) is addressed by using the interactive shell only for custom commands but not anything else. [This one](#2096 (comment)) is a little dubious and unconfirmed, so I'm not very worried about it. Supersedes #2096 and #3299. Fixes #770, #899, and #1642.

stefanhaller · 2024-08-17T08:36:02Z

Closing, superseded by #3793.

J-Kappes added 5 commits February 2, 2024 11:46

docs/Config.md: add custom shell

248c204

add option to specify other shell(Arg)

a143d9d

update schema

fd22a00

start writing test

dadfcbd

Merge branch 'master' into shell_selection

682ea3b

J-Kappes marked this pull request as ready for review February 16, 2024 11:57

GeorgiChochev mentioned this pull request Mar 15, 2024

Ability to use existing shell for commands and git actions #899

Closed

karimkhaleel reviewed Mar 17, 2024

View reviewed changes

J-Kappes added 3 commits March 17, 2024 11:54

fix doc links

a88442a

Revert adding integration test

7d030e8

This reverts commit dadfcbd.

moved logic into oscommands.GetPlatform()

7a7f38c

karimkhaleel reviewed Mar 17, 2024

View reviewed changes

stefanhaller mentioned this pull request Jul 15, 2024

Allow customize Shell & ShellArg in config.yml #3749

Open

stefanhaller mentioned this pull request Aug 3, 2024

Allow using shell aliases in interactive custom commands #3793

Merged

6 tasks

stefanhaller closed this Aug 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to specify other shell(Arg) #3299

Add option to specify other shell(Arg) #3299

J-Kappes commented Feb 2, 2024

karimkhaleel left a comment

karimkhaleel Mar 17, 2024

J-Kappes Mar 17, 2024

karimkhaleel Mar 17, 2024

karimkhaleel Mar 17, 2024

karimkhaleel Mar 17, 2024

karimkhaleel left a comment

karimkhaleel Mar 17, 2024

yam-liu commented Aug 2, 2024

J-Kappes commented Aug 2, 2024

stefanhaller commented Aug 2, 2024

jesseduffield commented Aug 2, 2024

stefanhaller commented Aug 3, 2024

yam-liu commented Aug 4, 2024

J-Kappes commented Aug 4, 2024

stefanhaller commented Aug 17, 2024

Add option to specify other shell(Arg) #3299

Add option to specify other shell(Arg) #3299

Conversation

J-Kappes commented Feb 2, 2024

karimkhaleel left a comment

Choose a reason for hiding this comment

karimkhaleel Mar 17, 2024

Choose a reason for hiding this comment

J-Kappes Mar 17, 2024

Choose a reason for hiding this comment

karimkhaleel Mar 17, 2024

Choose a reason for hiding this comment

karimkhaleel Mar 17, 2024

Choose a reason for hiding this comment

karimkhaleel Mar 17, 2024

Choose a reason for hiding this comment

karimkhaleel left a comment

Choose a reason for hiding this comment

karimkhaleel Mar 17, 2024

Choose a reason for hiding this comment

yam-liu commented Aug 2, 2024

J-Kappes commented Aug 2, 2024

stefanhaller commented Aug 2, 2024

jesseduffield commented Aug 2, 2024

stefanhaller commented Aug 3, 2024

yam-liu commented Aug 4, 2024

J-Kappes commented Aug 4, 2024

stefanhaller commented Aug 17, 2024