https://github.com/Djancyp/better-comments.nvim

Nvim Plugin
https://github.com/Djancyp/better-comments.nvim

Last synced: about 2 months ago
JSON representation

Nvim Plugin

• Host: GitHub
• URL: https://github.com/Djancyp/better-comments.nvim
• Owner: Djancyp
• Created: 2022-08-23T13:32:27.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T06:21:50.000Z (7 months ago)
• Last Synced: 2024-06-17T19:02:31.459Z (3 months ago)
• Language: Lua
• Size: 133 KB
• Stars: 118
• Watchers: 1
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Better Comments - NVIM

Better comments helps you to organize your comments with highlights and virtual text.

# DEMO

![Demo](https://github.com/Djancyp/nvim-plugin-demo/blob/main/better-comment.nvim/images/example.png)

## Installation

### Requirement

in order to use this plugin you need to set up treesiter

[nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)

Recommended Packer:

```lua

use "Djancyp/better-comments.nvim"

```

### Setup

```lua

require('better-comment').Setup()

```

## Configs

### Default Config

```lua

tags = {

        {

            name = "TODO",

            fg = "white",

            bg = "#0a7aca",

            bold = true,

            virtual_text = "",

        },

        {

            name = "FIX",

            fg = "white",

            bg = "#f44747",

            bold = true,

            virtual_text = "This is virtual Text from FIX",

        },

        {

            name = "WARNING",

            fg = "#FFA500",

            bg = "",

            bold = false,

            virtual_text = "This is virtual Text from WARNING",

        },

        {

            name = "!",

            fg = "#f44747",

            bg = "",

            bold = true,

            virtual_text = "",

        }

    }

```

### Overwrite defaults or add new Config

```lua

require('better-comment').Setup({

tags = {

       // TODO will overwrite

        {

            name = "TODO",

            fg = "white",

            bg = "#0a7aca",

            bold = true,

            virtual_text = "",

        },

       {

            name = "NEW",

            fg = "white",

            bg = "red",

            bold = false,

            virtual_text = "",

        },

    }

})

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)