Repository navigation
Expand file tree
/
Copy pathdoc.lua
More file actions
1313 lines (1143 loc) · 50.1 KB
/
Copy pathdoc.lua
File metadata and controls
1313 lines (1143 loc) · 50.1 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) 2022 Evgeni Chasnovski
-- Documentation ==============================================================
--- Generation of help files from EmmyLua-like annotations
---
--- Key design ideas:
--- - Keep documentation next to code by writing EmmyLua-like annotation
--- comments. They will be parsed as is, so formatting should follow built-in
--- guide in |help-writing|. However, custom hooks are allowed at many
--- generation stages for more granular management of output help file.
--- - Generation is done by processing a set of ordered files line by line.
--- Each line can either be considered as a part of documentation block (if
--- it matches certain configurable pattern) or not (considered to be an
--- "afterline" of documentation block). See |MiniDoc.generate()| for more
--- details.
--- - Processing is done by using nested data structures (section, block, file,
--- doc) describing certain parts of help file. See |MiniDoc-data-structures|
--- for more details.
--- - Project specific script can be written as plain Lua file with
--- configuratble path. See |MiniDoc.generate()| for more details.
---
--- What it doesn't do:
--- - It doesn't support markdown or other markup language inside annotations.
--- - It doesn't use treesitter in favor of Lua string manipulation for basic
--- tasks (parsing annotations, formatting, auto-generating tags, etc.). This
--- is done to manage complexity and be dependency free.
---
--- # Setup~
---
--- This module needs a setup with `require('mini.doc').setup({})` (replace
--- `{}` with your `config` table). It will create global Lua table `MiniDoc`
--- which you can use for scripting or manually (with `:lua MiniDoc.*`).
---
--- See |MiniDoc.config| for available config settings.
---
--- You can override runtime config settings locally to buffer inside
--- `vim.b.minidoc_config` which should have same structure as `MiniDoc.config`.
--- See |mini.nvim-buffer-local-config| for more details.
---
--- # Tips~
---
--- - Some settings tips that might make writing annotation comments easier:
--- - Set up appropriate 'comments' for `lua` file type to respect
--- EmmyLua-like's `---` comment leader. Value `:---,:--` seems to work.
--- - Set up appropriate 'formatoptions' (see also |fo-table|). Consider
--- adding `j`, `n`, `q`, and `r` flags.
--- - Set up appropriate 'formatlistpat' to help auto-formatting lists (if
--- `n` flag is added to 'formatoptions'). One suggestion (not entirely
--- ideal) is a value `^\s*[0-9\-\+\*]\+[\.\)]*\s\+`. This reads as 'at
--- least one special character (digit, `-`, `+`, `*`) possibly followed
--- by some punctuation (`.` or `)`) followed by at least one space is a
--- start of list item'.
--- - Probably one of the most reliable resources for what is considered to be
--- best practice when using this module is this whole plugin. Look at source
--- code for the reference.
---
--- # Comparisons~
---
--- - 'tjdevries/tree-sitter-lua':
--- - Its key design is to use treesitter grammar to parse both Lua code
--- and annotation comments. This makes it not easy to install,
--- customize, and support.
--- - It takes more care about automating output formatting (like auto
--- indentation and line width fit). This plugin leans more to manual
--- formatting with option to supply customized post-processing hooks.
---
--- # Disabling~
---
--- To disable, set `g:minidoc_disable` (globally) or `b:minidoc_disable` (for
--- a buffer) to `v:true`. Considering high number of different scenarios and
--- customization intentions, writing exact rules for disabling module's
--- functionality is left to user. See |mini.nvim-disabling-recipes| for common
--- recipes.
---@tag mini.doc
---@tag MiniDoc
--- Data structures
---
--- Data structures are basically arrays of other structures accompanied with
--- some fields (keys with data values) and methods (keys with function
--- values):
--- - `Section structure` is an array of string lines describing one aspect
--- (determined by section id like '@param', '@return', '@text') of an
--- annotation subject. All lines will be used directly in help file.
--- - `Block structure` is an array of sections describing one annotation
--- subject like function, table, concept.
--- - `File structure` is an array of blocks describing certain file on disk.
--- Basically, file is split into consecutive blocks: annotation lines go
--- inside block, non-annotation - inside `block_afterlines` element of info.
--- - `Doc structure` is an array of files describing a final help file. Each
--- string line from section (when traversed in depth-first fashion) goes
--- directly into output file.
---
--- All structures have these keys:
--- - Fields:
--- - `info` - contains additional information about current structure.
--- For more details see next section.
--- - `parent` - table of parent structure (if exists).
--- - `parent_index` - index of this structure in its parent's array. Useful
--- for adding to parent another structure near current one.
--- - `type` - string with structure type (section, block, file, doc).
--- - Methods (use them as `x:method(args)`):
--- - `insert(self, [index,] child)` - insert `child` to `self` at position
--- `index` (optional; if not supplied, child will be appended to end).
--- Basically, a `table.insert()`, but adds `parent` and `parent_index`
--- fields to `child` while properly updating `self`.
--- - `remove(self [,index])` - remove from `self` element at position
--- `index`. Basically, a `table.remove()`, but properly updates `self`.
--- - `has_descendant(self, predicate)` - whether there is a descendant
--- (structure or string) for which `predicate` returns `true`. In case of
--- success also returns the first such descendant as second value.
--- - `has_lines(self)` - whether structure has any lines (even empty ones)
--- to be put in output file. For section structures this is equivalent to
--- `#self`, but more useful for higher order structures.
--- - `clear_lines(self)` - remove all lines from structure. As a result,
--- this structure won't contribute to output help file.
---
--- Description of `info` fields per structure type:
--- - `Section`:
--- - `id` - captured section identifier. Can be empty string meaning no
--- identifier is captured.
--- - `line_begin` - line number inside file at which section begins (-1 if
--- not generated from file).
--- - `line_end` - line number inside file at which section ends (-1 if not
--- generated from file).
--- - `Block`:
--- - `afterlines` - array of strings which were parsed from file after
--- this annotation block (up until the next block or end of file).
--- Useful for making automated decisions about what is being documented.
--- - `line_begin` - line number inside file at which block begins (-1 if
--- not generated from file).
--- - `line_end` - line number inside file at which block ends (-1 if not
--- generated from file).
--- - `File`:
--- - `path` - absolute path to a file (`''` if not generated from file).
--- - `Doc`:
--- - `input` - array of input file paths (as in |MiniDoc.generate|).
--- - `output` - output path (as in |MiniDoc.generate|).
--- - `config` - configuration used (as in |MiniDoc.generate|).
---@tag MiniDoc-data-structures
-- Module definition ==========================================================
local MiniDoc = {}
local H = {}
--- Module setup
---
---@param config table|nil Module config table. See |MiniDoc.config|.
---
---@usage `require('mini.doc').setup({})` (replace `{}` with your `config` table)
MiniDoc.setup = function(config)
-- Export module
_G.MiniDoc = MiniDoc
-- Setup config
config = H.setup_config(config)
-- Apply config
H.apply_config(config)
end
--- Module config
---
--- Default values:
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
---@text # Notes ~
---
--- - `annotation_extractor` takes single string line as input. Output
--- describes what makes an input to be an annotation (if anything). It
--- should be similar to `string.find` with one capture group: start and end
--- of annotation indicator (whole part will be removed from help line) with
--- third value being string of section id (if input describes first line of
--- section; `nil` or empty string otherwise). Output should be `nil` if line
--- is not part of annotation.
--- Default value means that annotation line should:
--- - Start with `---` at first column.
--- - Any non-whitespace after `---` will be treated as new section id.
--- - Single whitespace at the start of main text will be ignored.
--- - Hooks are expected to be functions. Their default values might do many
--- things which might change over time, so for more information please look
--- at source code. Some more information can be found in
--- |MiniDoc.default_hooks|.
MiniDoc.config = {
-- Function which extracts part of line used to denote annotation.
-- For more information see 'Notes' in |MiniDoc.config|.
annotation_extractor = function(l) return string.find(l, '^%-%-%-(%S*) ?') end,
-- Identifier of block annotation lines until first captured identifier
default_section_id = '@text',
-- Hooks to be applied at certain stage of document life cycle. Should
-- modify its input in place (and not return new one).
hooks = {
-- Applied to block before anything else
--minidoc_replace_start block_pre = --<function: infers header sections (tag and/or signature)>,
block_pre = function(b)
-- Infer metadata based on afterlines
if b:has_lines() and #b.info.afterlines > 0 then H.infer_header(b) end
end,
--minidoc_replace_end
-- Applied to section before anything else
--minidoc_replace_start section_pre = --<function: replaces current aliases>,
section_pre = function(s) H.alias_replace(s) end,
--minidoc_replace_end
-- Applied if section has specified captured id
sections = {
--minidoc_replace_start ['@alias'] = --<function: registers alias in MiniDoc.current.aliases>,
['@alias'] = function(s)
H.alias_register(s)
-- NOTE: don't use `s.parent:remove(s.parent_index)` here because it
-- disrupts iteration over block's section during hook application
-- (skips next section).
s:clear_lines()
end,
--minidoc_replace_end
--minidoc_replace_start ['@class'] = --<function>,
['@class'] = function(s)
H.enclose_var_name(s)
H.add_section_heading(s, 'Class')
end,
--minidoc_replace_end
--minidoc_replace_start ['@diagnostic'] = --<function: ignores any section content>,
['@diagnostic'] = function(s) s:clear_lines() end,
--minidoc_replace_end
-- For most typical usage see |MiniDoc.afterlines_to_code|
--minidoc_replace_start ['@eval'] = --<function: evaluates lines; replaces with their return>,
['@eval'] = function(s)
local src = table.concat(s, '\n')
local is_loaded, code = pcall(function() return assert(loadstring(src)) end)
local output
if is_loaded then
MiniDoc.current.eval_section = s
output = code()
MiniDoc.current.eval_section = nil
else
output = 'MINIDOC ERROR. Parsing Lua code gave the following error:\n' .. code
end
s:clear_lines()
if output == nil then return end
if type(output) == 'string' then output = vim.split(output, '\n') end
if type(output) ~= 'table' then
s[1] = 'MINIDOC ERROR. Returned value should be `nil`, `string`, or `table`.'
return
end
for _, x in ipairs(output) do
s:insert(x)
end
end,
--minidoc_replace_end
--minidoc_replace_start ['@field'] = --<function>,
['@field'] = function(s)
H.mark_optional(s)
H.enclose_var_name(s)
H.enclose_type(s, '`%(%1%)`', s[1]:find('%s'))
end,
--minidoc_replace_end
--minidoc_replace_start ['@overload'] = --<function>,
['@overload'] = function(s)
H.enclose_type(s, '`%1`', 1)
H.add_section_heading(s, 'Overload')
end,
--minidoc_replace_end
--minidoc_replace_start ['@param'] = --<function>,
['@param'] = function(s)
H.mark_optional(s)
H.enclose_var_name(s)
H.enclose_type(s, '`%(%1%)`', s[1]:find('%s'))
end,
--minidoc_replace_end
--minidoc_replace_start ['@private'] = --<function: registers block for removal>,
['@private'] = function(s) s.parent:clear_lines() end,
--minidoc_replace_end
--minidoc_replace_start ['@return'] = --<function>,
['@return'] = function(s)
H.mark_optional(s)
H.enclose_type(s, '`%(%1%)`', 1)
H.add_section_heading(s, 'Return')
end,
--minidoc_replace_end
--minidoc_replace_start ['@seealso'] = --<function>,
['@seealso'] = function(s) H.add_section_heading(s, 'See also') end,
--minidoc_replace_end
--minidoc_replace_start ['@signature'] = --<function: formats signature of documented object>,
['@signature'] = function(s)
for i, _ in ipairs(s) do
-- Add extra formatting to make it stand out
s[i] = H.format_signature(s[i])
-- Align accounting for concealed characters
s[i] = H.align_text(s[i], 78, 'center')
end
end,
--minidoc_replace_end
--minidoc_replace_start ['@tag'] = --<function: turns its line in proper tag lines>,
['@tag'] = function(s)
for i, _ in ipairs(s) do
-- Enclose every word in `*`
s[i] = s[i]:gsub('(%S+)', '%*%1%*')
-- Align to right edge accounting for concealed characters
s[i] = H.align_text(s[i], 78, 'right')
end
end,
--minidoc_replace_end
--minidoc_replace_start ['@text'] = --<function: purposefully does nothing>,
['@text'] = function() end,
--minidoc_replace_end
--minidoc_replace_start ['@toc'] = --<function: clears all section lines>,
['@toc'] = function(s) s:clear_lines() end,
--minidoc_replace_end
--minidoc_replace_start ['@toc_entry'] = --<function: registers lines for table of contents>,
['@toc_entry'] = function(s) H.toc_register(s) end,
--minidoc_replace_end
--minidoc_replace_start ['@type'] = --<function>,
['@type'] = function(s)
H.enclose_type(s, '`%(%1%)`', 1)
H.add_section_heading(s, 'Type')
end,
--minidoc_replace_end
--minidoc_replace_start ['@usage'] = --<function>,
['@usage'] = function(s) H.add_section_heading(s, 'Usage') end,
--minidoc_replace_end
},
-- Applied to section after all previous steps
--minidoc_replace_start section_post = --<function: currently does nothing>,
section_post = function(s) end,
--minidoc_replace_end
-- Applied to block after all previous steps
--minidoc_replace_start block_post = --<function: does many things>,
block_post = function(b)
if not b:has_lines() then return end
local found_param, found_field = false, false
local n_tag_sections = 0
H.apply_recursively(function(x)
if not (type(x) == 'table' and x.type == 'section') then return end
-- Add headings before first occurence of a section which type usually
-- appear several times
if not found_param and x.info.id == '@param' then
H.add_section_heading(x, 'Parameters')
found_param = true
end
if not found_field and x.info.id == '@field' then
H.add_section_heading(x, 'Fields')
found_field = true
end
if x.info.id == '@tag' then
x.parent:remove(x.parent_index)
n_tag_sections = n_tag_sections + 1
x.parent:insert(n_tag_sections, x)
end
end, b)
b:insert(1, H.as_struct({ string.rep('-', 78) }, 'section'))
b:insert(H.as_struct({ '' }, 'section'))
end,
--minidoc_replace_end
-- Applied to file after all previous steps
--minidoc_replace_start file = --<function: adds separator>,
file = function(f)
if not f:has_lines() then return end
f:insert(1, H.as_struct({ H.as_struct({ string.rep('=', 78) }, 'section') }, 'block'))
f:insert(H.as_struct({ H.as_struct({ '' }, 'section') }, 'block'))
end,
--minidoc_replace_end
-- Applied to doc after all previous steps
--minidoc_replace_start doc = --<function: adds modeline>,
doc = function(d)
-- Render table of contents
H.apply_recursively(function(x)
if not (type(x) == 'table' and x.type == 'section' and x.info.id == '@toc') then return end
H.toc_insert(x)
end, d)
-- Insert modeline
d:insert(
H.as_struct(
{ H.as_struct({ H.as_struct({ ' vim:tw=78:ts=8:noet:ft=help:norl:' }, 'section') }, 'block') },
'file'
)
)
end,
--minidoc_replace_end
-- Applied to after output help file is written. Takes doc as argument.
--minidoc_replace_start write_post = --<function: various convenience actions>,
write_post = function(d)
local output = d.info.output
-- Generate help tags for directory of output file
vim.cmd('helptags ' .. vim.fn.fnamemodify(output, ':h'))
-- Reload buffer with output file (helps during writing annotations)
local output_path = H.full_path(output)
for _, buf_id in ipairs(vim.api.nvim_list_bufs()) do
local buf_path = H.full_path(vim.api.nvim_buf_get_name(buf_id))
if buf_path == output_path then
vim.api.nvim_buf_call(buf_id, function() vim.cmd('noautocmd silent edit | set ft=help') end)
end
end
-- Notify
local msg = ('Help file %s is successfully generated (%s).'):format(
vim.inspect(output),
vim.fn.strftime('%Y-%m-%d %H:%M:%S')
)
H.echo(msg)
end,
--minidoc_replace_end
},
-- Path (relative to current directory) to script which handles project
-- specific help file generation (like custom input files, hooks, etc.).
script_path = 'scripts/minidoc.lua',
}
--minidoc_afterlines_end
-- Module data ================================================================
--- Table with information about current state of auto-generation
---
--- It is reset at the beginning and end of `MiniDoc.generate()`.
---
--- At least these keys are supported:
--- - {aliases} - table with keys being alias name and values - alias
--- description and single string (using `\n` to separate lines).
--- - {eval_section} - input section of `@eval` section hook. Can be used for
--- information about current block, etc.
--- - {toc} - array with table of contents entries. Each entry is a whole
--- `@toc_entry` section.
MiniDoc.current = { aliases = {}, toc = {} }
--- Default hooks
---
--- This is default value of `MiniDoc.config.hooks`. Use it if only a little
--- tweak is needed.
---
--- Some more insight about their behavior:
--- - Default inference of documented object metadata (tag and object signature
--- at the moment) is done in `block_pre`. Inference is based on string
--- pattern matching, so can lead to false results, although works in most
--- cases. It intentionally works only if first line after block has no
--- indentation and contains all necessary information to determine if
--- inference should happen.
--- - Hooks for sections describing some "variable-like" object ('@class',
--- '@field', '@param') automatically enclose first word in '{}'.
--- - Hooks for sections which supposed to have "type-like" data ('@field',
--- '@param', '@return', '@type') automatically enclose *first found*
--- "type-like" word and its neighbor characters in '`(<type>)`' (expect
--- false positives). Algoritm is far from being 100% correct, but seems to
--- work with present allowed type annotation. For allowed types see
--- https://github.com/sumneko/lua-language-server/wiki/EmmyLua-Annotations#types-and-type
--- or, better yet, look in source code of this module.
--- - Automated creation of table of contents (TOC) is done in the following way:
--- - Put section with `@toc_entry` id in the annotation block. Section's
--- lines will be registered as TOC entry.
--- - Put `@toc` section where you want to insert rendered table of
--- contents. TOC entries will be inserted on the left, references for
--- their respective tag section (only first, if present) on the right.
--- Render is done in default `doc` hook (because it should be done after
--- processing all files).
--- - The `write_post` hook executes some actions convenient for iterative
--- annotations writing:
--- - Generate `:helptags` for directory containing output file.
--- - Silently reload buffer containing output file (if such exists).
--- - Display notification message about result.
MiniDoc.default_hooks = MiniDoc.config.hooks
-- Module functionality =======================================================
--- Generate help file
---
--- # Algoritm~
---
--- - Main parameters for help generation are an array of input file paths and
--- path to output help file.
--- - Parse all inputs:
--- - For each file, lines are processed top to bottom in order to create an
--- array of documentation blocks. Each line is tested whether it is an
--- annotation by applying `MiniDoc.config.annotation_extractor`: if
--- anything is extracted, it is considered to be an annotation. Annotation
--- line goes to "current block" after removing extracted annotation
--- indicator, otherwise - to afterlines of "current block".
--- - Each block's annotation lines are processed top to bottom. If line had
--- captured section id, it is a first line of "current section" (first
--- block lines are allowed to not specify section id; by default it is
--- `@text`). All subsequent lines without captured section id go into
--- "current section".
--- - Apply structure hooks (they should modify its input in place, which is
--- possible due to 'table nature' of all inputs):
--- - Each block is processed by `MiniDoc.config.hooks.block_pre`. This is a
--- designated step for auto-generation of sections from descibed
--- annotation subject (like sections with id `@tag`, `@type`).
--- - Each section is processed by `MiniDoc.config.hooks.section_pre`.
--- - Each section is processed by corresponding
--- `MiniDoc.config.hooks.sections` function (table key equals to section
--- id). This is a step where most of formatting should happen (like
--- wrap first word of `@param` section with `{` and `}`, append empty
--- line to section, etc.).
--- - Each section is processed by `MiniDoc.config.hooks.section_post`.
--- - Each block is processed by `MiniDoc.config.hooks.block_post`. This is
--- a step for processing block after formatting is done (like add first
--- line with `----` delimiter).
--- - Each file is processed by `MiniDoc.config.hooks.file`. This is a step
--- for adding any file-related data (like add first line with `====`
--- delimiter).
--- - Doc is processed by `MiniDoc.config.hooks.doc`. This is a step for
--- adding any helpfile-related data (maybe like table of contents).
--- - Collect all strings from sections in depth-first fashion (equivalent to
--- nested "for all files -> for all blocks -> for all sections -> for all
--- strings -> add string to output") and write them to output file. Strings
--- can have `\n` character indicating start of new line.
--- - Execute `MiniDoc.config.write_post` hook. This is useful for showing some
--- feedback and making actions involving newly updated help file (like
--- generate tags, etc.).
---
--- # Project specific script~
---
--- If all arguments have default `nil` values, first there is an attempt to
--- source project specific script. This is basically a `luafile
--- <MiniDoc.config.script_path>` with current Lua runtime while caching and
--- restoring current `MiniDoc.config`. Its successful execution stops any
--- further generation actions while error means proceeding generation as if no
--- script was found.
---
--- Typical script content might include definition of custom hooks, input and
--- output files with eventual call to `require('mini.doc').generate()` (with
--- or without arguments).
---
---@param input table|nil Array of file paths which will be processed in supplied
--- order. Default: all '.lua' files from current directory following by all
--- such files in these subdirectories: 'lua/', 'after/', 'colors/'. Note:
--- any 'init.lua' file is placed before other files from the same directory.
---@param output string|nil Path for output help file. Default:
--- `doc/<current_directory>.txt` (designed to be used for generating help
--- file for plugin).
---@param config table|nil Configuration overriding parts of |MiniDoc.config|.
---
---@return table Document structure which was generated and used for output
--- help file. In case `MiniDoc.config.script_path` was successfully used,
--- this is a return from the latest call of this function.
MiniDoc.generate = function(input, output, config)
-- Try sourcing project specific script first
local success = H.execute_project_script(input, output, config)
if success then return H.generate_recent_output end
input = input or H.default_input()
output = output or H.default_output()
config = H.get_config(config)
-- Prepare table for current information
MiniDoc.current = {}
-- Parse input files
local doc = H.new_struct('doc', { input = input, output = output, config = config })
for _, path in ipairs(input) do
local lines = H.file_read(path)
local block_arr = H.lines_to_block_arr(lines, config)
local file = H.as_struct(block_arr, 'file', { path = path })
doc:insert(file)
end
-- Apply hooks
H.apply_structure_hooks(doc, config.hooks)
-- Gather string lines in depth-first fashion
local help_lines = H.collect_strings(doc)
-- Write helpfile
H.file_write(output, help_lines)
-- Execute post-write hook
config.hooks.write_post(doc)
-- Clear current information
MiniDoc.current = {}
-- Stash output to allow returning value even when called from script
H.generate_recent_output = doc
return doc
end
--- Convert afterlines to code
---
--- This function is designed to be used together with `@eval` section to
--- automate documentation of certain values (notable default values of a
--- table). It processes afterlines based on certain directives and makes
--- output looking like a code block.
---
--- Most common usage is by adding the following section in your annotation:
--- `@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)`
---
--- # Directives ~
--- Directives are special comments that are processed using Lua string pattern
--- capabilities (so beware of false positives). Each directive should be put
--- on its separate line. Supported directives:
--- - `--minidoc_afterlines_end` denotes a line at afterlines end. Only all
--- lines before it will be considered as afterlines. Useful if there is
--- extra code in afterlines which shouldn't be used.
--- - `--minidoc_replace_start <replacement>` and `--minidoc_replace_end`
--- denote lines between them which should be replaced with `<replacement>`.
--- Useful for manually changing what should be placed in output like in case
--- of replacing function body with something else.
---
--- Here is an example. Suppose having these afterlines:
--- >
--- --minidoc_replace_start {
--- M.config = {
--- --minidoc_replace_end
--- param_one = 1,
--- --minidoc_replace_start param_fun = --<function>
--- param_fun = function(x)
--- return x + 1
--- end
--- --minidoc_replace_end
--- }
--- --minidoc_afterlines_end
---
--- return M
--- <
---
--- After adding `@eval` section those will be formatted as:
--- >
--- {
--- param_one = 1,
--- param_fun = --<function>
--- }
--- <
---@param struct table Block or section structure which after lines will be
--- converted to code.
---
---@return string|nil Single string (using `\n` to separate lines) describing
--- afterlines as code block in help file. If `nil`, input is not valid.
MiniDoc.afterlines_to_code = function(struct)
if not (type(struct) == 'table' and (struct.type == 'section' or struct.type == 'block')) then
H.message('Input to `MiniDoc.afterlines_to_code()` should be either section or block.')
return
end
if struct.type == 'section' then struct = struct.parent end
local src = table.concat(struct.info.afterlines, '\n')
-- Process directives
-- Try to extract afterlines
src = src:match('^(.-)\n%s*%-%-minidoc_afterlines_end') or src
-- Make replacements
src = src:gsub('%-%-minidoc_replace_start ?(.-)\n.-%-%-minidoc_replace_end', '%1')
-- Convert to a standalone code. NOTE: indent is needed because of how `>`
-- and `<` work (any line starting in column 1 stops code block).
src = H.ensure_indent(src, 2)
return '>\n' .. src .. '\n<'
end
-- Helper data ================================================================
-- Module default config
H.default_config = MiniDoc.config
-- Alias registry. Keys are alias name, values - single string of alias
-- description with '\n' separating output lines.
H.alias_registry = {}
--stylua: ignore start
H.pattern_sets = {
-- Patterns for working with afterlines. At the moment deliberately crafted
-- to work only on first line without indent.
-- Determine if line is a function definition. Captures function name and
-- arguments. For reference see '2.5.9 – Function Definitions' in Lua manual.
afterline_fundef = {
'^function%s+(%S-)(%b())', -- Regular definition
'^local%s+function%s+(%S-)(%b())', -- Local definition
'^(%S+)%s*=%s*function(%b())', -- Regular assignment
'^local%s+(%S+)%s*=%s*function(%b())', -- Local assignment
},
-- Determine if line is a general assignment
afterline_assign = {
'^(%S-)%s*=', -- General assignment
'^local%s+(%S-)%s*=', -- Local assignment
},
-- Patterns to work with type descriptions
-- (see https://github.com/sumneko/lua-language-server/wiki/EmmyLua-Annotations#types-and-type)
types = {
'table%b<>',
'fun%b(): %S+', 'fun%b()',
'nil', 'any', 'boolean', 'string', 'number', 'integer', 'function', 'table', 'thread', 'userdata', 'lightuserdata',
'%.%.%.'
},
}
--stylua: ignore end
-- Helper functionality =======================================================
-- Settings -------------------------------------------------------------------
H.setup_config = function(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 {})
-- Validate per nesting level to produce correct error message
vim.validate({
annotation_extractor = { config.annotation_extractor, 'function' },
default_section_id = { config.default_section_id, 'string' },
hooks = { config.hooks, 'table' },
script_path = { config.script_path, 'string' },
})
vim.validate({
['hooks.block_pre'] = { config.hooks.block_pre, 'function' },
['hooks.section_pre'] = { config.hooks.section_pre, 'function' },
['hooks.sections'] = { config.hooks.sections, 'table' },
['hooks.section_post'] = { config.hooks.section_post, 'function' },
['hooks.block_post'] = { config.hooks.block_post, 'function' },
['hooks.file'] = { config.hooks.file, 'function' },
['hooks.doc'] = { config.hooks.doc, 'function' },
['hooks.write_post'] = { config.hooks.write_post, 'function' },
})
vim.validate({
['hooks.sections.@alias'] = { config.hooks.sections['@alias'], 'function' },
['hooks.sections.@class'] = { config.hooks.sections['@class'], 'function' },
['hooks.sections.@diagnostic'] = { config.hooks.sections['@diagnostic'], 'function' },
['hooks.sections.@eval'] = { config.hooks.sections['@eval'], 'function' },
['hooks.sections.@field'] = { config.hooks.sections['@field'], 'function' },
['hooks.sections.@overload'] = { config.hooks.sections['@overload'], 'function' },
['hooks.sections.@param'] = { config.hooks.sections['@param'], 'function' },
['hooks.sections.@private'] = { config.hooks.sections['@private'], 'function' },
['hooks.sections.@return'] = { config.hooks.sections['@return'], 'function' },
['hooks.sections.@seealso'] = { config.hooks.sections['@seealso'], 'function' },
['hooks.sections.@signature'] = { config.hooks.sections['@signature'], 'function' },
['hooks.sections.@tag'] = { config.hooks.sections['@tag'], 'function' },
['hooks.sections.@text'] = { config.hooks.sections['@text'], 'function' },
['hooks.sections.@toc'] = { config.hooks.sections['@toc'], 'function' },
['hooks.sections.@toc_entry'] = { config.hooks.sections['@toc_entry'], 'function' },
['hooks.sections.@type'] = { config.hooks.sections['@type'], 'function' },
['hooks.sections.@usage'] = { config.hooks.sections['@usage'], 'function' },
})
return config
end
H.apply_config = function(config) MiniDoc.config = config end
H.is_disabled = function() return vim.g.minidoc_disable == true or vim.b.minidoc_disable == true end
H.get_config =
function(config) return vim.tbl_deep_extend('force', MiniDoc.config, vim.b.minidoc_config or {}, config or {}) end
-- Work with project specific script ==========================================
H.execute_project_script = function(input, output, config)
-- Don't process script if there are more than one active `generate` calls
if H.generate_is_active then return end
-- Don't process script if at least one argument is not default
if not (input == nil and output == nil and config == nil) then return end
-- Store information
local global_config_cache = vim.deepcopy(MiniDoc.config)
local local_config_cache = vim.b.minidoc_config
-- Pass information to a possible `generate()` call inside script
H.generate_is_active = true
H.generate_recent_output = nil
-- Execute script
local success = pcall(vim.cmd, 'luafile ' .. H.get_config(config).script_path)
-- Restore information
MiniDoc.config = global_config_cache
vim.b.minidoc_config = local_config_cache
H.generate_is_active = nil
return success
end
-- Default documentation targets ----------------------------------------------
H.default_input = function()
-- Search in current and recursively in other directories for files with
-- 'lua' extension
local res = {}
for _, dir_glob in ipairs({ '.', 'lua/**', 'after/**', 'colors/**' }) do
local files = vim.fn.globpath(dir_glob, '*.lua', false, true)
-- Use full paths
files = vim.tbl_map(function(x) return vim.fn.fnamemodify(x, ':p') end, files)
-- Put 'init.lua' first among files from same directory
table.sort(files, function(a, b)
if vim.fn.fnamemodify(a, ':h') == vim.fn.fnamemodify(b, ':h') then
if vim.fn.fnamemodify(a, ':t') == 'init.lua' then return true end
if vim.fn.fnamemodify(b, ':t') == 'init.lua' then return false end
end
return a < b
end)
table.insert(res, files)
end
return vim.tbl_flatten(res)
end
H.default_output = function()
local cur_dir = vim.fn.fnamemodify(vim.loop.cwd(), ':t:r')
return ('doc/%s.txt'):format(cur_dir)
end
-- Parsing --------------------------------------------------------------------
H.lines_to_block_arr = function(lines, config)
local matched_prev, matched_cur
local res = {}
local block_raw = { annotation = {}, section_id = {}, afterlines = {}, line_begin = 1 }
for i, l in ipairs(lines) do
local from, to, section_id = config.annotation_extractor(l)
matched_prev, matched_cur = matched_cur, from ~= nil
if matched_cur then
if not matched_prev then
-- Finish current block
block_raw.line_end = i - 1
table.insert(res, H.raw_block_to_block(block_raw, config))
-- Start new block
block_raw = { annotation = {}, section_id = {}, afterlines = {}, line_begin = i }
end
-- Add annotation line without matched annotation pattern
table.insert(block_raw.annotation, ('%s%s'):format(l:sub(0, from - 1), l:sub(to + 1)))
-- Add section id (it is empty string in case of no section id capture)
table.insert(block_raw.section_id, section_id or '')
else
-- Add afterline
table.insert(block_raw.afterlines, l)
end
end
block_raw.line_end = #lines
table.insert(res, H.raw_block_to_block(block_raw, config))
return res
end
-- Raw block structure is an intermediate step added for convenience. It is
-- a table with the following keys:
-- - `annotation` - lines (after removing matched annotation pattern) that were
-- parsed as annotation.
-- - `section_id` - array with length equal to `annotation` length with strings
-- captured as section id. Empty string of no section id was captured.
-- - Everything else is used as block info (like `afterlines`, etc.).
H.raw_block_to_block = function(block_raw, config)
if #block_raw.annotation == 0 and #block_raw.afterlines == 0 then return nil end
local block = H.new_struct('block', {
afterlines = block_raw.afterlines,
line_begin = block_raw.line_begin,
line_end = block_raw.line_end,
})
local block_begin = block.info.line_begin
-- Parse raw block annotation lines from top to bottom. New section starts
-- when section id is detected in that line.
local section_cur = H.new_struct('section', { id = config.default_section_id, line_begin = block_begin })
for i, annotation_line in ipairs(block_raw.annotation) do
local id = block_raw.section_id[i]
if id ~= '' then
-- Finish current section
if #section_cur > 0 then
section_cur.info.line_end = block_begin + i - 2
block:insert(section_cur)
end
-- Start new section
section_cur = H.new_struct('section', { id = id, line_begin = block_begin + i - 1 })
end
section_cur:insert(annotation_line)
end
if #section_cur > 0 then
section_cur.info.line_end = block_begin + #block_raw.annotation - 1
block:insert(section_cur)
end
return block
end
-- Hooks ----------------------------------------------------------------------
H.apply_structure_hooks = function(doc, hooks)
for _, file in ipairs(doc) do
for _, block in ipairs(file) do
hooks.block_pre(block)
for _, section in ipairs(block) do
hooks.section_pre(section)
local hook = hooks.sections[section.info.id]
if hook ~= nil then hook(section) end
hooks.section_post(section)
end
hooks.block_post(block)
end
hooks.file(file)
end
hooks.doc(doc)
end
H.alias_register = function(s)
if #s == 0 then return end
-- Remove first word (with bits of surrounding whitespace) while capturing it
local alias_name
s[1] = s[1]:gsub('%s*(%S+) ?', function(x)
alias_name = x
return ''
end, 1)
if alias_name == nil then return end
MiniDoc.current.aliases = MiniDoc.current.aliases or {}
MiniDoc.current.aliases[alias_name] = table.concat(s, '\n')
end
H.alias_replace = function(s)
if MiniDoc.current.aliases == nil then return end
for i, _ in ipairs(s) do
for alias_name, alias_desc in pairs(MiniDoc.current.aliases) do
-- Escape special characters. This is done here and not while registering
-- alias to allow user to refer to aliases by its original name.
-- Store escaped words in separate variables because `vim.pesc()` returns
-- two values which might conflict if outputs are used as arguments.
local name_escaped = vim.pesc(alias_name)
local desc_escaped = vim.pesc(alias_desc)
s[i] = s[i]:gsub(name_escaped, desc_escaped)
end
end
end
H.toc_register = function(s)
MiniDoc.current.toc = MiniDoc.current.toc or {}
table.insert(MiniDoc.current.toc, s)
end
H.toc_insert = function(s)
if MiniDoc.current.toc == nil then return end
-- Render table of contents
local toc_lines = {}
for _, toc_entry in ipairs(MiniDoc.current.toc) do
local _, tag_section = toc_entry.parent:has_descendant(
function(x) return type(x) == 'table' and x.type == 'section' and x.info.id == '@tag' end
)
tag_section = tag_section or {}
local lines = {}
for i = 1, math.max(#toc_entry, #tag_section) do
local left = toc_entry[i] or ''
-- Use tag refernce instead of tag enclosure
local right = vim.trim((tag_section[i] or ''):gsub('%*', '|'))
-- Add visual line only at first entry (while not adding trailing space)
local filler = i == 1 and '.' or (right == '' and '' or ' ')
-- Make padding of 2 spaces at both left and right
local n_filler = math.max(74 - H.visual_text_width(left) - H.visual_text_width(right), 3)
table.insert(lines, (' %s%s%s'):format(left, filler:rep(n_filler), right))
end
table.insert(toc_lines, lines)
-- Don't show `toc_entry` lines in output
toc_entry:clear_lines()
end
for _, l in ipairs(vim.tbl_flatten(toc_lines)) do
s:insert(l)
end
end
H.add_section_heading = function(s, heading)
if #s == 0 or s.type ~= 'section' then return end
-- Add heading