mirror of
https://github.com/zoriya/ts-comments.nvim.git
synced 2026-08-16 02:44:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98ccacd8d1 |
@@ -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,7 +33,6 @@ 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",
|
||||||
@@ -76,6 +75,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)
|
||||||
|
|||||||
@@ -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|
|
||||||
- Requirements |ts-comments.nvim-ts-comments.nvim-requirements|
|
2. Requirements |ts-comments.nvim-requirements|
|
||||||
- Installation |ts-comments.nvim-ts-comments.nvim-installation|
|
3. Installation |ts-comments.nvim-installation|
|
||||||
- Configuration |ts-comments.nvim-ts-comments.nvim-configuration|
|
4. Configuration |ts-comments.nvim-configuration|
|
||||||
- Related |ts-comments.nvim-ts-comments.nvim-related|
|
5. Related |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,26 +18,29 @@ 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:
|
||||||
|
|
||||||
@@ -90,7 +93,8 @@ 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>
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ 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",
|
||||||
|
|||||||
Reference in New Issue
Block a user