Repository navigation
Expand file tree
/
Copy pathstarter.lua
More file actions
1324 lines (1168 loc) · 45.2 KB
/
Copy pathstarter.lua
File metadata and controls
1324 lines (1168 loc) · 45.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
-- MIT License Copyright (c) 2021 Evgeni Chasnovski
---@brief [[
--- Lua module for minimal, fast, and flexible start screen. Displayed items
--- are fully customizable both in terms of what they do and how they look
--- (with reasonable defaults). Item selection can be done using prefix query
--- with instant visual feedback.This is mostly inspired by
--- [mhinz/vim-startify](https://github.com/mhinz/vim-startify).
---
--- Key design ideas:
--- - All available actions are defined inside items. Each item should have the
--- following info:
--- - `action` - function or string for |vim.cmd| which is executed when
--- item is chosen. Empty string result in placeholder "inactive" item.
--- - `name` - string which will be displayed and used for choosing.
--- - `section` - string representing to which section item belongs.
--- There are pre-configured whole sections in |MiniStarter.sections|.
--- - Configure what items are displayed by supplying an array which can be
--- normalized to an array of items. Read about how supplied items are
--- normalized in |MiniStarter.refresh|.
--- - Modify the final look by supplying content hooks: functions which take
--- buffer content as input (see |MiniStarter.content| for more information)
--- and return buffer content as output. There are pre-configured content
--- hook generators in |MiniStarter.gen_hook|.
--- - Choosing an item can be done in two ways:
--- - Type prefix query to filter item by matching its name (ignoring
--- case). Displayed information is updated after every typed character.
--- For every item its unique prefix is highlighted.
--- - Use Up/Down arrows and hit Enter.
---
--- What is doesn't do:
--- - It doesn't support fuzzy query for items. And probably will never do.
---
--- # Setup
---
--- This module needs a setup with `require('mini.starter').setup({})`
--- (replace `{}` with your `config` table). It will create global Lua table
--- `MiniStarter` which you can use for scripting or manually (with
--- `:lua MiniStarter.*`).
---
--- Default `config`:
--- <code>
--- {
--- -- Whether to open starter buffer on VimEnter. Not opened if Neovim was
--- -- started with intent to show something else.
--- autoopen = true,
---
--- -- Whether to evaluate action of single active item
--- evaluate_single = false,
---
--- -- Items to be displayed. Should be an array with the following elements:
--- -- - Item: table with `action`, `name`, and `section` keys.
--- -- - Function: should return one of these three categories.
--- -- - Array: elements of these three types (i.e. item, array, function).
--- -- If `nil`, default items will be used (see |mini.starter|).
--- items = nil,
---
--- -- Header to be displayed before items. Should be a string or function
--- -- evaluating to single string (use `\n` for new lines). If `nil` (default),
--- -- polite greeting will be used.
--- header = nil,
---
--- -- Footer to be displayed after items. Should be a string or function
--- -- evaluating to string. If `nil`, default usage instructions will be used.
--- footer = nil,
---
--- -- Array of functions to be applied consecutively to initial content. Each
--- -- function should take and return content for "Starter" buffer (see
--- -- |mini.starter| for more details).
--- content_hooks = nil,
---
--- -- Characters to update query. Each character will have special buffer
--- -- mapping overriding your global ones. Be careful to not add `:` as it
--- -- allows you to go into command mode.
--- query_updaters = [[abcdefghijklmnopqrstuvwxyz0123456789_-.]],
--- }
--- </code>
--- # Lifecycle of Starter buffer
---
--- - Open with |MiniStarter.open()|. It includes creating buffer with
--- appropriate options, mappings, behavior; call to |MiniStarter.refresh()|;
--- issue `MiniStarterOpened` |User| event.
--- - Wait for user to choose an item. This is done using following logic:
--- - Typing any character from `MiniStarter.config.query_updaters` leads
--- to updating query. Read more in |MiniStarter.add_to_query|.
--- - <BS> deletes latest character from query.
--- - <Down>/<Up> and <M-j>/<M-k> move current item.
--- - <CR> executes action of current item.
--- - <C-c> closes Starter buffer.
--- - Evaluate current item when appropriate (after `<CR>` or when there is a
--- single item and `MiniStarter.config.evaluate_single` is `true`). This
--- executes item's `action`.
---
--- # Example configurations
---
--- Configuration similar to 'mhinz/vim-startify':
--- <code>
--- local starter = require('mini.starter')
--- starter.setup({
--- evaluate_single = true,
--- items = {
--- starter.sections.builtin_actions(),
--- starter.sections.recent_files(10, false),
--- starter.sections.recent_files(10, true),
--- -- Use this if you set up 'mini.sessions'
--- starter.sections.sessions(5, true)
--- },
--- content_hooks = {
--- starter.gen_hook.adding_bullet(),
--- starter.gen_hook.indexing('all', { 'Builtin actions' }),
--- starter.gen_hook.padding(3, 2),
--- },
--- })
--- </code>
--- Configuration similar to 'glepnir/dashboard-nvim':
--- <code>
--- local starter = require('mini.starter')
--- starter.setup({
--- items = {
--- starter.sections.telescope(),
--- },
--- content_hooks = {
--- starter.gen_hook.adding_bullet(),
--- starter.gen_hook.aligning('center', 'center'),
--- },
--- })
--- </code>
--- Elaborated configuration showing capabilities of custom items,
--- header/footer, and content hooks:
--- <code>
--- local my_items = {
--- { name = 'Echo random number', action = [[lua print(math.random())]], section = 'Section 1' },
--- function()
--- return {
--- { name = 'Item #1 from function', action = [[echo 'Item #1']], section = 'From function' },
--- { name = 'Placeholder (always incative) item', action = '', section = 'From function' },
--- function()
--- return {
--- name = 'Item #1 from double function',
--- action = [[echo 'Double function']],
--- section = 'From double function',
--- }
--- end,
--- }
--- end,
--- { name = [[Another item in 'Section 1']], action = [[lua print(math.random() + 10)]], section = 'Section 1' },
--- }
---
--- local footer_n_seconds = (function()
--- local timer = vim.loop.new_timer()
--- local n_seconds = 0
--- timer:start(0, 1000, vim.schedule_wrap(function()
--- if vim.api.nvim_buf_get_option(0, 'filetype') ~= 'starter' then
--- timer:stop()
--- return
--- end
--- n_seconds = n_seconds + 1
--- MiniStarter.refresh()
--- end))
---
--- return function()
--- return 'Number of seconds since opening: ' .. n_seconds
--- end
--- end)()
---
--- local hook_top_pad_10 = function(content)
--- -- Pad from top
--- for _ = 1, 10 do
--- -- Insert at start a line with single content unit
--- table.insert(content, 1, { { type = 'empty', string = '' } })
--- end
--- return content
--- end
---
--- local starter = require('mini.starter')
--- starter.setup({
--- items = my_items,
--- footer = footer_n_seconds,
--- content_hooks = { hook_top_pad_10 },
--- })
--- </code>
---
--- # Definition of buffer content
---
--- Generally, buffer content is a table in the form of "2d array" (or rather
--- "2d list" because number of elements can differ):
--- - Each element represents content line: an array with content units to be
--- displayed in one buffer line.
--- - Each content unit is a table with at least the following elements:
--- - "type" - string with type of content. Something like "item",
--- "section", "header", "footer", "empty", etc.
--- - "string" - which string should be displayed. May be an empty string.
--- - "hl" - which highlighting should be applied to content string. May be
--- `nil` for no highlighting.
---
--- See |MiniStarter.content_to_lines| for converting content to buffer lines
--- and |MiniStarter.content_to_items| - to list of parsed items.
---
--- Notes:
--- - Content units with type "item" also have `item` element with all
--- information about an item it represents. Those elements are used directly
--- to create an array of items used for query.
---
--- # Highlight groups
---
--- - `MiniStarterCurrent` - current item.
--- - `MiniStarterFooter` - footer units.
--- - `MiniStarterHeader` - header units.
--- - `MiniStarterInactive` - inactive item.
--- - `MiniStarterItem` - item name.
--- - `MiniStarterItemBullet` - units from |MiniStarter.gen_hook.adding_bullet|.
--- - `MiniStarterItemPrefix` - unique query for item.
--- - `MiniStarterSection` - section units.
--- - `MiniStarterQuery` - current query in active items.
---
--- # Disabling
---
--- To disable core functionality, set `g:ministarter_disable` (globally) or
--- `b:ministarter_disable` (for a buffer) to `v:true`.
---@brief ]]
---@tag MiniStarter mini.starter
-- Module and its helper --
local MiniStarter = {}
local H = {}
--- Module setup
---
---@param config table: Module config table.
---@usage `require('mini.starter').setup({})` (replace `{}` with your `config` table)
function MiniStarter.setup(config)
-- Export module
_G.MiniStarter = MiniStarter
-- Setup config
config = H.setup_config(config)
-- Apply config
H.apply_config(config)
-- Module behavior
vim.api.nvim_exec(
[[augroup MiniStarter
au!
au VimEnter * ++nested ++once lua MiniStarter.on_vimenter()
augroup END]],
false
)
-- Create highlighting
vim.api.nvim_exec(
[[hi default link MiniStarterCurrent NONE
hi default link MiniStarterFooter Title
hi default link MiniStarterHeader Title
hi default link MiniStarterInactive Comment
hi default link MiniStarterItem Normal
hi default link MiniStarterItemBullet Delimiter
hi default link MiniStarterItemPrefix WarningMsg
hi default link MiniStarterSection Delimiter
hi default link MiniStarterQuery MoreMsg]],
false
)
end
-- Module config --
MiniStarter.config = {
-- Whether to open starter buffer on VimEnter. Not opened if Neovim was
-- started with intent to show something else.
autoopen = true,
-- Whether to evaluate action of single active item
evaluate_single = false,
-- Items to be displayed. Should be an array with the following elements:
-- - Item: table with `action`, `name`, and `section` keys.
-- - Function: should return one of these three categories.
-- - Array: elements of these three types (i.e. item, array, function).
-- If `nil` (default), default items will be used (see |mini.starter|).
items = nil,
-- Header to be displayed before items. Should be a string or function
-- evaluating to string.
header = nil,
-- Footer to be displayed after items. Should be a string or function
-- evaluating to string.
footer = nil,
-- Array of functions to be applied consecutively to initial content. Each
-- function should take and return content for 'Starter' buffer (see
-- |mini.starter| for more details).
content_hooks = nil,
-- Characters to update query. Each character will have special buffer
-- mapping overriding your global ones. Be careful to not add `:` as it
-- allows you to go into command mode.
query_updaters = [[abcdefghijklmnopqrstuvwxyz0123456789_-.]],
}
-- Module data --
---@class MiniStarter.content@ Final content of Starter buffer. For more information see "Definition of buffer content" section in |mini.starter|.
MiniStarter.content = {}
-- Module functionality --
--- Act on |VimEnter|.
function MiniStarter.on_vimenter()
-- It is assumed that something is shown if there is something in 'current'
-- buffer or if at least one file was supplied on startup
local is_something_shown = vim.fn.line2byte('$') > 0 or vim.fn.argc() > 0
if MiniStarter.config.autoopen and not is_something_shown then
MiniStarter.open()
end
end
--- Open Starter buffer
---
--- - Create and move into buffer.
--- - Set buffer options. Note that settings are done with |noautocmd| to
--- achieve a massive speedup.
--- - Set buffer mappings. Besides basic mappings (described inside "Lifecycle
--- of Starter buffer" of |mini.starter|), map every character from
--- `MiniStarter.config.query_updaters` to add itself to query with
--- |MiniStarter.add_to_query|.
--- - Populate buffer with |MiniStarter.refresh|.
--- - Issue custom `MiniStarterOpened` event to allow acting upon opening
--- Starter buffer. Use it with
--- `autocmd User MiniStarterOpened <your command>`.
function MiniStarter.open()
if H.is_disabled() then
return
end
-- Reset helper data
H.current_item_id = 1
H.query = ''
-- Create and open buffer
H.buf_id = vim.api.nvim_create_buf(false, true)
vim.api.nvim_set_current_buf(H.buf_id)
-- Setup buffer behavior
H.apply_buffer_options()
H.apply_buffer_mappings()
vim.cmd([[au VimResized <buffer> lua MiniStarter.refresh()]])
vim.cmd([[au CursorMoved <buffer> lua MiniStarter.on_cursormoved()]])
vim.cmd([[au BufLeave <buffer> echo '']])
-- Populate buffer
MiniStarter.refresh()
-- Issue custom event
vim.cmd([[doautocmd User MiniStarterOpened]])
end
--- Refresh Starter buffer
---
--- - Normalize `MiniStarter.config.items`:
--- - Flatten: recursively (in depth-first fashion) parse its elements. If
--- function is found, execute it and continue with parsing its output
--- (this allows deferring item collection up until it is actually
--- needed). If proper item is found (table with fields `action`,
--- `name`, `section`), add it to output.
--- - Sort: order first by section and then by item id (both in order of
--- appearance).
--- - Normalize `MiniStarter.config.header` and `MiniStarter.config.footer` to
--- be a table of strings (per line). If function - evaluate it first.
--- - Make initial buffer content (see |MiniStarter.content| for a description
--- of what a buffer content is). It consist from content lines with single
--- content unit:
--- - First lines contain strings of normalized header.
--- - Body is for normalized items. Section names have own lines preceded
--- by empty line.
--- - Last lines contain separate strings of normalized footer.
--- - Sequentially apply hooks from `MiniStarter.config.content_hooks` to
--- content. Output of one hook serves as input to the next.
--- - Gather final items from content with |MiniStarter.content_to_items|.
--- - Convert content to buffer lines with |MiniStarter.content_to_lines| and
--- add them to buffer.
--- - Add highlighting of content units.
--- - Position cursor.
--- - Make current query. This results into some items being marked as
--- "inactive" and updating highlighting of current query on "active" items.
---
--- Note: this function is executed on every |VimResized| to allow more
--- responsive behavior.
function MiniStarter.refresh()
if H.is_disabled() or H.buf_id == nil or not vim.api.nvim_buf_is_valid(H.buf_id) then
return
end
-- Normalize certain config values
local items = H.normalize_items(MiniStarter.config.items or H.default_items)
H.header = H.normalize_header_footer(MiniStarter.config.header or H.default_header, 'header')
H.footer = H.normalize_header_footer(MiniStarter.config.footer or H.default_footer, 'footer')
-- Evaluate content
H.make_initial_content(items)
local hooks = MiniStarter.config.content_hooks or H.default_content_hooks
for _, f in ipairs(hooks) do
MiniStarter.content = f(MiniStarter.content)
end
H.items = MiniStarter.content_to_items()
-- Add content
vim.api.nvim_buf_set_option(H.buf_id, 'modifiable', true)
vim.api.nvim_buf_set_lines(H.buf_id, 0, -1, false, MiniStarter.content_to_lines())
vim.api.nvim_buf_set_option(H.buf_id, 'modifiable', false)
-- Add highlighting
H.content_highlight()
H.items_highlight()
-- -- Always position cursor on current item
H.position_cursor_on_current_item()
H.add_hl_current_item()
-- Apply current query (clear command line afterwards)
H.make_query()
end
--- Close Starter buffer
function MiniStarter.close()
vim.api.nvim_buf_delete(H.buf_id, {})
H.buf_id = nil
end
-- Sections --
---@class MiniStarter.sections@Table of pre-configured sections
MiniStarter.sections = {}
--- Section with builtin actions
---
---@return table: Array of items.
function MiniStarter.sections.builtin_actions()
return {
{ name = 'Edit new buffer', action = 'enew', section = 'Builtin actions' },
{ name = 'Quit Neovim', action = 'qall', section = 'Builtin actions' },
}
end
--- Section with |MiniSessions| sessions
---
--- Sessions are taken from |MiniSessions.detected|. Notes:
--- - If it shows "'mini.sessions' is not set up", it means that you didn't
--- call `require('mini.sessions').setup()`.
--- - If it shows "There are no detected sessions in 'mini.sessions'", it means
--- that there are no sessions at the current sessions directory. Either
--- create session or supply different directory where session files are
--- stored (see |MiniSessions.setup|).
--- - Local session (if detected) is always displayed first.
---
---@param n number: Number of returned items. Default: 5.
---@param recent boolean: Whether to use recent sessions (instead of alphabetically by name). Default: true.
---@return function: Function which returns array of items.
function MiniStarter.sections.sessions(n, recent)
n = n or 5
recent = recent == nil and true or recent
return function()
if _G.MiniSessions == nil then
return { { name = [['mini.sessions' is not set up]], action = '', section = 'Sessions' } }
end
local items = {}
for session_name, session in pairs(_G.MiniSessions.detected) do
table.insert(items, {
_session = session,
name = ('%s%s'):format(session_name, session.type == 'local' and ' (local)' or ''),
action = ([[lua _G.MiniSessions.read('%s')]]):format(session_name),
section = 'Sessions',
})
end
if vim.tbl_count(items) == 0 then
return { { name = [[There are no detected sessions in 'mini.sessions']], action = '', section = 'Sessions' } }
end
local sort_fun
if recent then
sort_fun = function(a, b)
local a_time = a._session.type == 'local' and math.huge or a._session.modify_time
local b_time = b._session.type == 'local' and math.huge or b._session.modify_time
return a_time > b_time
end
else
sort_fun = function(a, b)
local a_name = a._session.type == 'local' and '' or a.name
local b_name = b._session.type == 'local' and '' or b.name
return a_name < b_name
end
end
table.sort(items, sort_fun)
-- Take only first `n` elements and remove helper fields
return vim.tbl_map(function(x)
x._session = nil
return x
end, vim.list_slice(items, 1, n))
end
end
--- Section with most recently used files
---
--- Files are taken from |vim.v.oldfiles|.
---
---@param n number: Number of returned items. Default: 5.
---@param current_dir boolean: Whether to return files only from current working directory. Default: false.
---@param show_path boolean: Whether to append file name with its full path. Default: true.
---@return function: Function which returns array of items.
function MiniStarter.sections.recent_files(n, current_dir, show_path)
n = n or 5
current_dir = current_dir == nil and false or current_dir
show_path = show_path == nil and true or show_path
if current_dir then
vim.cmd([[au DirChanged * lua MiniStarter.refresh()]])
end
return function()
local section = ('Recent files%s'):format(current_dir and ' (current directory)' or '')
-- Use only actual readable files
local files = vim.tbl_filter(function(f)
return vim.fn.filereadable(f) == 1
end, vim.v.oldfiles or {})
if #files == 0 then
return { { name = [[There are no recent files (`v:oldfiles` is empty)]], action = '', section = section } }
end
-- Possibly filter files from current directory
if current_dir then
local cwd = vim.loop.cwd()
local n_cwd = cwd:len()
files = vim.tbl_filter(function(f)
return f:sub(1, n_cwd) == cwd
end, files)
end
if #files == 0 then
return { { name = [[There are no recent files in current directory]], action = '', section = section } }
end
-- Create items
local items = {}
local fmodify = vim.fn.fnamemodify
for _, f in ipairs(vim.list_slice(files, 1, n)) do
local path = show_path and (' (%s)'):format(fmodify(f, ':~:.')) or ''
local name = ('%s%s'):format(fmodify(f, ':t'), path)
table.insert(items, { action = ('edit %s'):format(fmodify(f, ':p')), name = name, section = section })
end
return items
end
end
-- stylua: ignore start
--- Section with basic Telescope pickers relevant to start screen
---
---@return function: Function which returns array of items.
function MiniStarter.sections.telescope()
return function()
return {
{action = 'Telescope file_browser', name = 'Browser', section = 'Telescope'},
{action = 'Telescope command_history', name = 'Command history', section = 'Telescope'},
{action = 'Telescope find_files', name = 'Files', section = 'Telescope'},
{action = 'Telescope help_tags', name = 'Help tags', section = 'Telescope'},
{action = 'Telescope live_grep', name = 'Live grep', section = 'Telescope'},
{action = 'Telescope oldfiles', name = 'Old files', section = 'Telescope'},
}
end
end
-- stylua: ignore end
-- Content hooks --
---@class MiniStarter.gen_hook@Table with pre-configured content hook generators. Each element is a function which returns content hook. So to use them inside |MiniStarter.setup|, call them.
MiniStarter.gen_hook = {}
--- Hook generator for padding
---
--- Output is a content hook which adds constant padding from left and top.
--- This allows tweaking the screen position of buffer content.
---
---@param left number: Number of empty spaces to add to start of each content line. Default: 0.
---@param top number: Number of empty lines to add to start of content. Default: 0.
---@return function: Content hook.
function MiniStarter.gen_hook.padding(left, top)
left = math.max(left or 0, 0)
top = math.max(top or 0, 0)
return function(content)
-- Add left padding
local left_pad = string.rep(' ', left)
for _, line in ipairs(content) do
table.insert(line, 1, H.content_unit(left_pad, 'empty', nil))
end
-- Add top padding
local top_lines = {}
for _ = 1, top do
table.insert(top_lines, { H.content_unit('', 'empty', nil) })
end
content = vim.list_extend(top_lines, content)
return content
end
end
--- Hook generator for adding bullet to items
---
--- Output is a content hook which adds supplied string to be displayed to the
--- left of item.
---
---@param bullet string: String to be placed to the left of item name. Default: "░ ".
---@param place_cursor boolean: Whether to place cursor on the first character of bullet when corresponding item becomes current. Default: true.
---@return function: Content hook.
function MiniStarter.gen_hook.adding_bullet(bullet, place_cursor)
bullet = bullet or '░ '
place_cursor = place_cursor == nil and true or place_cursor
return function(content)
local coords = MiniStarter.content_coords(content, 'item')
-- Go backwards to avoid conflict when inserting units
for i = #coords, 1, -1 do
local l_num, u_num = coords[i].line, coords[i].unit
local bullet_unit = {
string = bullet,
type = 'item_bullet',
hl = 'MiniStarterItemBullet',
-- Use `_item` instead of `item` because it is better to be 'private'
_item = content[l_num][u_num].item,
_place_cursor = place_cursor,
}
table.insert(content[l_num], u_num, bullet_unit)
end
return content
end
end
--- Hook generator for indexing items
---
--- Output is a content hook which adds unique index to the start of item's
--- name. It results into shortening queries required to choose an item (at
--- expense of clarity).
---
---@param grouping string: One of "all" (number indexing across all sections) or "section" (letter-number indexing within each section). Default: "all".
---@param exclude_sections table: Array of section names (values of `section` element of item) for which index won't be added. Default: `{}`.
---@return function: Content hook.
function MiniStarter.gen_hook.indexing(grouping, exclude_sections)
grouping = grouping or 'all'
exclude_sections = exclude_sections or {}
local per_section = grouping == 'section'
return function(content)
local cur_section, n_section, n_item = nil, 0, 0
local coords = MiniStarter.content_coords(content, 'item')
for _, c in ipairs(coords) do
local unit = content[c.line][c.unit]
local item = unit.item
if not vim.tbl_contains(exclude_sections, item.section) then
n_item = n_item + 1
if cur_section ~= item.section then
cur_section = item.section
-- Cycle through lower case letters
n_section = math.fmod(n_section, 26) + 1
n_item = per_section and 1 or n_item
end
local section_index = per_section and string.char(96 + n_section) or ''
unit.string = ('%s%s. %s'):format(section_index, n_item, unit.string)
end
end
return content
end
end
--- Hook generator for aligning content
---
--- Output is a content hook which independently aligns content horizontally
--- and vertically. Basically, this computes left and top pads for
--- |MiniStarter.gen_hook.padding| such that output lines would appear aligned
--- in certain way.
---
---@param horizontal string: One of "left", "center", "right". Default: "left".
---@param vertical string: One of "top", "center", "bottom". Default: "top".
---@return function: Content hook.
function MiniStarter.gen_hook.aligning(horizontal, vertical)
horizontal = horizontal == nil and 'left' or horizontal
vertical = vertical == nil and 'top' or vertical
local horiz_coef = ({ left = 0, center = 0.5, right = 1.0 })[horizontal]
local vert_coef = ({ top = 0, center = 0.5, bottom = 1.0 })[vertical]
return function(content)
local line_strings = MiniStarter.content_to_lines(content)
-- Align horizontally
-- Don't use `string.len()` to account for multibyte characters
local lines_width = vim.tbl_map(function(l)
return vim.fn.strdisplaywidth(l)
end, line_strings)
local min_right_space = vim.fn.winwidth(0) - math.max(unpack(lines_width))
local left_pad = math.max(math.floor(horiz_coef * min_right_space), 0)
-- Align vertically
local bottom_space = vim.fn.winheight(0) - #line_strings
local top_pad = math.max(math.floor(vert_coef * bottom_space), 0)
return MiniStarter.gen_hook.padding(left_pad, top_pad)(content)
end
end
-- Work with content --
--- Helper to iterate through content
---
--- Basically, this traverses content "2d array" (in depth-first fashion; top
--- to bottom, left to right) and returns "coordinates" of units for which
--- `predicate` is true-ish.
---
---@param content table: Content "2d array".
---@param predicate function|string: Predictate to filter units. If function, evaluated with unit as input. If string, checks unit to have this type (allows easy getting of units with some type). If `nil`, all units are kept.
---@return table: Array of resulting units' coordinates. Each coordinate is a table with `line` and `unit` keys. To retrieve actual unit from coordinate `c`, use `content[c.line][c.unit]`.
function MiniStarter.content_coords(content, predicate)
content = content or MiniStarter.content
if type(predicate) == 'string' then
local pred_type = predicate
predicate = function(unit)
return unit.type == pred_type
end
end
local res = {}
for l_num, line in ipairs(content) do
for u_num, unit in ipairs(line) do
if predicate == nil or predicate(unit) then
table.insert(res, { line = l_num, unit = u_num })
end
end
end
return res
end
-- stylua: ignore start
--- Convert content to buffer lines
---
--- One buffer line is made by concatenating `string` element of units within
--- same content line.
---
---@param content table: Content "2d array".
---@return table: Array of strings for each buffer line.
function MiniStarter.content_to_lines(content)
return vim.tbl_map(
function(content_line)
return table.concat(
-- Ensure that each content line is indeed a single buffer line
vim.tbl_map(function(x) return x.string:gsub('\n', ' ') end, content_line), ''
)
end,
content or MiniStarter.content
)
end
-- stylua: ignore end
--- Convert content to items
---
--- Parse content (in depth-first fashion) and retrieve each item from `item`
--- element of content units with type "item". This also:
--- - Computes some helper information about how item will be actually
--- displayed (after |MiniStarter.content_to_lines|) and minimum number of
--- prefix characters needed for a particular item to be queried single.
--- - Modifies item's `name` element taking it from corresponing `string`
--- element of content unit. This allows modifying item's `name` at the stage
--- of content hooks (like, for example, in |MiniStarter.gen_hook.indexing|).
---
---@param content table: Content "2d array".
---@return table: Array of items.
function MiniStarter.content_to_items(content)
content = content or MiniStarter.content
-- NOTE: this havily utilizes 'modify by reference' nature of Lua tables
local items = {}
for l_num, line in ipairs(content) do
-- Track 0-based starting column of current unit (using byte length)
local start_col = 0
for _, unit in ipairs(line) do
-- Cursor position is (1, 0)-based
local cursorpos = { l_num, start_col }
if unit.type == 'item' then
local item = unit.item
-- Take item's name from content string
item.name = unit.string:gsub('\n', ' ')
item._line = l_num - 1
item._start_col = start_col
item._end_col = start_col + unit.string:len()
-- Don't overwrite possible cursor position from item's bullet
item._cursorpos = item._cursorpos or cursorpos
table.insert(items, item)
end
-- Prefer placing cursor at start of item's bullet
if unit.type == 'item_bullet' and unit._place_cursor then
-- Item bullet uses 'private' `_item` element instead of `item`
unit._item._cursorpos = cursorpos
end
start_col = start_col + unit.string:len()
end
end
-- Compute length of unique prefix for every item's name (ignoring case)
local strings = vim.tbl_map(function(x)
return x.name:lower()
end, items)
local nprefix = H.unique_nprefix(strings)
for i, n in ipairs(nprefix) do
items[i]._nprefix = n
end
return items
end
-- Other exported functions --
--- Evaluate current item
function MiniStarter.eval_current_item()
H.eval_fun_or_string(H.items[H.current_item_id].action, true)
end
--- Update current item
---
--- This makes next (with respect to `direction`) active item to be current.
---
---@param direction string: One of "next" or "previous".
function MiniStarter.update_current_item(direction)
-- Advance current item
local prev_current = H.current_item_id
H.current_item_id = H.next_active_item_id(H.current_item_id, direction)
if H.current_item_id == prev_current then
return
end
-- Update cursor position
H.position_cursor_on_current_item()
-- Highlight current item
vim.api.nvim_buf_clear_namespace(H.buf_id, H.ns.current_item, 0, -1)
H.add_hl_current_item()
end
--- Add character to current query
---
--- - Update current query by appending `char` to its end or delete latest
--- character if `char` is `nil`.
--- - Recompute status of items: "active" if its name starts with new query,
--- "inactive" otherwise.
--- - Update highlighting: whole strings for "inactive" items, current query
--- for "active" items.
---
---@param char string: Single character to be added to query. If `nil`, deletes latest character from query.
function MiniStarter.add_to_query(char)
if char == nil then
H.query = H.query:sub(0, H.query:len() - 1)
else
H.query = ('%s%s'):format(H.query, char)
end
H.make_query()
end
--- Act on |CursorMoved| by repositioning cursor in fixed place.
function MiniStarter.on_cursormoved()
H.position_cursor_on_current_item()
end
-- Helper data --
-- Module default config
H.default_config = MiniStarter.config
-- Default config values
H.default_items = {
function()
if _G.MiniSessions == nil then
return {}
end
return MiniStarter.sections.sessions(5, true)()
end,
MiniStarter.sections.recent_files(5, false, false),
MiniStarter.sections.builtin_actions(),
}
H.default_header = function()
local hour = tonumber(vim.fn.strftime('%H'))
-- [04:00, 12:00) - morning, [12:00, 20:00) - day, [20:00, 04:00) - evening
local part_id = math.floor((hour + 4) / 8) + 1
local day_part = ({ 'evening', 'morning', 'afternoon', 'evening' })[part_id]
local username = vim.fn.getenv('USERNAME') or 'USERNAME'
return ('Good %s, %s'):format(day_part, username)
end
H.default_footer = [[
Type query to filter items
<BS> deletes latest character from query
<Down>/<Up> and <M-j>/<M-k> move current item
<CR> executes action of current item
<C-c> closes this buffer]]
H.default_content_hooks = { MiniStarter.gen_hook.adding_bullet(), MiniStarter.gen_hook.aligning('center', 'center') }
-- Normalized values from config
H.items = {} -- items gathered with `MiniStarter.content_to_items` from final content
H.header = {} -- table of strings
H.footer = {} -- table of strings
-- Identifier of current item
H.current_item_id = nil
-- Buffer identifier where everything is displayed
H.buf_id = nil
-- Namespaces for highlighting
H.ns = {
activity = vim.api.nvim_create_namespace(''),
current_item = vim.api.nvim_create_namespace(''),
general = vim.api.nvim_create_namespace(''),
}
-- Current search query
H.query = ''
-- Settings --
function H.setup_config(config)
-- General idea: if some table elements are not present in user-supplied
-- `config`, take them from default config
vim.validate({ config = { config, 'table', true } })
config = vim.tbl_deep_extend('force', H.default_config, config or {})
vim.validate({
autoopen = { config.autoopen, 'boolean' },
evaluate_single = { config.evaluate_single, 'boolean' },
items = { config.items, 'table', true },
header = { config.header, H.is_fun_or_string, 'function or string' },
footer = { config.footer, H.is_fun_or_string, 'function or string' },
content_hooks = { config.content_hooks, 'table', true },
query_updaters = { config.query_updaters, 'string' },
})
return config
end
function H.apply_config(config)
MiniStarter.config = config
end
function H.is_disabled()
return vim.g.ministarter_disable == true or vim.b.ministarter_disable == true
end
-- Normalize config elements --
function H.normalize_items(items)
local res = H.items_flatten(items)
if #res == 0 then
return { { name = '`MiniStarter.config.items` is empty', action = '', section = '' } }
end
return H.items_sort(res)
end
function H.normalize_header_footer(x, x_name)
local res = H.eval_fun_or_string(x)
if type(res) ~= 'string' then
H.notify(('`config.%s` should be evaluated into string.'):format(x_name))
return {}
end
if res == '' then
return {}
end
return vim.split(res, '\n')
end
-- Work with buffer content --
function H.make_initial_content(items)
MiniStarter.content = {}
-- Add header lines
for _, l in ipairs(H.header) do
H.content_add_line({ H.content_unit(l, 'header', 'MiniStarterHeader') })
end
H.content_add_empty_lines(#H.header > 0 and 1 or 0)
-- Add item lines
H.content_add_items(items)
-- Add footer lines
H.content_add_empty_lines(#H.footer > 0 and 1 or 0)
for _, l in ipairs(H.footer) do