Skip to content

Commit 9e82ad6

Browse files
committed
Regen docs (for buildifier_lint_mode)
Regen vim helpdoc after fixing up some buildifier_lint_mode description that was manually added to the generated doc but not in the source doc comment.
1 parent 4b435eb commit 9e82ad6

File tree

2 files changed

+23
-18
lines changed

2 files changed

+23
-18
lines changed

doc/codefmt.txt

+15-13
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Default: 'yapf' `
9494
The path to the black executable.
9595
Default: 'black' `
9696

97-
*codefmt:isort_executable*
97+
*codefmt:isort_executable*
9898
The path to the isort executable.
9999
Default: 'isort' `
100100

@@ -106,13 +106,16 @@ Default: 'gn' `
106106
The path to the buildifier executable.
107107
Default: 'buildifier' `
108108

109-
*codefmt:buildifier_lint_mode*
110-
Buildifier --lint=lint_mode parameter. Set to 'fix' to autofix issues.
111-
Default: '' to not pass the flag and use the buildifier default (off)
112-
Off: Do not fix issues.
113-
Fix: Fix issues automatically during formatting.
114-
Warn: Format only if there are no issues; if there are issues
115-
it will cause an error and do no formatting.
109+
*codefmt:buildifier_lint_mode*
110+
The lint_mode for buildifier. passed to buildifier --lint parameter.
111+
112+
Options:
113+
"" (empty): Use default from buildifier.
114+
"Off": Do not fix issues.
115+
"Fix": Fix issues automatically during formatting.
116+
"Warn": Format only if there are no issues; if there are issues, it will cause
117+
an error and do no formatting.
118+
Default: '' `
116119

117120
*codefmt:google_java_executable*
118121
The path to the google-java executable. Generally, this should have the form:
@@ -147,6 +150,10 @@ Command line arguments to feed prettier. Either a list or callable that takes
147150
no args and returns a list with command line arguments.
148151
Default: [] `
149152

153+
*codefmt:swift_format_executable*
154+
The path to the swift-format executable.
155+
Default: 'swift-format' `
156+
150157
*codefmt:prettier_executable*
151158
The path to the prettier executable. String, list, or callable that takes no
152159
args and returns a string or a list. The default uses npx if available, so
@@ -190,11 +197,6 @@ Default: 'luaformatterfiveone' `
190197
The path to the cljstyle executable.
191198
Default: 'cljstyle' `
192199

193-
*codefmt:swift_format_executable*
194-
The path to the swift-format executable.
195-
Default: 'swift-format' `
196-
197-
198200
*codefmt:plugin[autocmds]*
199201
Configures whether plugin/autocmds.vim should be loaded.
200202
Default: 1 `

instant/flags.vim

+8-5
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,14 @@ call s:plugin.Flag('gn_executable', 'gn')
101101
call s:plugin.Flag('buildifier_executable', 'buildifier')
102102

103103
""
104-
" The lint_mode for buildifier, defaults to not passing the flag.
105-
" set to 'fix' to fix issues automatically during formatting,
106-
" or 'off' to explicitly not fix issues (the current buildifier default).
107-
" Setting to 'warn' will format only if there are no issues; if there are
108-
" issues it will cause an error and do no formatting.
104+
" The lint_mode for buildifier. passed to buildifier --lint parameter.
105+
"
106+
" Options:
107+
" - "" (empty): Use default from buildifier.
108+
" - "Off": Do not fix issues.
109+
" - "Fix": Fix issues automatically during formatting.
110+
" - "Warn": Format only if there are no issues; if there are issues, it will
111+
" cause an error and do no formatting.
109112
call s:plugin.Flag('buildifier_lint_mode', '')
110113

111114
""

0 commit comments

Comments
 (0)