Merge pull request #24 from JoosepAlviste/feature/ci

Author: JoosepAlviste

.github/workflows/default.yml

@@ -0,0 +1,16 @@
+name: default
+
+on: [pull_request]
+
+jobs:
+  lint:
+    name: Lint Lua code
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v2
+      - name: Stylua check
+        uses: JohnnyMorganz/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --color always --check .

lua/ts_context_commentstring.lua

@@ -4,7 +4,7 @@ function M.init()
   require('nvim-treesitter').define_modules {
     context_commentstring = {
       module_path = 'ts_context_commentstring.internal',
-    }
+    },
   }
 end
 

lua/ts_context_commentstring/integrations/vim_commentary.lua

@@ -2,14 +2,14 @@ local map = vim.api.nvim_buf_set_keymap
 
 local M = {}
 
--- Set up vim-commentary mappings to first update the commentstring, and then 
+-- Set up vim-commentary mappings to first update the commentstring, and then
 -- run vim-commentary
 function M.set_up_maps()
-  map(0, 'n', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], {expr = true})
-  map(0, 'x', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], {expr = true})
-  map(0, 'o', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], {expr = true})
-  map(0, 'n', 'gcc', [[v:lua.context_commentstring.update_commentstring_and_run('CommentaryLine')]], {expr = true})
-  map(0, 'n', 'cgc', [[v:lua.context_commentstring.update_commentstring_and_run('ChangeCommentary')]], {expr = true})
+  map(0, 'n', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], { expr = true })
+  map(0, 'x', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], { expr = true })
+  map(0, 'o', 'gc', [[v:lua.context_commentstring.update_commentstring_and_run('Commentary')]], { expr = true })
+  map(0, 'n', 'gcc', [[v:lua.context_commentstring.update_commentstring_and_run('CommentaryLine')]], { expr = true })
+  map(0, 'n', 'cgc', [[v:lua.context_commentstring.update_commentstring_and_run('ChangeCommentary')]], { expr = true })
 end
 
 return M

lua/ts_context_commentstring/internal.lua

@@ -1,14 +1,14 @@
 local api = vim.api
 
-local utils = require('ts_context_commentstring.utils')
-local configs = require('nvim-treesitter.configs')
+local utils = require 'ts_context_commentstring.utils'
+local configs = require 'nvim-treesitter.configs'
 
 local M = {}
 
--- The configuration object keys should be **treesitter** languages, NOT 
+-- The configuration object keys should be **treesitter** languages, NOT
 -- filetypes or file extensions.
 --
--- You can get the treesitter language for the current file by running this 
+-- You can get the treesitter language for the current file by running this
 -- command:
 -- `:lua print(require'nvim-treesitter.parsers'.get_buf_lang(0))`
 --
@@ -65,24 +65,22 @@ function M.setup_buffer()
   end
 
   if enable_autocmd then
-    utils.create_augroups({
+    utils.create_augroups {
       context_commentstring_ft = {
-        {'CursorHold', '<buffer>', [[lua require('ts_context_commentstring.internal').update_commentstring()]]},
+        { 'CursorHold', '<buffer>', [[lua require('ts_context_commentstring.internal').update_commentstring()]] },
       },
-    })
+    }
   end
 end
 
 -- Calculate the commentstring based on the current location of the cursor.
 --
--- **Note:** We should treat this function like a public API, try not to break 
+-- **Note:** We should treat this function like a public API, try not to break
 -- it!
 --
 -- @returns the commentstring or nil if not found
 function M.calculate_commentstring()
-  local node, language_tree = utils.get_node_at_cursor_start_of_line(
-    vim.tbl_keys(M.config)
-  )
+  local node, language_tree = utils.get_node_at_cursor_start_of_line(vim.tbl_keys(M.config))
 
   if not node and not language_tree then
     return nil
@@ -94,11 +92,11 @@ function M.calculate_commentstring()
   return M.check_node(node, language_config)
 end
 
--- Update the `commentstring` setting based on the current location of the 
--- cursor. If no `commentstring` can be calculated, will revert to the ofiginal 
+-- Update the `commentstring` setting based on the current location of the
+-- cursor. If no `commentstring` can be calculated, will revert to the ofiginal
 -- `commentstring` for the current file.
 --
--- **Note:** We should treat this function like a public API, try not to break 
+-- **Note:** We should treat this function like a public API, try not to break
 -- it!
 function M.update_commentstring()
   local found_commentstring = M.calculate_commentstring()
@@ -117,11 +115,13 @@ end
 -- Check if the given node matches any of the given types. If not, recursively
 -- check its parent node.
 function M.check_node(node, language_config)
-  -- There is no commentstring configuration for this language, use the 
+  -- There is no commentstring configuration for this language, use the
   -- `ts_original_commentstring`
-  if not language_config then return nil end
+  if not language_config then
+    return nil
+  end
 
