Skip to content

Commit bdd21c9

Browse files
committed
Support g:scratch_buffer_default_file_ext, g:scratch_buffer_default_open_method, and g:scratch_buffer_default_buffer_size
1 parent aa2e4a5 commit bdd21c9

File tree

3 files changed

+33
-13
lines changed

3 files changed

+33
-13
lines changed

autoload/scratch_buffer.vim

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ function! scratch_buffer#open_file(...) abort
1717
endfunction
1818

1919
function! s:open_buffer(temp_buffer, args) abort
20-
const file_ext = get(a:args, 0, '--no-file-ext')
20+
const file_ext = get(a:args, 0, g:scratch_buffer_default_file_ext)
2121
const file_pattern = (file_ext ==# '--no-file-ext' || file_ext ==# '')
2222
\ ? $'{g:scratch_buffer_tmp_file_pattern}'
2323
\ : $'{g:scratch_buffer_tmp_file_pattern}.{file_ext}'
@@ -27,8 +27,8 @@ function! s:open_buffer(temp_buffer, args) abort
2727
throw 'No fresh scratch file found.'
2828
endif
2929

30-
const open_method = get(a:args, 1, 'sp')
31-
const buffer_size = get(a:args, 2, v:null)
30+
const open_method = get(a:args, 1, g:scratch_buffer_default_open_method)
31+
const buffer_size = get(a:args, 2, g:scratch_buffer_default_buffer_size)
3232

3333
execute 'silent' open_method file_name
3434

doc/vim-scratch-buffer.txt

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,35 @@ INTERFACE *scratch-buffer-interface*
7171
VARIABLES *scratch-buffer-variables*
7272

7373
*g:scratch_buffer_tmp_file_pattern*
74-
Default: '/tmp/vim-scratch-buffer-%d'
74+
Default:`'/tmp/vim-scratch-buffer-%d'`
7575

76-
When `ScratchBufferOpen` opens a scratch buffer, it will make a
76+
When`ScratchBufferOpen`opens a scratch buffer, it will make a
7777
decision based on this pattern.
78-
Specifically, `printf($'/tmp/vim-scratch-buffer-%d.{ext}', count)` will
79-
be opened. `ext` is the first argument of `ScratchBufferOpen`.
80-
`count` is the number of currently open scratch buffers +1.
78+
Specifically,`printf($'/tmp/vim-scratch-buffer-%d.{ext}', count)`
79+
will be opened. `ext`is the first argument of`ScratchBufferOpen`.
80+
`count`is the number of currently open scratch buffers +1.
81+
82+
*g:scratch_buffer_default_file_ext*
83+
Default:`'md'`
84+
85+
The default file extension to use when opening a new scratch buffer.
86+
This is used when no file extension is provided as an argument.
87+
88+
*g:scratch_buffer_default_open_method*
89+
Default:`'sp'`
90+
91+
The default method to use when opening a new scratch buffer.
92+
Can be either 'sp' for horizontal split or 'vsp' for vertical split.
93+
94+
*g:scratch_buffer_default_buffer_size*
95+
Default:`15`
96+
97+
The default size (height for 'sp' or width for 'vsp') of newly opened
98+
scratch buffers. Set to a positive number to resize the buffer
99+
upon opening.
81100

82101
*g:scratch_buffer_auto_save_file_buffer*
83-
Default: `v:true`
102+
Default:`v:true`
84103

85104
When enabled, file buffers (not temporary buffers) will be
86105
automatically saved when their content changes.
@@ -89,14 +108,12 @@ VARIABLES *scratch-buffer-variables*
89108
A dictionary that controls the auto-hiding behavior of scratch buffers.
90109
Has the following keys:
91110

92-
.when_tmp_buffer
93-
Default: `v:true`
111+
.when_tmp_buffer ( Default:`v:true`)
94112
When enabled,
95113
temporary buffers will be automatically hidden
96114
when leaving their window.
97115

98-
.when_file_buffer
99-
Default: `v:false`
116+
.when_file_buffer ( Default:`v:false`)
100117
When enabled,
101118
file buffers will be automatically hidden
102119
when leaving their window.

plugin/scratch_buffer.vim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ command! -bar -nargs=* ScratchBufferOpenFile call scratch_buffer#open_file(<f-ar
2121
command! -bar ScratchBufferClean call scratch_buffer#clean()
2222

2323
let g:scratch_buffer_tmp_file_pattern = get(g:, 'scratch_buffer_tmp_file_pattern', '/tmp/vim-scratch-buffer-%d')
24+
let g:scratch_buffer_default_file_ext = get(g:, 'scratch_buffer_default_file_ext', 'md')
25+
let g:scratch_buffer_default_open_method = get(g:, 'scratch_buffer_default_open_method', 'sp')
26+
let g:scratch_buffer_default_buffer_size = get(g:, 'scratch_buffer_default_buffer_size', 15)
2427
let g:scratch_buffer_auto_save_file_buffer = get(g:, 'scratch_buffer_auto_save_file_buffer', v:true)
2528
let g:scratch_buffer_use_default_keymappings = get(g:, 'scratch_buffer_use_default_keymappings', v:false)
2629

0 commit comments

Comments
 (0)