]> git.wincent.com - pinnacle.git/blob - README.md
Merge branch 'pull/4'
[pinnacle.git] / README.md
1 # Pinnacle<a name="pinnacle-pinnacle" href="#user-content-pinnacle-pinnacle"></a>
2
3 ## Intro<a name="pinnacle-intro" href="#user-content-pinnacle-intro"></a>
4
5 Pinnacle provides functions for manipulating <strong>`:highlight`</strong> groups in Vimscript (eg. <strong>`pinnacle#italicize`</strong>) and Lua (eg. `require'wincent.pinnacle'.italicize()`).
6
7 ## Installation<a name="pinnacle-installation" href="#user-content-pinnacle-installation"></a>
8
9 To install Pinnacle, use your plug-in management system of choice.
10
11 If you don't have a &quot;plug-in management system of choice&quot;, I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install Pinnacle into `~/.vim/bundle`, you can do so with:
12
13 ```
14 git clone https://github.com/wincent/pinnacle.git ~/.vim/bundle/pinnacle
15 ```
16
17 Alternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:
18
19 ```
20 git submodule add https://github.com/wincent/pinnacle.git ~/vim/bundle/pinnacle
21 git submodule init
22 ```
23
24 To generate help tags under Pathogen, you can do so from inside Vim with:
25
26 ```
27 :call pathogen#helptags()
28 ```
29
30 ## Functions<a name="pinnacle-functions" href="#user-content-pinnacle-functions"></a>
31
32 <p align="right"><a name="pinnaclesubnewlines" href="#user-content-pinnaclesubnewlines"><code>pinnacle#sub_newlines()</code></a></p>
33
34 ### `pinnacle#sub_newlines()`<a name="pinnacle-pinnaclesubnewlines" href="#user-content-pinnacle-pinnaclesubnewlines"></a>
35
36 Replaces newlines with spaces.
37
38 Note that this function is not implemented in the Lua API, because it is required only for support on legacy Vim versions.
39
40 <p align="right"><a name="pinnaclecaptureline" href="#user-content-pinnaclecaptureline"><code>pinnacle#capture_line()</code></a></p>
41
42 ### `pinnacle#capture_line()`<a name="pinnacle-pinnaclecaptureline" href="#user-content-pinnacle-pinnaclecaptureline"></a>
43
44 Runs a command and returns the captured output as a single line.
45
46 Useful when we don't want to let long lines on narrow windows produce unwanted embedded newlines.
47
48 Note that this function is not implemented in the Lua API, because it is required only for support on legacy Vim versions.
49
50 <p align="right"><a name="pinnaclecapturehighlight" href="#user-content-pinnaclecapturehighlight"><code>pinnacle#capture_highlight()</code></a></p>
51
52 ### `pinnacle#capture_highlight()`<a name="pinnacle-pinnaclecapturehighlight" href="#user-content-pinnacle-pinnaclecapturehighlight"></a>
53
54 Gets the current value of a highlight group.
55
56 <p align="right"><a name="pinnacleextracthighlight" href="#user-content-pinnacleextracthighlight"><code>pinnacle#extract_highlight()</code></a></p>
57
58 ### `pinnacle#extract_highlight()`<a name="pinnacle-pinnacleextracthighlight" href="#user-content-pinnacle-pinnacleextracthighlight"></a>
59
60 Extracts a highlight string from a group, recursively traversing linked groups, and returns a string suitable for passing to `:highlight`.
61
62 <p align="right"><a name="pinnacleextractbg" href="#user-content-pinnacleextractbg"><code>pinnacle#extract_bg()</code></a></p>
63
64 ### `pinnacle#extract_bg()`<a name="pinnacle-pinnacleextractbg" href="#user-content-pinnacle-pinnacleextractbg"></a>
65
66 Extracts just the bg portion of the specified highlight group.
67
68 <p align="right"><a name="pinnacleextractfg" href="#user-content-pinnacleextractfg"><code>pinnacle#extract_fg()</code></a></p>
69
70 ### `pinnacle#extract_fg()`<a name="pinnacle-pinnacleextractfg" href="#user-content-pinnacle-pinnacleextractfg"></a>
71
72 Extracts just the bg portion of the specified highlight group.
73
74 <p align="right"><a name="pinnacleextractcomponent" href="#user-content-pinnacleextractcomponent"><code>pinnacle#extract_component()</code></a></p>
75
76 ### `pinnacle#extract_component()`<a name="pinnacle-pinnacleextractcomponent" href="#user-content-pinnacle-pinnacleextractcomponent"></a>
77
78 Extracts a single component (eg. &quot;bg&quot;, &quot;fg&quot;, &quot;italic&quot; etc) from the specified highlight group.
79
80 <p align="right"><a name="pinnacledump" href="#user-content-pinnacledump"><code>pinnacle#dump()</code></a></p>
81
82 ### `pinnacle#dump()`<a name="pinnacle-pinnacledump" href="#user-content-pinnacle-pinnacledump"></a>
83
84 Returns a dictionary representation of the specified highlight group.
85
86 <p align="right"><a name="pinnaclehighlight" href="#user-content-pinnaclehighlight"><code>pinnacle#highlight()</code></a></p>
87
88 ### `pinnacle#highlight()`<a name="pinnacle-pinnaclehighlight" href="#user-content-pinnacle-pinnaclehighlight"></a>
89
90 Returns a string representation of a dictionary containing bg, fg, term, cterm and guiterm entries.
91
92 <p align="right"><a name="pinnacleitalicize" href="#user-content-pinnacleitalicize"><code>pinnacle#italicize()</code></a></p>
93
94 ### `pinnacle#italicize()`<a name="pinnacle-pinnacleitalicize" href="#user-content-pinnacle-pinnacleitalicize"></a>
95
96 Returns an italicized copy of `group` suitable for passing to `:highlight`.
97
98 <p align="right"><a name="pinnacleembolden" href="#user-content-pinnacleembolden"><code>pinnacle#embolden()</code></a></p>
99
100 ### `pinnacle#embolden()`<a name="pinnacle-pinnacleembolden" href="#user-content-pinnacle-pinnacleembolden"></a>
101
102 Returns a bold copy of `group` suitable for passing to `:highlight`.
103
104 <p align="right"><a name="pinnacleunderline" href="#user-content-pinnacleunderline"><code>pinnacle#underline()</code></a></p>
105
106 ### `pinnacle#underline()`<a name="pinnacle-pinnacleunderline" href="#user-content-pinnacle-pinnacleunderline"></a>
107
108 Returns an underlined copy of `group` suitable for passing to `:highlight`.
109
110 <p align="right"><a name="pinnacledecorate" href="#user-content-pinnacledecorate"><code>pinnacle#decorate()</code></a></p>
111
112 ### `pinnacle#decorate()`<a name="pinnacle-pinnacledecorate" href="#user-content-pinnacle-pinnacledecorate"></a>
113
114 Returns a copy of `group` decorated with `style` (eg. &quot;bold&quot;, &quot;italic&quot; etc) suitable for passing to `:highlight`.
115
116 To decorate with multiple styles, `style` should be a comma-separated list.
117
118 ## Website<a name="pinnacle-website" href="#user-content-pinnacle-website"></a>
119
120 The official Pinnacle source code repo is at:
121
122 http://git.wincent.com/pinnacle.git
123
124 Mirrors exist at:
125
126 - https://github.com/wincent/pinnacle
127 - https://gitlab.com/wincent/pinnacle
128 - https://bitbucket.org/ghurrell/pinnacle
129
130 Official releases are listed at:
131
132 http://www.vim.org/scripts/script.php?script_id=5360
133
134 ## License<a name="pinnacle-license" href="#user-content-pinnacle-license"></a>
135
136 Copyright (c) 2016-present Greg Hurrell
137
138 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
139
140 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
141
142 THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
143
144 ## Development<a name="pinnacle-development" href="#user-content-pinnacle-development"></a>
145
146 ### Contributing patches<a name="pinnacle-contributing-patches" href="#user-content-pinnacle-contributing-patches"></a>
147
148 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/pinnacle/pulls
149
150 ### Cutting a new release<a name="pinnacle-cutting-a-new-release" href="#user-content-pinnacle-cutting-a-new-release"></a>
151
152 At the moment the release process is manual:
153
154 - Perform final sanity checks and manual testing
155 - Update the <strong>[`pinnacle-history`](#user-content-pinnacle-history)</strong> section of the documentation
156 - Verify clean work tree:
157
158 ```
159 git status
160 ```
161
162 - Tag the release:
163
164 ```
165 git tag -s -m "$VERSION release" $VERSION
166 ```
167
168 - Publish the code:
169
170 ```
171 git push origin master --follow-tags
172 git push github master --follow-tags
173 ```
174
175 - Produce the release archive:
176
177 ```
178 git archive -o pinnacle-$VERSION.zip HEAD -- .
179 ```
180
181 - Upload to http://www.vim.org/scripts/script.php?script_id=5360
182
183 ## Authors<a name="pinnacle-authors" href="#user-content-pinnacle-authors"></a>
184
185 Pinnacle is written and maintained by Greg Hurrell &lt;greg@hurrell.net&gt;.
186
187 Other contributors that have submitted patches include (in alphabetical order):
188
189 - Cody Buell
190 - Khue Nguyen
191 - Kyle Poole
192
193 ## History<a name="pinnacle-history" href="#user-content-pinnacle-history"></a>
194
195 ### master (not yet released)<a name="pinnacle-master-not-yet-released" href="#user-content-pinnacle-master-not-yet-released"></a>
196
197 - Teach `pinnacle#decorate()` to accept a comma-separated list of styles.
198 - Add alternative Lua-based API (eg. `require'wincent.pinnacle'.italicize()` is equivalent to `pinnacle#italicize()` etc).
199
200 ### 1.0 (6 March 2019)<a name="pinnacle-10-6-march-2019" href="#user-content-pinnacle-10-6-march-2019"></a>
201
202 - Added `pinnacle#dump()`.
203
204 ### 0.3.1 (7 June 2017)<a name="pinnacle-031-7-june-2017" href="#user-content-pinnacle-031-7-june-2017"></a>
205
206 - Fix another bug with augmentation of existing highlights.
207
208 ### 0.3 (6 June 2017)<a name="pinnacle-03-6-june-2017" href="#user-content-pinnacle-03-6-june-2017"></a>
209
210 - Added `pinnacle#extract_bg` and `pinnacle#extract_fg`.
211 - Fixed bug that could cause existing highlights to be incorrectly augmented.
212
213 ### 0.2 (9 January 2017)<a name="pinnacle-02-9-january-2017" href="#user-content-pinnacle-02-9-january-2017"></a>
214
215 - Added `pinnacle#underline`.
216
217 ### 0.1 (30 March 2016)<a name="pinnacle-01-30-march-2016" href="#user-content-pinnacle-01-30-march-2016"></a>
218
219 - Initial release.