-  -- There is no node, we have reached the top-most node, use the default 
+  -- There is no node, we have reached the top-most node, use the default
   -- commentstring from language config
   if not node then
     return language_config.__default or language_config
@@ -130,30 +130,31 @@ function M.check_node(node, language_config)
   local type = node:type()
   local match = language_config[type]
 
-  if match then return match end
+  if match then
+    return match
+  end
 
   -- Recursively check the parent node
   return M.check_node(node:parent(), language_config)
 end
 
 -- Attach the module to the current buffer
 function M.attach()
-  M.config = vim.tbl_deep_extend(
-    'force', M.config,
-    configs.get_module('context_commentstring').config or {}
-  )
+  M.config = vim.tbl_deep_extend('force', M.config, configs.get_module('context_commentstring').config or {})
 
   return M.setup_buffer()
 end
 
-function M.detach() return end
+function M.detach()
+  return
+end
 
 _G.context_commentstring = {}
 
--- Trigger re-calculation of the `commentstring` and trigger the given <Plug> 
+-- Trigger re-calculation of the `commentstring` and trigger the given <Plug>
 -- mapping right after that.
 --
--- This is in the global scope because 
+-- This is in the global scope because
 -- `v:lua.require('ts_context_commentstring')` does not work for some reason.
 function _G.context_commentstring.update_commentstring_and_run(mapping)
   M.update_commentstring()

lua/ts_context_commentstring/utils.lua

@@ -2,28 +2,28 @@ local api = vim.api
 local cmd = vim.cmd
 local fn = vim.fn
 
-local parsers = require('nvim-treesitter.parsers')
+local parsers = require 'nvim-treesitter.parsers'
 
 local M = {}
 
 function M.create_augroups(definitions)
   for group_name, definition in pairs(definitions) do
     cmd('augroup ' .. group_name)
-    cmd('autocmd!')
+    cmd 'autocmd!'
     for _, def in ipairs(definition) do
-      local command = table.concat(vim.tbl_flatten{'autocmd', def}, ' ')
+      local command = table.concat(vim.tbl_flatten { 'autocmd', def }, ' ')
       cmd(command)
     end
-    cmd('augroup END')
+    cmd 'augroup END'
   end
 end
 
--- Get the language tree from the given parser that is in the given range. Only 
--- accept the given languages. Ignores all language trees with a language not 
+-- Get the language tree from the given parser that is in the given range. Only
+-- accept the given languages. Ignores all language trees with a language not
 -- included in `only_languages` parameter.
 --
--- This function is pretty much copied from Neovim core 
--- (`LanguageTree:language_for_range`), but includes filtering of the injected 
+-- This function is pretty much copied from Neovim core
+-- (`LanguageTree:language_for_range`), but includes filtering of the injected
 -- languages.
 local function language_for_range(parser, range, only_languages)
   for _, child in pairs(parser._children) do
@@ -55,23 +55,25 @@ local function tree_contains(tree, range)
   return false
 end
 
--- Get the node that is on the same line as the cursor, but on the first 
--- NON-WHITESPACE character. This also handles injected languages via language 
+-- Get the node that is on the same line as the cursor, but on the first
+-- NON-WHITESPACE character. This also handles injected languages via language
 -- tree.
 --
 -- For example, if the cursor is at "|":
 --    |   <div>
 --
 -- then will return the <div> node, even though it isn't at the cursor position
 --
--- Returns the node at the cursor's line and the language tree for that 
+-- Returns the node at the cursor's line and the language tree for that
 -- injection.
 function M.get_node_at_cursor_start_of_line(only_languages, winnr)
-  if not parsers.has_parser() then return end
+  if not parsers.has_parser() then
+    return
+  end
 
   -- Get the position for the queried node
   local cursor = api.nvim_win_get_cursor(winnr or 0)
-  local first_non_whitespace_col = fn.match(fn.getline('.'), '\\S')
+  local first_non_whitespace_col = fn.match(fn.getline '.', '\\S')
   local range = {
     cursor[1] - 1,
     first_non_whitespace_col,
@@ -84,14 +86,16 @@ function M.get_node_at_cursor_start_of_line(only_languages, winnr)
   local language_tree = language_for_range(root, range, only_languages)
 
   -- Get the sub-tree of the language tree that contains the given range.
-  -- If there are multiple trees in the buffer for the same injected language, 
+  -- If there are multiple trees in the buffer for the same injected language,
   -- then we need to make sure that we are operating on the correct tree.
-  local tree = vim.tbl_filter(function (tree)
+  local tree = vim.tbl_filter(function(tree)
     return tree_contains(tree, range)
   end, language_tree:trees())[1]
 
   -- avoid crash on empty files
-  if not tree then return nil, language_tree end
+  if not tree then
+    return nil, language_tree
+  end
 
   -- Get the actual node on the location
   local injected_root = tree:root()

stylua.toml

@@ -0,0 +1,4 @@
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferSingle"
+no_call_parentheses = true