Notice of breaking changes
kristijanhusak opened this issue · 18 comments
This pinned issue is used to announce breaking changes and other important information to the users.
Breaking changes will be announced at least a week in advance.
org tree-sitter grammar recently got a major overhaul. This breaks current code on master. Updated version is on PR #215. This will be merged in a week or so and tagged as v0.2
release. Going forward, there will be more frequent releases of minor and patch versions.
Changes that are required: https://github.com/nvim-orgmode/orgmode/pull/215/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L74-R75
Replace this:
local parser_config = require "nvim-treesitter.parsers".get_parser_configs()
parser_config.org = {
install_info = {
url = 'https://github.com/milisims/tree-sitter-org',
revision = 'f110024d539e676f25b72b7c80b0fd43c34264ef',
files = {'src/parser.c', 'src/scanner.cc'},
},
filetype = 'org',
}
With this:
require('orgmode').setup_ts_grammar()
And run:
:TSUpdate org
If above change is not done, proper error message will be printed out with instructions.
#215 is now merged into master, and tagged as 0.2
release.
org_agenda_templates
was renamed to org_capture_templates
as per #223. Old org_agenda_templates
option will keep working, but everyone should switch to the new one.
Support for Neovim versions under v0.7 will be dropped due to nvim-treesitter requiring Neovim v0.7. Nvim-treesitter doesn't have any versioning so it's hard to follow proper nvim-treesitter version for older Neovim.
Insert mode <CR>
mapping was added with 35f4fb6 , for purposes of adding new row in a table which can now be formatted (per 87291af).
If your <CR>
is misbehaving, you can disable the mapping like this:
require('orgmode').setup({
mappings = {
org_return = false
}
})
Please report any issues found with it.
Headline tags in org files are now right aligned according to the org_tags_column
setting instead of left aligned, to match Emacs Orgmode implementation. This shouldn't cause any breaking changes, but changing tags on a headline from now on will most likely be differently aligned than before.
Before:
* TODO Something :TEST:
* TODO Something else :TESTING:
After:
* TODO Something :TEST:
* TODO Something else :TESTING:
Official support for Neovim versions < 0.8 will be dropped in the following weeks. Most likely nothing will break for some time, but since nvim-treesitter
requires 0.8+, support for lower versions would be impossible.
Folding is now using nvim-treesitter
folding via tree-sitter queries instead of custom implementation (PR #523). If anyone finds any differences or bugs between old and new implementation please open up an issue.
Support for Neovim versions < 0.8.3 are officially dropped. Everything should still work, but future changes might cause some breaking issus.