-
Notifications
You must be signed in to change notification settings - Fork 0
/
padline.txt
135 lines (85 loc) · 5.56 KB
/
padline.txt
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
*padline.txt* mappings to pad/unpad with empty lines
Author: notuxic <[email protected]>
License: BSD 2-clause
===============================================================================
Contents *padline-contents*
Introduction...............|padline-introduction|
Features...................|padline-features|
Mappings...................|padline-mappings|
Commands...................|padline-commands|
API........................|padline-api|
===============================================================================
Introduction *padline-introduction*
While empty lines do not have any effect in most file formats, they do still
carry semantic information. Empty lines are often used to group related lines
together to improve readability. As such, we spend a noticeable amount adding
and removing empty lines to group or regroup lines in our files. This plugin
aims to make this common action a bit more convenient.
===============================================================================
Features *padline-features*
*padline* adds mappings and commands to add or remove padding in the form of
empty lines.
It does not change
* cursor position
* jump list
* current change (ie. does not break dot-repeatability)
or anything else except for the buffers content.
This allows adding/removing padding in the middle of doing something else
without getting any side-effects.
===============================================================================
Mappings *padline-mappings*
<Plug>PadLineAbove *padline-map-padlineabove*
<Plug>PadLineBelow *padline-map-padlinebelow*
<Plug>PadLineAround *padline-map-padlinearound*
Add empty lines above, below or around the current line.
Available for 'normal' and 'insert' mode. Take an optional count to pad with
`count` lines (instead of 1).
<Plug>PadBlockAbove *padline-map-padblockabove*
<Plug>PadBlockBelow *padline-map-padblockbelow*
<Plug>PadBlockAround *padline-map-padblockaround*
Add empty lines above, below or around a visual selection.
Available for 'visual' mode. Take an optional count to pad with `count` lines
(instead of 1).
<Plug>UnpadLineAbove *padline-map-unpad-line-above*
<Plug>UnpadLineBelow *padline-map-unpadlinebelow*
<Plug>UnpadLineAround *padline-map-unpadlinearound*
Remove the next occurrence of consecutive empty lines above, below or around
the current line.
Available for 'normal' and 'insert' mode. Take an optional count to remove
*at most* the next `count` consecutive empty lines (instead of 1).
<Plug>UnpadBlockAbove *padline-map-unpadblockabove*
<Plug>UnpadBlockBelow *padline-map-unpadblockbelow*
<Plug>UnpadBlockAround *padline-map-unpadblockbelow*
Remove the next occurrence of consecutive empty lines above, below or around
a visual selection. Empty lines inside the selection remain unaffected.
Available for 'visual' mode. Take an optional count to remove *at most* the
next `count` consecutive empty lines (instead of 1).
===============================================================================
Commands *padline-commands*
`[range]` PadAbove `[count]` *padline-cmd-padabove*
`[range]` PadBelow `[count]` *padline-cmd-padbelow*
`[range]` PadAround `[count]` *padline-cmd-padaround*
Add empty lines above, below or around a range `range`.
Take an optional count to pad with `count` lines (instead of 1). `range`
defaults to the current line.
`[range]` UnpadAbove `[count]` *padline-cmd-unpadabove*
`[range]` UnpadBelow `[count]` *padline-cmd-unpadbelow*
`[range]` UnpadAround `[count]` *padline-cmd-unpadaround*
Remove the next occurrence of consecutive empty lines above, below or around
a range `range`. Empty lines inside the range remain unaffected.
Take an optional count to remove *at most* the next `count` consecutive
empty lines (instead of 1). `range` defaults to the current line.
===============================================================================
API *padline-api*
padline#PadLineAbove(linenr, count) *padline-api-padlineabove*
padline#PadLineBelow(linenr, count)
Add *count* empty lines above/below the line *linenr* .
padline#PadBlockAround(linenr1, linenr2, count) *padline-api-padblockaround*
Add *count* empty lines above line *linenr1* and below line *linenr2* .
padline#UnpadLineAbove(linenr, count) *padline-api-unpadlineabove*
padline#UnpadLineBelow(linenr, count) *padline-api-unpadlineabove*
Remove the next occurrence of consecutive empty lines above/below the line
*linenr* , removing at most *count* lines.
padline#UnpadBlockAround(linenr1, linenr2, count) *padline-api-unpadblockaround*
Remove the next occurrence of consecutive empty lines above line *linenr1*
and below line *linenr2* , removing at most *count* lines.