go/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-04-25 12:24:47 +02:00
Code Issues Releases Activity

prettify config.md

Browse Source
This commit is contained in:
Jesse Duffield 2021-04-11 21:42:41 +10:00
parent 069c7c9d35
commit 764bd556f3
1 changed files with 239 additions and 236 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/Config.md
View File

@ -2,15 +2,15 @@
Default path for the config file: Default path for the config file:
* Linux: `~/.config/lazygit/config.yml` - Linux: `~/.config/lazygit/config.yml`
* MacOS: `~/Library/Application Support/lazygit/config.yml` - MacOS: `~/Library/Application Support/lazygit/config.yml`
* Windows: `%APPDATA%\lazygit\config.yml` - Windows: `%APPDATA%\lazygit\config.yml`
For old installations (slightly embarrassing: I didn't realise at the time that you didn't need to supply a vendor name to the path so I just used my name): For old installations (slightly embarrassing: I didn't realise at the time that you didn't need to supply a vendor name to the path so I just used my name):
* Linux: `~/.config/jesseduffield/lazygit/config.yml` - Linux: `~/.config/jesseduffield/lazygit/config.yml`
* MacOS: `~/Library/Application Support/jesseduffield/lazygit/config.yml` - MacOS: `~/Library/Application Support/jesseduffield/lazygit/config.yml`
* Windows: `%APPDATA%\jesseduffield\lazygit\config.yml` - Windows: `%APPDATA%\jesseduffield\lazygit\config.yml`
## Default ## Default
@ -41,7 +41,7 @@ For old installations (slightly embarrassing: I didn't realise at the time that
skipUnstageLineWarning: false skipUnstageLineWarning: false
skipStashWarning: true skipStashWarning: true
showFileTree: false # for rendering changes files in a tree format showFileTree: false # for rendering changes files in a tree format
showCommandLog: false showCommandLog:
git: git:
paging: paging:
colorArg: always colorArg: always
@ -50,13 +50,13 @@ For old installations (slightly embarrassing: I didn't realise at the time that
# only applicable to unix users # only applicable to unix users
manualCommit: false manualCommit: false
# extra args passed to `git merge`, e.g. --no-ff # extra args passed to `git merge`, e.g. --no-ff
args: "" args: ''
pull: pull:
mode: 'merge' # one of 'merge' | 'rebase' | 'ff-only' mode: 'merge' # one of 'merge' | 'rebase' | 'ff-only'
skipHookPrefix: WIP skipHookPrefix: WIP
autoFetch: true autoFetch: true
branchLogCmd: "git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --" branchLogCmd: 'git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --'
allBranchesLogCmd: "git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium" 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 overrideGpg: false # prevents lazygit from spawning a separate process when using GPG
disableForcePushing: false disableForcePushing: false
refresher: refresher:
@ -269,6 +269,7 @@ If you struggle to see the selected line I recommend using the reverse attribute
``` ```
The following has also worked for a couple of people: The following has also worked for a couple of people:
```yaml ```yaml
gui: gui:
theme: theme:
@ -334,7 +335,7 @@ the pull request. You can do so on your `config.yml` file using the following sy
```yaml ```yaml
services: services:
"<gitDomain>": "<provider>:<webDomain>" '<gitDomain>': '<provider>:<webDomain>'
``` ```
Where: Where:
@ -344,19 +345,21 @@ Where:
- `webDomain` is the URL where your git service exposes a web interface and APIs, e.g. `gitservice.work.com` - `webDomain` is the URL where your git service exposes a web interface and APIs, e.g. `gitservice.work.com`
## Predefined commit message prefix ## Predefined commit message prefix
In situations where certain naming pattern is used for branches and commits, pattern can be used to populate In situations where certain naming pattern is used for branches and commits, pattern can be used to populate
commit message with prefix that is parsed from the branch name. commit message with prefix that is parsed from the branch name.
Example: Example:
* Branch name: feature/AB-123
* Commit message: [AB-123] Adding feature - Branch name: feature/AB-123
- Commit message: [AB-123] Adding feature
```yaml ```yaml
git: git:
commitPrefixes: commitPrefixes:
my_project: # This is repository folder name my_project: # This is repository folder name
pattern: "^\\w+\\/(\\w+-\\w+).*" pattern: "^\\w+\\/(\\w+-\\w+).*"
replace: "[$1] " replace: '[$1] '
``` ```
## Custom git log command ## Custom git log command