Skip to content

Commit e53989a

Browse files
authored
Merge branch 'master' into configuratble_bullet_styles
2 parents aa97d0b + ab474fd commit e53989a

File tree

11 files changed

+654
-120
lines changed

11 files changed

+654
-120
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
doc/tags
22
vendor/
33
spec/examples.txt
4+
doc/tags

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ group :test do
77
gem 'pry-byebug'
88
gem 'rake', '~> 12.3.3'
99
gem 'rspec'
10+
gem 'rspec-retry'
1011
gem 'vimrunner'
1112
end

Gemfile.lock

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ GEM
2424
rspec-mocks (3.8.0)
2525
diff-lcs (>= 1.2.0, < 2.0)
2626
rspec-support (~> 3.8.0)
27+
rspec-retry (0.6.2)
28+
rspec-core (> 3.3)
2729
rspec-support (3.8.0)
2830
vimrunner (0.3.4)
2931

@@ -35,6 +37,7 @@ DEPENDENCIES
3537
pry-byebug
3638
rake (~> 12.3.3)
3739
rspec
40+
rspec-retry
3841
vimrunner
3942

4043
BUNDLED WITH

README.md

Lines changed: 52 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
![Bullets.vim](img/bullets-vim-logo.svg)
22

3-
[![Build Status](https://travis-ci.org/dkarter/bullets.vim.svg?branch=master)](https://travis-ci.org/dkarter/bullets.vim)
4-
53
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
64
[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
75
<!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -34,7 +32,7 @@ Make sure to include `packloadall` in your `vimrc`.
3432
### With VimPlug:
3533

3634
```vim
37-
Plug 'dkarter/bullets.vim'
35+
Plug 'bullets-vim/bullets.vim'
3836
```
3937

4038
Then source your bundle file and run `:PlugInstall`.
@@ -109,10 +107,34 @@ let g:bullets_custom_mappings = [
109107
\ ]
110108
```
111109

112-
Enable/disable deleting the last empty bullet when hitting `<cr>` (insert mode) or `o` (normal mode):
110+
Enable/disable deleting or promoting the last empty bullet when hitting `<cr>` (insert mode) or `o` (normal mode):
113111

114112
```vim
115-
let g:bullets_delete_last_bullet_if_empty = 0 " default = 1
113+
" Example (| is cursor):
114+
" - text
115+
" - text
116+
" - |
117+
118+
let g:bullets_delete_last_bullet_if_empty = 1 " default = 1
119+
" - text
120+
" - text
121+
" |
122+
123+
let g:bullets_delete_last_bullet_if_empty = 0
124+
" - text
125+
" - text
126+
" -
127+
" |
128+
129+
let g:bullets_delete_last_bullet_if_empty = 2
130+
" - text
131+
" - text
132+
" - |
133+
"
134+
" again:
135+
" - text
136+
" - text
137+
" |
116138
```
117139

118140
Line spacing between bullets (1 = no blank lines, 2 = one blank line, etc.):
@@ -140,6 +162,15 @@ let g:bullets_pad_right = 0
140162
" ^ no extra space between bullet and text
141163
```
142164

165+
Indent new bullets when the previous bullet ends with a colon:
166+
167+
```vim
168+
let g:bullets_auto_indent_after_colon = 1 " default = 1
169+
" a. text
170+
" b. text:
171+
" i. text
172+
```
173+
143174
Maximum number of alphabetic characters to use for bullets:
144175

145176
```vim
@@ -288,7 +319,7 @@ let g:bullets_checkbox_partials_toggle = 0
288319
* Promote a bullet (unindent it and increase the bullet level):
289320
+ NORMAL mode: `<<`
290321
+ INSERT mode: `<C-d>`
291-
+ VISUAL mode: `>`
322+
+ VISUAL mode: `<`
292323

293324
Disable default mappings:
294325

@@ -379,26 +410,26 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
379410
<table>
380411
<tbody>
381412
<tr>
382-
<td align="center"><a href="https://doriankarter.com"><img src="https://avatars3.githubusercontent.com/u/551858?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dorian Karter</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=dkarter" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/commits?author=dkarter" title="Tests">⚠️</a> <a href="https://github.com/dkarter/bullets.vim/commits?author=dkarter" title="Documentation">📖</a> <a href="#maintenance-dkarter" title="Maintenance">🚧</a></td>
383-
<td align="center"><a href="https://github.com/cormacrelf"><img src="https://avatars3.githubusercontent.com/u/378760?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cormac Relf</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=cormacrelf" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/issues?q=author%3Acormacrelf" title="Bug reports">🐛</a></td>
384-
<td align="center"><a href="http://keithmiyake.info"><img src="https://avatars1.githubusercontent.com/u/2266804?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Keith Miyake</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=kaymmm" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/commits?author=kaymmm" title="Documentation">📖</a> <a href="#ideas-kaymmm" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kaymmm" title="Maintenance">🚧</a></td>
385-
<td align="center"><a href="https://yous.be"><img src="https://avatars0.githubusercontent.com/u/853977?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chayoung You</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=yous" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/commits?author=yous" title="Documentation">📖</a></td>
386-
<td align="center"><a href="https://github.com/adriaanzon"><img src="https://avatars3.githubusercontent.com/u/4326420?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adriaan Zonnenberg</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=adriaanzon" title="Code">💻</a></td>
387-
<td align="center"><a href="https://github.com/eater"><img src="https://avatars3.githubusercontent.com/u/106199?v=4?s=100" width="100px;" alt=""/><br /><sub><b>eater</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=eater" title="Code">💻</a></td>
388-
<td align="center"><a href="https://github.com/hut"><img src="https://avatars1.githubusercontent.com/u/90548?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hut</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=hut" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/commits?author=hut" title="Documentation">📖</a></td>
413+
<td align="center"><a href="https://doriankarter.com"><img src="https://avatars3.githubusercontent.com/u/551858?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dorian Karter</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=dkarter" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/commits?author=dkarter" title="Tests">⚠️</a> <a href="https://github.com/bullets-vim/bullets.vim/commits?author=dkarter" title="Documentation">📖</a> <a href="#maintenance-dkarter" title="Maintenance">🚧</a></td>
414+
<td align="center"><a href="https://github.com/cormacrelf"><img src="https://avatars3.githubusercontent.com/u/378760?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Cormac Relf</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=cormacrelf" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/issues?q=author%3Acormacrelf" title="Bug reports">🐛</a></td>
415+
<td align="center"><a href="http://keithmiyake.info"><img src="https://avatars1.githubusercontent.com/u/2266804?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Keith Miyake</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=kaymmm" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/commits?author=kaymmm" title="Documentation">📖</a> <a href="#ideas-kaymmm" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kaymmm" title="Maintenance">🚧</a></td>
416+
<td align="center"><a href="https://yous.be"><img src="https://avatars0.githubusercontent.com/u/853977?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chayoung You</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=yous" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/commits?author=yous" title="Documentation">📖</a></td>
417+
<td align="center"><a href="https://github.com/adriaanzon"><img src="https://avatars3.githubusercontent.com/u/4326420?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adriaan Zonnenberg</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=adriaanzon" title="Code">💻</a></td>
418+
<td align="center"><a href="https://github.com/eater"><img src="https://avatars3.githubusercontent.com/u/106199?v=4?s=100" width="100px;" alt=""/><br /><sub><b>eater</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=eater" title="Code">💻</a></td>
419+
<td align="center"><a href="https://github.com/hut"><img src="https://avatars1.githubusercontent.com/u/90548?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hut</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=hut" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/commits?author=hut" title="Documentation">📖</a></td>
389420
</tr>
390421
<tr>
391-
<td align="center"><a href="https://github.com/mykoza"><img src="https://avatars1.githubusercontent.com/u/48719773?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mykoza</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=mykoza" title="Code">💻</a> <a href="#ideas-mykoza" title="Ideas, Planning, & Feedback">🤔</a></td>
392-
<td align="center"><a href="https://github.com/noodlor"><img src="https://avatars3.githubusercontent.com/u/49209345?v=4?s=100" width="100px;" alt=""/><br /><sub><b>noodlor</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=noodlor" title="Code">💻</a></td>
393-
<td align="center"><a href="https://github.com/harshad1"><img src="https://avatars0.githubusercontent.com/u/1940940?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Harshad Srinivasan</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=harshad1" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/issues?q=author%3Aharshad1" title="Bug reports">🐛</a></td>
422+
<td align="center"><a href="https://github.com/mykoza"><img src="https://avatars1.githubusercontent.com/u/48719773?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mykoza</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=mykoza" title="Code">💻</a> <a href="#ideas-mykoza" title="Ideas, Planning, & Feedback">🤔</a></td>
423+
<td align="center"><a href="https://github.com/noodlor"><img src="https://avatars3.githubusercontent.com/u/49209345?v=4?s=100" width="100px;" alt=""/><br /><sub><b>noodlor</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=noodlor" title="Code">💻</a></td>
424+
<td align="center"><a href="https://github.com/harshad1"><img src="https://avatars0.githubusercontent.com/u/1940940?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Harshad Vedartham</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=harshad1" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/issues?q=author%3Aharshad1" title="Bug reports">🐛</a></td>
394425
<td align="center"><a href="https://erickchacon.github.io/"><img src="https://avatars2.githubusercontent.com/u/7862458?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Erick A. Chacón Montalván</b></sub></a><br /><a href="#ideas-ErickChacon" title="Ideas, Planning, & Feedback">🤔</a></td>
395-
<td align="center"><a href="https://samgriesemer.com"><img src="https://avatars.githubusercontent.com/u/19940657?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sam Griesemer</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=samgriesemer" title="Code">💻</a> <a href="https://github.com/dkarter/bullets.vim/issues?q=author%3Asamgriesemer" title="Bug reports">🐛</a></td>
396-
<td align="center"><a href="https://codeberg.org/cpence"><img src="https://avatars.githubusercontent.com/u/297075?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Pence</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=cpence" title="Code">💻</a></td>
397-
<td align="center"><a href="https://github.com/mstojanovic"><img src="https://avatars.githubusercontent.com/u/3449343?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marko Stojanovic</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=mstojanovic" title="Documentation">📖</a></td>
426+
<td align="center"><a href="https://samgriesemer.com"><img src="https://avatars.githubusercontent.com/u/19940657?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sam Griesemer</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=samgriesemer" title="Code">💻</a> <a href="https://github.com/bullets-vim/bullets.vim/issues?q=author%3Asamgriesemer" title="Bug reports">🐛</a></td>
427+
<td align="center"><a href="https://codeberg.org/cpence"><img src="https://avatars.githubusercontent.com/u/297075?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Pence</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=cpence" title="Code">💻</a></td>
428+
<td align="center"><a href="https://github.com/mstojanovic"><img src="https://avatars.githubusercontent.com/u/3449343?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marko Stojanovic</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=mstojanovic" title="Documentation">📖</a></td>
398429
</tr>
399430
<tr>
400-
<td align="center"><a href="https://github.com/clarkshaeffer"><img src="https://avatars.githubusercontent.com/u/58539767?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Clark</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=clarkshaeffer" title="Documentation">📖</a></td>
401-
<td align="center"><a href="https://github.com/wenzel-hoffman"><img src="https://avatars.githubusercontent.com/u/111205756?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wenzel</b></sub></a><br /><a href="https://github.com/dkarter/bullets.vim/commits?author=wenzel-hoffman" title="Code">💻</a></td>
431+
<td align="center"><a href="https://github.com/clarkshaeffer"><img src="https://avatars.githubusercontent.com/u/58539767?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Clark</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=clarkshaeffer" title="Documentation">📖</a></td>
432+
<td align="center"><a href="https://github.com/wenzel-hoffman"><img src="https://avatars.githubusercontent.com/u/111205756?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wenzel</b></sub></a><br /><a href="https://github.com/bullets-vim/bullets.vim/commits?author=wenzel-hoffman" title="Code">💻</a></td>
402433
</tr>
403434
</tbody>
404435
</table>

doc/bullets.txt

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
*bullets.txt* Automated Bullet Lists in Vim
22

33
Author: Dorian Karter <https://doriankarter.com>
4-
License: MIT (see LICENSE.md in https://github.com/dkarter/bullets.vim)
4+
License: MIT (see LICENSE.md in https://github.com/bullets-vim/bullets.vim)
55

66
TABLE OF CONTENTS *bullets-toc*
77

@@ -83,6 +83,11 @@ GENERAL COMMANDS *bullets-commands*
8383
A blank line before/after the first/last bullet denotes
8484
the end of the list.
8585

86+
*bullets-:RecomputeCheckboxes*
87+
:RecomputeCheckboxes Recomputes all partial checkboxes in the current list.
88+
Preserves state for all checkboxes with no children and
89+
recomputes all checkboxes up to the top of the list.
90+
8691
*bullets-:BulletDemote*
8792
:BulletDemote Demotes the current bullet by indenting it and changing
8893
its bullet type to the next level defined in
@@ -121,8 +126,8 @@ line.
121126

122127
Enable in empty buffers
123128
-----------------------
124-
bullets.vim is enabled in new empty buffers by default (buffers created with
125-
`:new` for example) to disable this feature add the following to your .vimrc:
129+
bullets.vim is disabled in new empty buffers by default (buffers created with
130+
`:new` for example) to enable this feature add the following to your .vimrc:
126131

127132
`let g:bullets_enable_in_empty_buffers = 1`
128133

@@ -148,7 +153,7 @@ To add a leader key to all mappings set the following:
148153
This will set the <space> key as leader to all default mappings.
149154

150155

151-
Disabling empty bullet deletion
156+
Empty bullet deletion
152157
-------------------------------
153158
By default bullets.vim will delete trailing empty bullets when the return key
154159
is pressed, just like modern word processors.
@@ -157,6 +162,10 @@ If you would like to turn this feature off add the following to your .vimrc
157162

158163
`let g:bullets_delete_last_bullet_if_empty = 0`
159164

165+
If you would like to promote bullet instead of deleting it, add the following to your .vimrc
166+
167+
`let g:bullets_delete_last_bullet_if_empty = 2`
168+
160169

161170
Maintain right padding on bullets
162171
---------------------------------

0 commit comments

Comments
 (0)