Skip to content

Commit e1b4d86

Browse files
committed
Wrap comments in Config.md
Since these are displayed in a fenced code block on github, they aren't auto-wrapped on display, so users have to scroll horizontally to read longer paragraphs. I decided on a wrap width of 80, but didn't stick to it slavishly.
1 parent 47ca082 commit e1b4d86

File tree

3 files changed

+309
-170
lines changed

3 files changed

+309
-170
lines changed

docs/Config.md

Lines changed: 105 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ gui:
4949
# Map of filenames to icon properties (icon and color)
5050
filenames: {}
5151

52-
# Map of file extensions (including the dot) to icon properties (icon and color)
52+
# Map of file extensions (including the dot) to icon properties
53+
# (icon and color)
5354
extensions: {}
5455

5556
# The number of lines you scroll by when scrolling the main window
@@ -64,12 +65,15 @@ gui:
6465
# One of: 'margin' (default) | 'jump'
6566
scrollOffBehavior: margin
6667

67-
# The number of spaces per tab; used for everything that's shown in the main view, but probably mostly relevant for diffs.
68-
# Note that when using a pager, the pager has its own tab width setting, so you need to pass it separately in the pager command.
68+
# The number of spaces per tab; used for everything that's shown in the
69+
# main view, but probably mostly relevant for diffs.
70+
# Note that when using a pager, the pager has its own tab width setting,
71+
# so you need to pass it separately in the pager command.
6972
tabWidth: 4
7073

7174
# If true, capture mouse events.
72-
# When mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.
75+
# When mouse events are captured, it's a little harder to select text: e.g.
76+
# requiring you to hold the option key when on macOS.
7377
mouseEvents: true
7478

7579
# If true, do not show a warning when amending a commit.
@@ -81,33 +85,43 @@ gui:
8185
# If true, do not show warning when applying/popping the stash
8286
skipStashWarning: false
8387

84-
# If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.
88+
# If true, do not show a warning when attempting to commit without any staged
89+
# files; instead stage all unstaged files.
8590
skipNoStagedFilesWarning: false
8691

8792
# If true, do not show a warning when rewording a commit via an external editor
8893
skipRewordInEditorWarning: false
8994

90-
# Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.
95+
# Fraction of the total screen width to use for the left side section.
96+
# You may want to pick a small number (e.g. 0.2) if you're using a narrow
97+
# screen, so that you can see more of the main section.
9198
# Number from 0 to 1.0.
9299
sidePanelWidth: 0.3333
93100

94-
# If true, increase the height of the focused side window; creating an accordion effect.
101+
# If true, increase the height of the focused side window; creating an
102+
# accordion effect.
95103
expandFocusedSidePanel: false
96104

97-
# The weight of the expanded side panel, relative to the other panels. 2 means
98-
# twice as tall as the other panels. Only relevant if `expandFocusedSidePanel` is true.
105+
# The weight of the expanded side panel, relative to the other panels.
106+
# 2 means twice as tall as the other panels. Only relevant if
107+
# `expandFocusedSidePanel` is true.
99108
expandedSidePanelWeight: 2
100109

101-
# Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.
110+
# Sometimes the main window is split in two (e.g. when the selected file
111+
# has both staged and unstaged changes). This setting controls how the
112+
# two sections are split.
102113
# Options are:
103114
# - 'horizontal': split the window horizontally
104115
# - 'vertical': split the window vertically
105-
# - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
116+
# - 'flexible': (default) split the window horizontally if the window is
117+
# wide enough, otherwise split vertically
106118
mainPanelSplitMode: flexible
107119

108-
# How the window is split when in half screen mode (i.e. after hitting '+' once).
120+
# How the window is split when in half screen mode (i.e. after hitting
121+
# '+' once).
109122
# Possible values:
110-
# - 'left': split the window horizontally (side panel on the left, main view on the right)
123+
# - 'left': split the window horizontally (side panel on the left, main
124+
# view on the right)
111125
# - 'top': split the window vertically (side panel on top, main view below)
112126
enlargedSideViewLocation: left
113127

@@ -116,10 +130,11 @@ gui:
116130
# paragraphs of markdown text.
117131
wrapLinesInStagingView: true
118132

119-
# If true, hunk selection mode will be enabled by default when entering the staging view.
133+
# If true, hunk selection mode will be enabled by default when entering
134+
# the staging view.
120135
useHunkModeInStagingView: true
121136

122-
# One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'
137+
# One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru' | 'pt'
123138
language: auto
124139

125140
# Format used when displaying time e.g. commit time.
@@ -192,11 +207,15 @@ gui:
192207
# If true, show the '5 of 20' footer at the bottom of list views
193208
showListFooter: true
194209

195-
# If true, display the files in the file views as a tree. If false, display the files as a flat list.
196-
# This can be toggled from within Lazygit with the '`' key, but that will not change the default.
210+
# If true, display the files in the file views as a tree. If false,
211+
# display the files as a flat list.
212+
# This can be toggled from within Lazygit with the '`' key, but that will
213+
# not change the default.
197214
showFileTree: true
198215

