5 Commits
Author SHA1 Message Date
zoriya ba6670cac7 Add csharp commentstring 2024-05-21 17:26:29 +02:00
github-actions[bot] 57e6c133c6 chore(build): auto-generate vimdoc 2024-05-20 22:28:49 +00:00
ilyas akınandGitHub d289353975 docs: add missing trailing comma (#3) 2024-05-21 00:28:20 +02:00
github-actions[bot] 055470b331 chore(build): auto-generate vimdoc 2024-05-20 21:42:22 +00:00
Folke Lemaitre 6e84c5b4b0 docs: update 2024-05-20 23:41:52 +02:00
3 changed files with 17 additions and 19 deletions
+7 -6
View File
@@ -1,28 +1,28 @@
# 🚀 ts-comments.nvim # 🚀 `ts-comments.nvim`
Tiny plugin to enhance Neovim's native comments: Tiny plugin to enhance Neovim's native comments:
- Easily override the comment string for a given **treesitter** language - Easily override the comment string for a given **treesitter** language
- Supports different comment strings for different **treesitter** node types - Supports different comment strings for different **treesitter** node types
# ⚡️ Requirements ## ⚡️ Requirements
- Neovim >= 0.10.0 - Neovim >= 0.10.0
# 📦 Installation ## 📦 Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim): Using [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua ```lua
{ {
"folke/ts-comments.nvim", "folke/ts-comments.nvim",
opts = {} opts = {},
event = "VeryLazy", event = "VeryLazy",
enabled = vim.fn.has("nvim-0.10.0") == 1, enabled = vim.fn.has("nvim-0.10.0") == 1,
} }
``` ```
# ⚙️ Configuration ## ⚙️ Configuration
Default configuration: Default configuration:
@@ -33,6 +33,7 @@ Default configuration:
c = "// %s", c = "// %s",
cpp = "// %s", cpp = "// %s",
css = "/* %s */", css = "/* %s */",
c_sharp = "// %s",
gleam = "// %s", gleam = "// %s",
glimmer = "{{! %s }}", glimmer = "{{! %s }}",
graphql = "# %s", graphql = "# %s",
@@ -75,6 +76,6 @@ Default configuration:
``` ```
# 🔗 Related ## 🔗 Related
- [nvim-ts-context-commentstring](https://github.com/JoosepAlviste/nvim-ts-context-commentstring) - [nvim-ts-context-commentstring](https://github.com/JoosepAlviste/nvim-ts-context-commentstring)
+9 -13
View File
@@ -4,10 +4,10 @@
Table of Contents *ts-comments.nvim-table-of-contents* Table of Contents *ts-comments.nvim-table-of-contents*
1. ts-comments.nvim |ts-comments.nvim-ts-comments.nvim| 1. ts-comments.nvim |ts-comments.nvim-ts-comments.nvim|
2. Requirements |ts-comments.nvim-requirements| - Requirements |ts-comments.nvim-ts-comments.nvim-requirements|
3. Installation |ts-comments.nvim-installation| - Installation |ts-comments.nvim-ts-comments.nvim-installation|
4. Configuration |ts-comments.nvim-configuration| - Configuration |ts-comments.nvim-ts-comments.nvim-configuration|
5. Related |ts-comments.nvim-related| - Related |ts-comments.nvim-ts-comments.nvim-related|
============================================================================== ==============================================================================
1. ts-comments.nvim *ts-comments.nvim-ts-comments.nvim* 1. ts-comments.nvim *ts-comments.nvim-ts-comments.nvim*
@@ -18,29 +18,26 @@ Tiny plugin to enhance Neovim’s native comments:
- Supports different comment strings for different **treesitter** node types - Supports different comment strings for different **treesitter** node types
============================================================================== REQUIREMENTS *ts-comments.nvim-ts-comments.nvim-requirements*
2. Requirements *ts-comments.nvim-requirements*
- Neovim >= 0.10.0 - Neovim >= 0.10.0
============================================================================== INSTALLATION *ts-comments.nvim-ts-comments.nvim-installation*
3. Installation *ts-comments.nvim-installation*
Using lazy.nvim <https://github.com/folke/lazy.nvim> Using lazy.nvim <https://github.com/folke/lazy.nvim>
>lua >lua
{ {
"folke/ts-comments.nvim", "folke/ts-comments.nvim",
opts = {} opts = {},
event = "VeryLazy", event = "VeryLazy",
enabled = vim.fn.has("nvim-0.10.0") == 1, enabled = vim.fn.has("nvim-0.10.0") == 1,
} }
< <
============================================================================== CONFIGURATION *ts-comments.nvim-ts-comments.nvim-configuration*
4. Configuration *ts-comments.nvim-configuration*
Default configuration: Default configuration:
@@ -93,8 +90,7 @@ Default configuration:
< <
============================================================================== RELATED *ts-comments.nvim-ts-comments.nvim-related*
5. Related *ts-comments.nvim-related*
- nvim-ts-context-commentstring <https://github.com/JoosepAlviste/nvim-ts-context-commentstring> - nvim-ts-context-commentstring <https://github.com/JoosepAlviste/nvim-ts-context-commentstring>
+1
View File
@@ -7,6 +7,7 @@ local defaults = {
c = "// %s", c = "// %s",
cpp = "// %s", cpp = "// %s",
css = "/* %s */", css = "/* %s */",
c_sharp = "// %s",
gleam = "// %s", gleam = "// %s",
glimmer = "{{! %s }}", glimmer = "{{! %s }}",
graphql = "# %s", graphql = "# %s",