Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 1.49 KB

DEVELOP.md

File metadata and controls

47 lines (36 loc) · 1.49 KB

Developing Bareline

In case you are already using Lazy.nvim, you can install your local clone of the plugin as below:

{
  dir = "/path/to/bareline.nvim",
  opts = {}
},

Versioning

https://semver.org/

Releasing

Follow these manual steps:

  1. Tag the commit in the main branch with the semver version.
  2. Create a GitHub release from the tag.

Vim help file

  • The Vim help file bareline.txt is generated from bareline.lua through mini.doc (configuration in minidoc.lua).
  • Generate the Vim help file using the EX command lua MiniDoc.generate().
  • Recommended format options to facilitate proper hard wrapping:
-- Set default formatting options.
vim.o.formatoptions = "tcqjrn"
-- Improve pattern recognition for lists.
vim.o.formatlistpat = [[^\s*\d\+[\]:.)}\t ]\s*\|\s*[-*•]\s*]]
  • Throughout bareline.lua, comments beginning with DOCS: indicate something important to convey on documentation. When modifying sections close to these comments, honor them.

Tests

  • Tests are run with the EX command lua MiniTest.run() through mini.test.
  • To run all the tests you may run from a shell make or make test. You need GNU Make.
  • Tests should be kept as black-box as possible.