199-
# If true, add a "/" root item in the file tree representing the root of the repository. It is only added when necessary, i.e. when there is more than one item at top level.
216+
# If true, add a "/" root item in the file tree representing the root of
217+
# the repository. It is only added when necessary, i.e. when there is more
218+
# than one item at top level.
200219
showRootItemInFileTree: true
201220

202221
# If true, show the number of lines changed per file in the Files view
@@ -208,7 +227,9 @@ gui:
208227
# If true, show the command log
209228
showCommandLog: true
210229

211-
# If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.
230+
# If true, show the bottom line that contains keybinding info and useful
231+
# buttons. If false, this line will be hidden except to display a loader
232+
# for an in-progress action.
212233
showBottomLine: true
213234

214235
# If true, show jump-to-window keybindings in window titles.
@@ -219,13 +240,16 @@ gui:
219240
# If empty, do not show icons.
220241
nerdFontsVersion: ""
221242

222-
# If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.
243+
# If true (default), file icons are shown in the file views. Only relevant
244+
# if NerdFontsVersion is not empty.
223245
showFileIcons: true
224246

225-
# Length of author name in (non-expanded) commits view. 2 means show initials only.
247+
# Length of author name in (non-expanded) commits view. 2 means show
248+
# initials only.
226249
commitAuthorShortLength: 2
227250

228-
# Length of author name in expanded commits view. 2 means show initials only.
251+
# Length of author name in expanded commits view. 2 means show
252+
# initials only.
229253
commitAuthorLongLength: 17
230254

231255
# Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.
@@ -243,18 +267,21 @@ gui:
243267

244268
# Whether to split the main window when viewing file changes.
245269
# One of: 'auto' | 'always'
246-
# If 'auto', only split the main window when a file has both staged and unstaged changes
270+
# If 'auto', only split the main window when a file has both staged and
271+
# unstaged changes
247272
splitDiff: auto
248273

249-
# Default size for focused window. Can be changed from within Lazygit with '+' and '_' (but this won't change the default).
274+
# Default size for focused window. Can be changed from within Lazygit
275+
# with '+' and '_' (but this won't change the default).
250276
# One of: 'normal' (default) | 'half' | 'full'
251277
screenMode: normal
252278

253279
# Window border style.
254280
# One of 'rounded' (default) | 'single' | 'double' | 'hidden' | 'bold'
255281
border: rounded
256282

257-
# If true, show a seriously epic explosion animation when nuking the working tree.
283+
# If true, show a seriously epic explosion animation when nuking the
284+
# working tree.
258285
animateExplosion: true
259286

260287
# Whether to stack UI components on top of each other.
@@ -287,14 +314,16 @@ gui:
287314
# If true, jump to the Files panel after applying a stash
288315
switchToFilesAfterStashApply: true
289316

290-
# If true, when using the panel jump keys (default 1 through 5) and target panel is already active, go to next tab instead
317+
# If true, when using the panel jump keys (default 1 through 5) and target
318+
# panel is already active, go to next tab instead
291319
switchTabsWithPanelJumpKeys: false
292320

293321
# Config relating to git
294322
git:
295323
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md
296324
paging:
297-
# Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'
325+
# Value of the --color arg in the git diff command. Some pagers want this
326+
# to be set to 'always' and some want it set to 'never'
298327
colorArg: always
299328

300329
# e.g.
@@ -306,7 +335,10 @@ git:
306335
# e.g. 'difft --color=always'
307336
externalDiffCommand: ""
308337

309-
# If true, Lazygit will use git's `diff.external` config for paging. The advantage over `externalDiffCommand` is that this can be configured per file type in .gitattributes; see https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
338+
# If true, Lazygit will use git's `diff.external` config for paging. The
339+
# advantage over `externalDiffCommand` is that this can be configured per
340+
# file type in .gitattributes; see
341+
# https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
310342
useExternalDiffGitConfig: false
311343

312344
# Config relating to committing
@@ -322,22 +354,26 @@ git:
322354

323355
# Config relating to merging
324356
merging:
325-
# If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang
357+
# If true, run merges in a subprocess so that if a commit message is
358+
# required, Lazygit will not hang.
326359
# Only applicable to unix users.
327360
manualCommit: false
328361

329362
# Extra args passed to `git merge`, e.g. --no-ff
330363
args: ""
331364

332-
# The commit message to use for a squash merge commit. Can contain "{{selectedRef}}" and "{{currentBranch}}" placeholders.
365+
# The commit message to use for a squash merge commit. Can contain
366+
# "{{selectedRef}}" and "{{currentBranch}}" placeholders.
333367
squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}}
334368

335-
# list of branches that are considered 'main' branches, used when displaying commits
369+
# list of branches that are considered 'main' branches, used when
370+
# displaying commits
336371
mainBranches:
337372
- master
338373
- main
339374

340-
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'
375+
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit
376+
# hooks will be skipped when the commit message starts with 'WIP'
341377
skipHookPrefix: WIP
342378

343379
# If true, periodically fetch from remote
@@ -346,7 +382,10 @@ git:
346382
# If true, periodically refresh files and submodules
347383
autoRefresh: true
348384

