feat(cli)!: new user command interface

Replaced `TSContextEnable`, `TSContextDisable`,
`TSContextToggle` with `TSContext` with `enable`,
`disable` and `toggle` as subcommands.

Also moved init code into `plugin/`.

Author: lewis6991

README.md

@@ -378,7 +378,7 @@ require'treesitter-context'.setup{
 
 ## Commands
 
-`TSContextEnable`, `TSContextDisable` and `TSContextToggle`.
+`TSContext` with subcommands `enable`, `disable` and `toggle`.
 
 ## Appearance
 

doc/nvim-treesitter-context.txt

@@ -64,7 +64,7 @@ not required.
 ==============================================================================
 COMMANDS                                      *nvim-treesitter-context-commands*
 
-`TSContextEnable`, `TSContextDisable` and `TSContextToggle`.
+`TSContext` with subcommands `enable`, `disable` and `toggle`
 
 ==============================================================================
 HIGHLIGHTS                                  *nvim-treesitter-context-highlights*

lua/treesitter-context.lua

@@ -3,7 +3,6 @@ local api = vim.api
 local config = require('treesitter-context.config')
 
 local augroup = api.nvim_create_augroup
-local command = api.nvim_create_user_command
 
 local enabled = false
 
@@ -266,24 +265,6 @@ function M.enabled()
   return enabled
 end
 
-local function init()
-  command('TSContextEnable', M.enable, {})
-  command('TSContextDisable', M.disable, {})
-  command('TSContextToggle', M.toggle, {})
-
-  api.nvim_set_hl(0, 'TreesitterContext', { link = 'NormalFloat', default = true })
-  api.nvim_set_hl(0, 'TreesitterContextLineNumber', { link = 'LineNr', default = true })
-  api.nvim_set_hl(0, 'TreesitterContextBottom', { link = 'NONE', default = true })
-  api.nvim_set_hl(
-    0,
-    'TreesitterContextLineNumberBottom',
-    { link = 'TreesitterContextBottom', default = true }
-  )
-  api.nvim_set_hl(0, 'TreesitterContextSeparator', { link = 'FloatBorder', default = true })
-end
-
-local did_init = false
-
 --- @param options? TSContext.UserConfig
 function M.setup(options)
   -- NB: setup  may be called several times.
@@ -297,11 +278,6 @@ function M.setup(options)
   else
     M.disable()
   end
-
-  if not did_init then
-    init()
-    did_init = true
-  end
 end
 
 --- @param depth integer? default 1

lua/treesitter-context/cli.lua

@@ -0,0 +1,38 @@
+local subcmds = { 'enable', 'disable', 'toggle' }
+
+local M = {}
+
+--- @param command string
+local function do_subcmd(command)
+  local TSContext = require('treesitter-context')
+  if TSContext[command] then
+    TSContext[command]()
+  else
+    vim.notify('TSContext: Unknown command ' .. command, vim.log.levels.ERROR)
+  end
+end
+
+--- @param args string[]
+function M.run(args)
+  if #args == 0 then
+    vim.ui.select(subcmds, {
+      prompt = 'Treesitter Context: ',
+      format_item = function(item)
+        return item:sub(1, 1):upper() .. item:sub(2)
+      end,
+    }, function(choice)
+      if choice then
+        do_subcmd(choice)
+      end
+    end)
+    return
+  end
+
+  do_subcmd(args[1])
+end
+
+function M.complete()
+  return subcmds
+end
+
+return M

plugin/treesitter-context.lua

@@ -1 +1,19 @@
-require('treesitter-context').setup()
+vim.api.nvim_create_user_command('TSContext', function(args)
+  require('treesitter-context.cli').run(args.fargs)
+end, {
+  complete = function()
+    return require('treesitter-context.cli').complete()
+  end,
+  nargs = '*',
+  desc = 'Manage Treesitter Context',
+})
+
+vim.api.nvim_set_hl(0, 'TreesitterContext', { link = 'NormalFloat', default = true })
+vim.api.nvim_set_hl(0, 'TreesitterContextLineNumber', { link = 'LineNr', default = true })
+vim.api.nvim_set_hl(0, 'TreesitterContextBottom', { link = 'NONE', default = true })
+vim.api.nvim_set_hl(
+  0,
+  'TreesitterContextLineNumberBottom',
+  { link = 'TreesitterContextBottom', default = true }
+)
+vim.api.nvim_set_hl(0, 'TreesitterContextSeparator', { link = 'FloatBorder', default = true })

test/contexts_spec.lua

@@ -6,8 +6,6 @@ local api = helpers.api
 local fn = helpers.fn
 
 local tc_helpers = require('test.helpers')
-local install_langs = tc_helpers.install_langs
-local get_langs = tc_helpers.get_langs
 
 --- @param line string
 --- @return string?
@@ -70,7 +68,7 @@ local function install_langs_for_file(filename, root_lang)
     if seen_langs[current_lang] then
       goto continue
     end
-    exec_lua(install_langs, current_lang)
+    exec_lua(tc_helpers.install_langs, current_lang)
 
     -- Query for injections in the current language, and queue them for installation.
     --- @diagnostic disable-next-line: redefined-local Not actually redefining locals
@@ -110,7 +108,7 @@ local function install_langs_for_file(filename, root_lang)
   end
 end
 
-local langs = get_langs()
+local langs = tc_helpers.get_langs()
 local langs_with_queries = {} --- @type string[]
 for _, lang in ipairs(langs) do
   if vim.uv.fs_stat('queries/' .. lang .. '/context.scm') then
@@ -122,8 +120,7 @@ local lang_to_test_files = {} --- @type table<string,string[]>
 setup(function()
   helpers.clear()
   exec_lua(tc_helpers.setup)
-
-  exec_lua(install_langs, 'lua')
+  exec_lua(tc_helpers.install_langs, 'lua')
 
   local test_files = fn.globpath('test/lang', '*', true, true) --- @type string[]
   for _, test_file in ipairs(test_files) do

test/helpers.lua

@@ -43,7 +43,8 @@ function M.get_langs()
   return langs
 end
 
-function M.setup()
+--- @param opts? TSContext.UserConfig
+function M.setup(opts)
   -- Do not pull in parsers from /usr/local/share/ as they may
   -- be the wrong ABI
   vim.opt.runtimepath = {
@@ -55,6 +56,10 @@ function M.setup()
     install_dir = vim.fs.joinpath('deps', 'nvim-treesitter-data'),
   })
 
+  require('treesitter-context').setup(opts)
+  -- Need to source plugin to define highlights for screen tests
+  vim.cmd.source(vim.api.nvim_get_runtime_file('plugin/treesitter-context.lua', false)[1])
+
   vim.env.XDG_CACHE_HOME = 'scratch/cache'
   vim.opt.packpath = ''
 end

test/queries_spec.lua

@@ -3,8 +3,6 @@ local helpers = require('nvim-test.helpers')
 local exec_lua = helpers.exec_lua
 
 local tc_helpers = require('test.helpers')
-local install_langs = tc_helpers.install_langs
-local get_langs = tc_helpers.get_langs
 
 describe('query:', function()
   local readme_lines = {} --- @type string[]
@@ -20,7 +18,7 @@ describe('query:', function()
     f:close()
   end)
 
-  for _, lang in ipairs(get_langs()) do
+  for _, lang in ipairs(tc_helpers.get_langs()) do
     it(lang, function()
       local lang_index --- @type integer
       local last_supported_lang_index --- @type integer
@@ -50,16 +48,18 @@ describe('query:', function()
       if not vim.uv.fs_stat('queries/' .. lang .. '/context.scm') then
         table.insert(readme_lines, last_lang_index, ('  - [ ] `%s`'):format(lang))
         pending('no queries/' .. lang .. '/context.scm')
-      else
-        exec_lua(install_langs, lang)
-        local ok = exec_lua([[return pcall(vim.treesitter.query.get, ...)]], lang, 'context')
-        table.insert(
-          readme_lines,
-          last_supported_lang_index,
-          ('  - [x] `%s`%s'):format(lang, ok and '' or ' (broken)')
-        )
-        assert(ok)
+        return
       end
+      exec_lua(tc_helpers.install_langs, lang)
+      local ok = exec_lua(function(...)
+        return (pcall(vim.treesitter.query.get, ...))
+      end, lang, 'context')
+      table.insert(
+        readme_lines,
+        last_supported_lang_index,
+        ('  - [x] `%s`%s'):format(lang, ok and '' or ' (broken)')
+      )
+      assert(ok)
     end)
   end
 

test/ts_context_spec.lua

@@ -58,12 +58,12 @@ describe('ts_context', function()
   end)
 
   it('load the plugin', function()
-    exec_lua([[require'treesitter-context'.setup{}]])
+    exec_lua(tc_helpers.setup)
   end)
 
   it('edit a file', function()
     exec_lua(install_langs, 'lua')
-    exec_lua([[require'treesitter-context'.setup{}]])
+    exec_lua(tc_helpers.setup)
     cmd('edit test/test_file.lua')
     exec_lua([[vim.treesitter.start()]])
     feed('<C-e>')
@@ -107,9 +107,9 @@ describe('ts_context', function()
 
   describe('language:', function()
     before_each(function()
-      exec_lua([[require'treesitter-context'.setup{
+      exec_lua(tc_helpers.setup, {
         mode = 'topline',
-      }]])
+      })
       cmd('set scrolloff=5')
       cmd('set nowrap')
     end)