Add context commentstring

Author: arntanguy

lua/custom/plugins/Comment.lua

@@ -1,6 +1,10 @@
 return  {
   -- use "gc" to comment visual regions/lines
   'numToStr/Comment.nvim',
-  config = function() require('Comment').setup() end
+  dependencies = { 'JoosepAlviste/nvim-ts-context-commentstring' },
+  config = function() require('Comment').setup({
+      pre_hook = require('ts_context_commentstring.integrations.comment_nvim').create_pre_hook(),
+    })
+  end
 }
 

lua/custom/plugins/Comment.nvim

@@ -4,6 +4,7 @@ return { -- Highlight, edit, and navigate code
   event = {'BufReadPre', 'BufNewFile'},
   dependencies = {
     'nvim-treesitter/nvim-treesitter-textobjects',
+    'JoosepAlviste/nvim-ts-context-commentstring' -- language/context aware comment strings (ex: for JSX)
   },
   config = function()
     -- [[ Configure Treesitter ]] See `:help nvim-treesitter`

lua/custom/plugins/nvim-treesitter.lua

@@ -0,0 +1,13 @@
+return {
+  -- Context aware comment strings.
+  -- For instance JSX has two types of comments, // for regular javascript/typescript, and { /* ... */ } for JSX
+  -- This treesitter extension allows to set the correct comment string based on code context
+  -- Use Comment.nvim to apply the commentstrings easyly (with 'gcc')
+  "JoosepAlviste/nvim-ts-context-commentstring",
+  lazy = true, -- Only loaded when treesitter loads (since it is specified as a dependency of treesitter)
+  config = function()
+    require('ts_context_commentstring').setup {
+      enable_autocmd = false,
+    }
+  end,
+}