feat(surround)!: make use_nvim_treesitter=false treesitter() default

Details:
- It was originally present because it was more capable than built-in
  `vim.treesitter`. Now this is not the case, so it is not needed
  anymore. Making it default to `false` is the first step towards
  deprecating it completely (after the next release).
  Besides, 'nvim-treesitter/nvim-treesitter' is actively moving towards
  making `main` branch default which doesn't have necessary
  capabilities that `master` branch has.

Author: echasnovski

CHANGELOG.md

@@ -59,6 +59,12 @@ There are following change types:
 
 - "Paste" action now supports special registers: `<C-w>` (word at cursor), `<C-a>` (WORD at cursor), `<C-l>` (line at cursor), `<C-f>` (filename at cursor).
 
+## mini.surround
+
+### Refine
+
+- Update `gen_spec.inpuf.treesitter()` to have `use_nvim_treesitter = false` as default option value (instead of `true`). It used to implement more advanced behavior, but as built-in `vim.treesitter` is capable enough, there is no need in extra dependency. The option will be removed after the release.
+
 ## mini.test
 
 ### Refine

doc/mini-surround.txt

@@ -819,10 +819,6 @@ Example configuration for function definition textobject with
   })
 <
 Notes:
-- By default query is done using 'nvim-treesitter' plugin if it is present
-  (falls back to builtin methods otherwise). This allows for a more
-  advanced features (like multiple buffer languages, custom directives, etc.).
-  See `opts.use_nvim_treesitter` for how to disable this.
 - Be sure that query files don't contain unknown |treesitter-directives|
   (like `#make-range!`, for example). Otherwise surrounding with such captures
   might not be found as |vim.treesitter| won't treat them as captures. Verify
@@ -841,9 +837,11 @@ Parameters ~
   should be a string capture starting with `'@'`.
 {opts} `(table|nil)` Options. Possible values:
   - <use_nvim_treesitter> - whether to try to use 'nvim-treesitter' plugin
-    (if present) to do the query. It implements more advanced behavior at
-    cost of increased execution time. Provides more coherent experience if
-    'nvim-treesitter-textobjects' queries are used. Default: `true`.
+    (if present) to do the query. It used to implement more advanced behavior
+    and more coherent experience if 'nvim-treesitter-textobjects' queries are
+    used. However, as |lua-treesitter-core| methods are more capable now,
+    the option will soon be removed. Only present for backward compatibility.
+    Default: `false`.
 
 Return ~
 `(function)` Function which returns array of current buffer region pairs
@@ -852,7 +850,7 @@ Return ~
 See also ~
 |MiniSurround-surround-specification| for how this type of
   surrounding specification is processed.
-|get_query()| for how query is fetched in case of no 'nvim-treesitter'.
+|vim.treesitter.get_query()| for how query is fetched.
 |Query:iter_captures()| for how all query captures are iterated in case of
   no 'nvim-treesitter'.
 |MiniAi.gen_spec.treesitter()| for similar 'mini.ai' generator.

lua/mini/surround.lua

@@ -1011,10 +1011,6 @@ MiniSurround.gen_spec = { input = {}, output = {} }
 ---   })
 --- <
 --- Notes:
---- - By default query is done using 'nvim-treesitter' plugin if it is present
----   (falls back to builtin methods otherwise). This allows for a more
----   advanced features (like multiple buffer languages, custom directives, etc.).
----   See `opts.use_nvim_treesitter` for how to disable this.
 --- - Be sure that query files don't contain unknown |treesitter-directives|
 ---   (like `#make-range!`, for example). Otherwise surrounding with such captures
 ---   might not be found as |vim.treesitter| won't treat them as captures. Verify
@@ -1032,21 +1028,24 @@ MiniSurround.gen_spec = { input = {}, output = {} }
 ---   should be a string capture starting with `'@'`.
 ---@param opts table|nil Options. Possible values:
 ---   - <use_nvim_treesitter> - whether to try to use 'nvim-treesitter' plugin
----     (if present) to do the query. It implements more advanced behavior at
----     cost of increased execution time. Provides more coherent experience if
----     'nvim-treesitter-textobjects' queries are used. Default: `true`.
+---     (if present) to do the query. It used to implement more advanced behavior
+---     and more coherent experience if 'nvim-treesitter-textobjects' queries are
+---     used. However, as |lua-treesitter-core| methods are more capable now,
+---     the option will soon be removed. Only present for backward compatibility.
+---     Default: `false`.
 ---
 ---@return function Function which returns array of current buffer region pairs
 ---   representing differences between outer and inner captures.
 ---
 ---@seealso |MiniSurround-surround-specification| for how this type of
 ---   surrounding specification is processed.
---- |get_query()| for how query is fetched in case of no 'nvim-treesitter'.
+--- |vim.treesitter.get_query()| for how query is fetched.
 --- |Query:iter_captures()| for how all query captures are iterated in case of
 ---   no 'nvim-treesitter'.
 --- |MiniAi.gen_spec.treesitter()| for similar 'mini.ai' generator.
 MiniSurround.gen_spec.input.treesitter = function(captures, opts)
-  opts = vim.tbl_deep_extend('force', { use_nvim_treesitter = true }, opts or {})
+  -- TODO: Remove after releasing 'mini.nvim' 0.17.0
+  opts = vim.tbl_deep_extend('force', { use_nvim_treesitter = false }, opts or {})
   captures = H.prepare_captures(captures)
 
   return function()

tests/test_surround.lua

@@ -303,14 +303,13 @@ T['gen_spec']['input']['treesitter()']['respects `opts.use_nvim_treesitter`'] =
     O = {
       input = MiniSurround.gen_spec.input.treesitter(
         { outer = '@plugin_other.outer', inner = '@plugin_other.inner' },
-        { use_nvim_treesitter = false }
+        { use_nvim_treesitter = true }
       )
     },
   }]])
   local lines = get_lines()
 
-  -- By default it should be `true` but fall back to builtin if no
-  -- 'nvim-treesitter' is found
+  -- By default it should be `false`
   validate_find(lines, { 9, 0 }, { { 10, 12 }, { 11, 2 }, { 7, 6 }, { 8, 1 } }, type_keys, 'sf', 'F')
   validate_no_find(lines, { 1, 0 }, type_keys, 'sf', 'o')
   validate_no_find(lines, { 1, 0 }, type_keys, 'sf', 'O')
@@ -319,10 +318,8 @@ T['gen_spec']['input']['treesitter()']['respects `opts.use_nvim_treesitter`'] =
   -- Should prefer range from metadata instead of node itself. This is useful,
   -- for example, with `#offset!` directive to create more precise captures.
   validate_find(lines, { 9, 0 }, { { 10, 12 }, { 11, 2 }, { 7, 6 }, { 8, 1 } }, type_keys, 'sf', 'F')
-  validate_find(lines, { 1, 0 }, { { 1, 5 }, { 1, 0 } }, type_keys, 'sf', 'o')
-
-  -- Should respect `false` value
-  validate_no_find(lines, { 1, 0 }, type_keys, 'sf', 'O')
+  validate_no_find(lines, { 1, 0 }, type_keys, 'sf', 'o')
+  validate_find(lines, { 1, 0 }, { { 1, 5 }, { 1, 0 } }, type_keys, 'sf', 'O')
 end
 
 T['gen_spec']['input']['treesitter()']['respects plugin options'] = function()