Move custom ts grammer configuration to setup function.

Author: kristijanhusak

.github/workflows/tests.yml

@@ -17,6 +17,7 @@ jobs:
           - v0.5.0
           - v0.5.1
           - v0.6.0
+          - v0.6.1
           - nightly
     runs-on: ubuntu-latest
     steps:

DOCS.md

@@ -86,6 +86,8 @@ Available options:
 * underline - `:underline on`
 * italic - `:slant italic`
 
+---
+
 Full configuration example with additional todo keywords and their colors:
 ```lua
 require('orgmode').setup({
@@ -1183,6 +1185,7 @@ set statusline=%{v:lua.orgmode.statusline()}
 ```
 
 ## Changelog
+To track breaking changes, subscribe to [Notice of breaking changes](https://github.com/nvim-orgmode/orgmode/issues/217) issue where those are announced.
 
 #### 24 October 2021
 * Help mapping was changed from `?` to `g?` to avoid conflict with built in backward search. See issue [#106](https://github.com/nvim-orgmode/orgmode/issues/106).

README.md

@@ -71,16 +71,10 @@ call dein#add('nvim-orgmode/orgmode')
 ```lua
 -- init.lua
 
-local parser_config = require "nvim-treesitter.parsers".get_parser_configs()
-parser_config.org = {
-  install_info = {
-    url = 'https://github.com/milisims/tree-sitter-org',
-    revision = 'main',
-    files = {'src/parser.c', 'src/scanner.cc'},
-  },
-  filetype = 'org',
-}
+-- Load custom tree-sitter grammar for org filetype
+require('orgmode').setup_ts_grammar()
 
+-- Tree-sitter configuration
 require'nvim-treesitter.configs'.setup {
   -- If TS highlights are not enabled at all, or disabled via `disable` prop, highlighting will fallback to default Vim syntax highlighting
   highlight = {
@@ -101,16 +95,11 @@ Or if you are using `init.vim`:
 ```vim
 " init.vim
 lua << EOF
-local parser_config = require "nvim-treesitter.parsers".get_parser_configs()
-parser_config.org = {
-  install_info = {
-    url = 'https://github.com/milisims/tree-sitter-org',
-    revision = 'main',
-    files = {'src/parser.c', 'src/scanner.cc'},
-  },
-  filetype = 'org',
-}
 
+-- Load custom tree-sitter grammar for org filetype
+require('orgmode').setup_ts_grammar()
+
+-- Tree-sitter configuration
 require'nvim-treesitter.configs'.setup {
   -- If TS highlights are not enabled at all, or disabled via `disable` prop, highlighting will fallback to default Vim syntax highlighting
   highlight = {

doc/orgmode.txt

@@ -261,6 +261,7 @@ Available options:
 * underline - `:underline on`
 * italic - `:slant italic`
 
+--------------------------------------------------------------------------------
 Full configuration example with additional todo keywords and their colors:
 >
     require('orgmode').setup({
@@ -1572,6 +1573,8 @@ Show the currently clocked in headline (if any), with total clocked time / effor
 --------------------------------------------------------------------------------
 CHANGELOG                                                      *orgmode-changelog*
 
+To track breaking changes, subscribe to Notice of breaking changes (https://github.com/nvim-orgmode/orgmode/issues/217) issue where those are announced.
+
 24 OCTOBER 2021                                          *orgmode-24_october_2021*
 
 *   Help mapping was changed from `?` to `g?` to avoid conflict with built in backward search. See issue #106 (https://github.com/nvim-orgmode/orgmode/issues/106).

lua/orgmode/init.lua

@@ -1,4 +1,7 @@
-_G.orgmode = _G.orgmode or {}
+_G.orgmode = _G.orgmode or {
+  ts_revision = '1c3eb533a9cf6800067357b59e03ac3f91fc3a54',
+}
+local setup_ts_grammar_used = false
 local instance = nil
 
 ---@class Org
@@ -58,10 +61,42 @@ function Org:setup_autocmds()
   vim.cmd([[augroup END]])
 end
 
+--- @param revision string?
+local function setup_ts_grammar(revision)
+  setup_ts_grammar_used = true
+  local parser_config = require('nvim-treesitter.parsers').get_parser_configs()
+  parser_config.org = {
+    install_info = {
+      url = 'https://github.com/milisims/tree-sitter-org',
+      revision = revision or _G.orgmode.ts_revision,
+      files = { 'src/parser.c', 'src/scanner.cc' },
+    },
+    filetype = 'org',
+  }
+end
+
+local function check_ts_grammar()
+  if setup_ts_grammar_used then
+    return
+  end
+  vim.defer_fn(function()
+    local parser_config = require('nvim-treesitter.parsers').get_parser_configs()
+    if parser_config and parser_config.org and parser_config.org.install_info.revision ~= _G.orgmode.ts_revision then
+      require('orgmode.utils').echo_error({
+        'You are using outdated version of tree-sitter grammar for Orgmode.',
+        'To use latest version, replace current grammar installation with "require(\'orgmode\').setup_ts_grammar()" and run :TSUpdate org.',
+        'More info in setup section of readme: https://github.com/nvim-orgmode/orgmode#setup',
+      })
+    end
+  end, 200)
+end
+
 ---@param opts? table
 ---@return Org
 local function setup(opts)
+  opts = opts or {}
   instance = Org:new()
+  check_ts_grammar()
   local config = require('orgmode.config'):extend(opts)
   vim.defer_fn(function()
     if config.notifications.enabled and #vim.api.nvim_list_uis() > 0 then
@@ -140,6 +175,7 @@ function _G.orgmode.statusline()
 end
 
 return {
+  setup_ts_grammar = setup_ts_grammar,
   setup = setup,
   reload = reload,
   action = action,

lua/orgmode/parser/file.lua

@@ -381,12 +381,12 @@ function File:_parse_source_code_filetypes()
 end
 
 function File:_parse_directives()
-  local directives = self:get_ts_matches(
-    [[(directive name: (expr) @name value: (value) @value (#match? @name "\\cfiletags"))]]
-  )
+  local directives = self:get_ts_matches([[(directive name: (expr) @name value: (value) @value)]])
   local tags = {}
   for _, directive in ipairs(directives) do
-    utils.concat(tags, utils.parse_tags_string(directive.value.text), true)
+    if directive.name.text:lower() == 'filetags' then
+      utils.concat(tags, utils.parse_tags_string(directive.value.text), true)
+    end
   end
   self.tags = tags
 end