v1.1.0

[tmillr]

The diff appears to be large, but the changes are fairly trivial. For reference, here's a quick summary of the changes:

• Tweaked CHANGELOG.md (reduced indent from 3 to 2 spaces, reworded a couple things, fixed the URLs at the end of the file which were invalid comparisons/revision ranges)
• Finalized the CHANGELOG entry for this release. I decided on a minor release instead of patch release as there are several bug fixes and changes since v1.0.2, and also because of all of the highlight group changes made upstream.
• Tweaked the vimdoc changelog (improved imo). I replaced - with real unicode bullet points, fixed-up indenting and alignment (aligned elements to 80 chars according to the current modeline, tags should be right-aligned and either on the same line as the title/heading or the very next one up), improved the sections (e.g. added -------- section delimiters). I also added an entry to this changelog as well which covers all of the new and renamed hl groups as of nvim v0.10 (since the beginning of this year, 2024).
• Lastly I improved and strengthened the config types in config.lua (which are also/mainly used for the argument to setup() in order to provide LSP completion for users as well as help catch invalid keys/assignments/values in user config).

Note

I applied the class definitions in config.lua directly to the defaults table literal for a few reasons. One, it seems to improve the type-checking of defaults (because lua-ls is weird), particularly when it comes to the table literals nested within defaults (in comparison to just using ---@type SomeClassName on the defaults table). Two, it keeps the types/classes close-by when modifying the defaults themselves (i.e. the values) (e.g. you'll usually want to update both at the same time and keep them in-sync). On the other hand, doing it this way does make the file somewhat uglier and harder to read, but it's manageable.