feat: golang (#34)

Author: bennypowers

README.md

@@ -78,7 +78,9 @@ After:
 
 - **ecmascript**: object, array, params, arguments
 - **lua**: table, params, arguments, variable_lists
+- **html**: tags, attributes
 - **css**: rules (blocks)
+- **go**: parameter lists, structs, return lists, arguments, slices, etc
 
 [vmp]: https://github.com/t9md/atom-vim-mode-plus
 [sjv]: https://github.com/AndrewRadev/splitjoin.vim

lua/splitjoin.lua

@@ -25,8 +25,8 @@ local Splitjoin = {}
 local function get_operable_node_under_cursor(bufnr, winnr)
   local row, col = unpack(vim.api.nvim_win_get_cursor(winnr))
   local cursor_range = { row - 1, col, row - 1, col }
-  -- TODO: cache a reference per bufnr
   local tsparser = get_parser(bufnr)
+     if tsparser == nil then return end
         tsparser:parse()
   local langtree = tsparser:language_for_range(cursor_range);
   local tstree = langtree:tree_for_range(cursor_range, { ignore_injections = false }) or langtree:trees()[1]

lua/splitjoin/languages/go/defaults.lua

@@ -0,0 +1,40 @@
+local Node = require'splitjoin.util.node'
+local Go = require'splitjoin.languages.go.functions'
+
+---@type SplitjoinLanguageConfig
+return {
+  default_indent = '  ',
+  nodes = {
+    -- Go struct fields
+    field_declaration_list = {
+      surround = { '{', '}' },
+      split = Go.split_struct,
+      join = Go.join_struct,
+    },
+
+    -- Go function parameters and return lists
+    parameter_list = {
+      surround = { '(', ')' },
+      separator = ',',
+      split = Node.split,
+      join = Node.join,
+      trailing_separator = true,
+    },
+
+    -- Go function call arguments
+    argument_list = {
+      surround = { '(', ')' },
+      separator = ',',
+      split = Node.split,
+      join = Node.join,
+    },
+
+    -- Go slice, map, and composite literals
+    literal_value = {
+      surround = { '{', '}' },
+      separator = ',',
+      split = Node.split,
+      join = Node.join,
+    }
+  }
+}

lua/splitjoin/languages/go/functions.lua

@@ -0,0 +1,48 @@
+local Node = require("splitjoin.util.node")
+
+local M = {}
+
+---@param node TSNode
+---@param options SplitjoinLanguageOptions
+function M.split_struct(node, options)
+  local indent = options.default_indent or "  "
+  local open, close = unpack(options.surround or {})
+  local lines = {}
+
+  table.insert(lines, open .. "\n")
+
+  for child in node:iter_children() do
+    if child:type() == "field_declaration" then
+      local text = vim.trim(Node.get_text(child))
+      table.insert(lines, indent .. text .. "\n")
+    end
+  end
+
+  table.insert(lines, close)
+  Node.replace(node, table.concat(lines, ""))
+  Node.goto_node(node)
+end
+
+---@param node TSNode
+---@param options SplitjoinLanguageOptions
+function M.join_struct(node, options)
+  local open, close = unpack(options.surround or {})
+  local padding = options.padding or ""
+  local parts = {}
+
+  for child in node:iter_children() do
+    if child:type() == "field_declaration" then
+      local text = vim.trim(Node.get_text(child))
+      if text:match(".*,%s*$") then
+        text = text:gsub(",%s*$", "")
+      end
+      table.insert(parts, text)
+    end
+  end
+
+  local final_string = open .. padding .. " " .. table.concat(parts, "; ") .. " " .. padding .. close
+  Node.replace(node, final_string)
+  Node.goto_node(node)
+end
+
+return M

lua/splitjoin/util/options.lua

@@ -22,6 +22,7 @@ local function get_defaults()
       json = require'splitjoin.languages.json.defaults',
       html = require'splitjoin.languages.html.defaults',
       css = require'splitjoin.languages.css.defaults',
+      go = require'splitjoin.languages.go.defaults',
     },
   }
   for name, mod in pairs(defaults.languages) do

queries/css/splitjoin.scm

@@ -5,3 +5,5 @@
   (selectors
     (_
        (arguments) @splitjoin.css.arguments)))
+
+((arguments) @splitjoin.css.arguments)

queries/go/splitjoin.scm

@@ -0,0 +1,4 @@
+(field_declaration_list) @splitjoin.target
+(literal_value) @splitjoin.target
+(parameter_list) @splitjoin.target
+(argument_list) @splitjoin.target

test/go_spec.lua

@@ -0,0 +1,102 @@
+local d = require'plenary.strings'.dedent
+local H = require'test.helpers'
+
+local lang = 'go'
+
+describe(lang, function()
+  H.make_suite(lang, 'struct',
+    d[[
+      type User struct { Name string; Age int; Email string }
+    ]],
+    d[[
+      type User struct {
+        Name string
+        Age int
+        Email string
+      }
+    ]],
+    '{'
+  )
+
+  H.make_suite(lang, 'params',
+    d[[
+      func Foo(a int, b string) (int, error) {}
+    ]],
+    d[[
+      func Foo(
+        a int,
+        b string,
+      ) (int, error) {}
+    ]],
+    'a'
+  )
+
+  H.make_suite(lang, 'return',
+    d[[
+      func Foo(a int, b string) (int, error) {}
+    ]],
+    d[[
+      func Foo(a int, b string) (
+        int,
+        error,
+      ) {}
+    ]],
+    'error'
+  )
+
+  H.make_suite(lang, 'args',
+    d[[
+      Foo(a, b, c)
+    ]],
+    d[[
+      Foo(
+        a,
+        b,
+        c,
+      )
+    ]],
+    'a'
+  )
+
+  H.make_suite(lang, 'slice',
+    d[=[
+      []string{"a", "b", "c"}
+    ]=],
+    d[=[
+      []string{
+        "a",
+        "b",
+        "c",
+      }
+    ]=],
+    '{'
+  )
+
+  H.make_suite(lang, 'map',
+    d[=[
+      map[string]int{"a": 1, "b": 2, "c": 3}
+    ]=],
+    d[=[
+      map[string]int{
+        "a": 1,
+        "b": 2,
+        "c": 3,
+      }
+    ]=],
+    '{'
+  )
+
+  H.make_suite(lang, 'composite literal',
+    d[=[
+      User{Name: "a", Age: 1, Email: "b"}
+    ]=],
+    d[=[
+      User{
+        Name: "a",
+        Age: 1,
+        Email: "b",
+      }
+    ]=],
+    '{'
+  )
+end)

test/helpers.lua

@@ -111,8 +111,7 @@ local function setup_buffer(content, lang, go_to)
 
   local bufnr = vim.api.nvim_get_current_buf()
 
-  local ts_parsers = require('nvim-treesitter.parsers')
-  local parser = ts_parsers.get_parser(bufnr, lang)
+  local parser = vim.treesitter.get_parser(bufnr, lang)
   if parser then parser:parse() end
   vim.wait(100)
 

test/init.lua

@@ -25,13 +25,14 @@ function M.setup()
 
   require'nvim-treesitter.configs'.setup {
     ensure_installed = {
-      'lua',
       'css',
-      'json',
-      'jsdoc',
+      'go',
+      'html',
       'javascript',
+      'jsdoc',
+      'json',
+      'lua',
       'typescript',
-      'html',
     },
     sync_install = true,
   }