Merge branch 'master' into configuratble_bullet_styles

Author: dkarter

.all-contributorsrc

@@ -147,6 +147,24 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "clarkshaeffer",
+      "name": "Clark",
+      "avatar_url": "https://avatars.githubusercontent.com/u/58539767?v=4",
+      "profile": "https://github.com/clarkshaeffer",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "wenzel-hoffman",
+      "name": "Wenzel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/111205756?v=4",
+      "profile": "https://github.com/wenzel-hoffman",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.0"]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v2
+
+    - name: Install dependencies
+      run: sudo apt install vim-gtk3 xvfb
+
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run headless tests
+      uses: GabrielBB/xvfb-action@v1
+      with:
+        run: bundle exec rspec

.tool-versions

@@ -1 +1 @@
-ruby 2.7.0
+ruby 3.1.0

README.md

@@ -1,11 +1,13 @@
 ![Bullets.vim](img/bullets-vim-logo.svg)
 
-[![Build Status](https://travis-ci.org/dkarter/bullets.vim.svg?branch=master)](https://travis-ci.org/dkarter/bullets.vim) 
+[![Build Status](https://travis-ci.org/dkarter/bullets.vim.svg?branch=master)](https://travis-ci.org/dkarter/bullets.vim)
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
+> :information_source: Looking for help/maintainers https://github.com/dkarter/bullets.vim/issues/126
+
 # Description
 
 Bullets.vim is a Vim plugin for automated bullet lists.
@@ -22,7 +24,14 @@ Renumbering lines:
 
 # Installation
 
-With VimPlug:
+### With Vim 8.1+ native package manager:
+Clone into
+
+`.vim/pack/plugins/start`
+
+Make sure to include `packloadall` in your `vimrc`.
+
+### With VimPlug:
 
 ```vim
 Plug 'dkarter/bullets.vim'
@@ -70,6 +79,36 @@ Add a leader key before default mappings:
 let g:bullets_mapping_leader = '<M-b>' " default = ''
 ```
 
+Customize key mappings:
+
+```vim
+let g:bullets_set_mappings = 0 " disable adding default key mappings, default = 1
+
+" default = []
+" N.B. You can set these mappings as-is without using this g:bullets_custom_mappings option but it
+" will apply in this case for all file types while when using g:bullets_custom_mappings it would
+" take into account file types filter set in g:bullets_enabled_file_types, and also
+" g:bullets_enable_in_empty_buffers option.
+let g:bullets_custom_mappings = [
+  \ ['imap', '<cr>', '<Plug>(bullets-newline)'],
+  \ ['inoremap', '<C-cr>', '<cr>'],
+  \
+  \ ['nmap', 'o', '<Plug>(bullets-newline)'],
+  \
+  \ ['vmap', 'gN', '<Plug>(bullets-renumber)'],
+  \ ['nmap', 'gN', '<Plug>(bullets-renumber)'],
+  \
+  \ ['nmap', '<leader>x', '<Plug>(bullets-toggle-checkbox)'],
+  \
+  \ ['imap', '<C-t>', '<Plug>(bullets-demote)'],
+  \ ['nmap', '>>', '<Plug>(bullets-demote)'],
+  \ ['vmap', '>', '<Plug>(bullets-demote)'],
+  \ ['imap', '<C-d>', '<Plug>(bullets-promote)'],
+  \ ['nmap', '<<', '<Plug>(bullets-promote)'],
+  \ ['vmap', '<', '<Plug>(bullets-promote)'],
+  \ ]
+```
+
 Enable/disable deleting the last empty bullet when hitting `<cr>` (insert mode) or `o` (normal mode):
 
 ```vim
@@ -175,7 +214,7 @@ let g:bullets_nested_checkboxes = 1 " default = 1
 "   - [ ] child bullet  [ type <leader>x ]
 "     - [ ] sub-child
 "   - [ ] child bullet
-" 
+"
 " Result:
 " - [o] first bullet   [ <- indicates partial completion of sub-tasks ]
 "   - [X] child bullet
@@ -216,18 +255,18 @@ let g:bullets_checkbox_partials_toggle = 1 " default = 1
 " - [o] partially checked  [ type <leader>x ]
 "   - [x] sub bullet
 "   - [ ] sub bullet
-" 
+"
 " Result:
 " - [x] checked
 "   - [x] sub bullet
 "   - [x] sub bullet
-" 
+"
 " Example 2:
 let g:bullets_checkbox_partials_toggle = 0
 " - [o] partially checked  [ type <leader>x ]
 "   - [x] sub bullet
 "   - [ ] sub bullet
-" 
+"
 " Result:
 " - [ ] checked
 "   - [ ] sub bullet
@@ -260,7 +299,7 @@ let g:bullets_set_mappings = 0
 Add a leader key before default mappings:
 
 ```vim
-let g:bullets_mapping_leader = '<M-b>' 
+let g:bullets_mapping_leader = '<M-b>'
 " Set <M-b> to the leader before all default mappings:
 " Example: renumbering becomes `<M-b>gN` instead of just `gN`
 ```
@@ -338,24 +377,30 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-  </tr>
-  <tr>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-    <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>
-  </tr>
+  <tbody>
+    <tr>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+    </tr>
+    <tr>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+      <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>
+    </tr>
+    <tr>
+      <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>
+      <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>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->