github

folke / ts-comments.nvim

  • пятница, 24 мая 2024 г. в 00:00:02
https://github.com/folke/ts-comments.nvim

Tiny plugin to enhance Neovim's native comments



🚀 ts-comments.nvim

Tiny plugin to enhance Neovim's native comments:

  • Easily override the comment string for a given treesitter language
  • Supports different comment strings for different treesitter node types
  • Relaxed rules for uncommenting
  • Add proper whitespace when needed
  • Supports multiple commentstrings for the same language. The first one is used for adding comments. All are used for uncommenting.

⚡️ Requirements

  • Neovim >= 0.10.0

📦 Installation

Using lazy.nvim:

{
  "folke/ts-comments.nvim",
  opts = {},
  event = "VeryLazy",
  enabled = vim.fn.has("nvim-0.10.0") == 1,
}

⚙️ Configuration

ts-comments.nvim uses the default Neovim commentstring as a fallback, so there's no need to configure every language.

Default configuration:

{
  lang = {
    astro = "<!-- %s -->",
    axaml = "<!-- %s -->",
    blueprint = "// %s",
    c = "// %s",
    c_sharp = "// %s",
    clojure = { ";; %s", "; %s" },
    cpp = "// %s",
    cs_project = "<!-- %s -->",
    css = "/* %s */",
    cue = "// %s",
    fsharp = "// %s",
    fsharp_project = "<!-- %s -->",
    gleam = "// %s",
    glimmer = "{{! %s }}",
    handlebars = "{{! %s }}",
    hcl = "# %s",
    html = "<!-- %s -->",
    ini = "; %s",
    javascript = {
      "// %s", -- default commentstring when no treesitter node matches
      "/* %s */",
      call_expression = "// %s", -- specific commentstring for call_expression
      jsx_attribute = "// %s",
      jsx_element = "{/* %s */}",
      jsx_fragment = "{/* %s */}",
      spread_element = "// %s",
      statement_block = "// %s",
    },
    lua = { "-- %s", "--- %s" }, -- langs can have multiple commentstrings
    ocaml = "(* %s *)",
    php = "// %s",
    rego = "# %s",
    rescript = "// %s",
    rust = { "// %s", "/* %s */", "/// %s" },
    svelte = "<!-- %s -->",
    terraform = "# %s",
    tsx = {
      "// %s", -- default commentstring when no treesitter node matches
      "/* %s */",
      call_expression = "// %s", -- specific commentstring for call_expression
      jsx_attribute = "// %s",
      jsx_element = "{/* %s */}",
      jsx_fragment = "{/* %s */}",
      spread_element = "// %s",
      statement_block = "// %s",
    },
    twig = "{# %s #}",
    typescript = "// %s",
    vim = '" %s',
    vue = "<!-- %s -->",
    xaml = "<!-- %s -->",
    xml = "<!-- %s -->",
  },
}

🔗 Related