349-
# If not "none", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
385+
# If not "none", lazygit will automatically fast-forward local branches
386+
# to match their upstream after fetching. Applies to branches that are not
387+
# the currently checked out branch, and only to those that are strictly
388+
# behind their upstream (as opposed to diverged).
350389
# Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
351390
autoForwardBranches: onlyMainBranches
352391

@@ -362,17 +401,22 @@ git:
362401
# Command used when displaying the current branch git log in the main window
363402
branchLogCmd: git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --
364403

365-
# Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
404+
# Commands used to display git log of all branches in the main window,
405+
# they will be cycled in order of appearance (array of strings)
366406
allBranchesLogCmds:
367407
- git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium
368408

369-
# If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
409+
# If true, git diffs are rendered with the `--ignore-all-space` flag,
410+
# which ignores whitespace changes. Can be toggled from within Lazygit
411+
# with `<c-w>`.
370412
ignoreWhitespaceInDiffView: false
371413

372-
# The number of lines of context to show around each diff hunk. Can be changed from within Lazygit with the `{` and `}` keys.
414+
# The number of lines of context to show around each diff hunk. Can be
415+
# changed from within Lazygit with the `{` and `}` keys.
373416
diffContextSize: 3
374417

375-
# The threshold for considering a file to be renamed, in percent. Can be changed from within Lazygit with the `(` and `)` keys.
418+
# The threshold for considering a file to be renamed, in percent. Can be
419+
# changed from within Lazygit with the `(` and `)` keys.
376420
renameSimilarityThreshold: 50
377421

378422
# If true, do not spawn a separate process when using GPG
@@ -397,29 +441,34 @@ git:
397441
# Config for showing the log in the commits view
398442
log:
399443
# One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
400-
# 'topo-order' makes it easier to read the git log graph, but commits may not
401-
# appear chronologically. See https://git-scm.com/docs/
444+
# 'topo-order' makes it easier to read the git log graph, but commits may
445+
# not appear chronologically. See https://git-scm.com/docs/
402446
#
403-
# Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
447+
# Can be changed from within Lazygit with `Log menu -> Commit sort order`
448+
# (`<c-l>` in the commits window by default).
404449
order: topo-order
405450

406451
# This determines whether the git graph is rendered in the commits panel
407452
# One of 'always' | 'never' | 'when-maximised'
408453
#
409-
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
454+
# Can be toggled from within lazygit with `Log menu -> Show git graph`
455+
# (`<c-l>` in the commits window by default).
410456
showGraph: always
411457

412-
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
458+
# displays the whole git graph by default in the commits view (equivalent
459+
# to passing the `--all` argument to `git log`)
413460
showWholeGraph: false
414461

415462
# How branches are sorted in the local branches view.
416463
# One of: 'date' (default) | 'recency' | 'alphabetical'
417-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
464+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
465+
# the branches panel.
418466
localBranchSortOrder: date
419467

420468
# How branches are sorted in the remote branches view.
421469
# One of: 'date' (default) | 'alphabetical'
422-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
470+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
471+
# the remote branches panel.
423472
remoteBranchSortOrder: date
424473

425474
# When copying commit hashes to the clipboard, truncate them to this
@@ -447,10 +496,12 @@ refresher:
447496
# If true, show a confirmation popup before quitting Lazygit
448497
confirmOnQuit: false
449498

450-
# If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close
499+
# If true, exit Lazygit when the user presses escape in a context where
500+
# there is nothing to cancel/close
451501
quitOnTopLevelReturn: false
452502

453-
# Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc
503+
# Config relating to things outside of Lazygit like how files are opened,
504+
# copying to clipboard, etc
454505
os:
455506
# Command for editing a file. Should contain "{{filename}}".
456507
edit: ""
@@ -488,7 +539,10 @@ os:
488539
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-and-pasting-from-clipboard
489540
readFromClipboardCmd: ""
490541

491-
# A shell startup file containing shell aliases or shell functions. This will be sourced before running any shell commands, so that shell functions are available in the `:` command prompt or even in custom commands.
542+
# A shell startup file containing shell aliases or shell functions. This
543+
# will be sourced before running any shell commands, so that shell
544+
# functions are available in the `:` command prompt or even in custom
545+
# commands.
492546
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#using-aliases-or-functions-in-shell-commands
493547
shellFunctionsFile: ""
494548

@@ -503,13 +557,15 @@ customCommands: []
503557
services: {}
504558

505559
# What to do when opening Lazygit outside of a git repo.
506-
# - 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo
560+
# - 'prompt': (default) ask whether to initialize a new repo or open in
561+
# the most recent repo
507562
# - 'create': initialize a new repo
508563
# - 'skip': open most recent repo
509564
# - 'quit': exit Lazygit
510565
notARepository: prompt
511566

512-
# If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.
567+
# If true, display a confirmation when subprocess terminates. This allows
568+
# you to view the output of the subprocess before returning to Lazygit.
513569
promptToReturnFromSubprocess: true
514570

515571
# Keybindings

0 commit comments

Comments
 (0)