Skip to content

Commit

Permalink
Docs for EditCommand.
Browse files Browse the repository at this point in the history
  • Loading branch information
caojoshua authored and jesseduffield committed Jun 5, 2021
1 parent 60468d2 commit e7c657f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ git:
allBranchesLogCmd: 'git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium'
overrideGpg: false # prevents lazygit from spawning a separate process when using GPG
disableForcePushing: false
os:
editCommand: '' # see EditCommand section
openCommand: # see OpenCommand section
refresher:
refreshInterval: 10 # file/submodule refresh interval in seconds
fetchInterval: 60 # re-fetch interval in seconds
Expand Down Expand Up @@ -214,6 +217,21 @@ os:
openCommand: 'open {{filename}}'
```

### EditCommand
Lazygit will run edit with the first non-empty command:
1. config.yaml
```yaml
os:
editCommand:
```
2. $(git config core.editor)
3. $GIT_EDITOR
4. $VISUAL
5. $EDITOR
6. vi (if found through `which vi`)

Lazygit will log an error if none of these commands are non-empty.

### Recommended Config Values

for users of VSCode
Expand Down
2 changes: 1 addition & 1 deletion pkg/commands/files.go
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ func (c *GitCommand) EditFileCmdStr(filename string) (string, error) {
}
}
if editor == "" {
return "", errors.New("No editor defined in $GIT_EDITOR, $VISUAL, $EDITOR, or git config")
return "", errors.New("No editor defined in config file, $GIT_EDITOR, $VISUAL, $EDITOR, or git config")
}

return fmt.Sprintf("%s %s", editor, c.OSCommand.Quote(filename)), nil
Expand Down

0 comments on commit e7c657f

Please sign in to comment.