Skip to content

notice-me v0.1.0 Release Notes

Latest
Compare
Choose a tag to compare
@LazyYuuki LazyYuuki released this 15 Mar 00:14
· 3 commits to main since this release

I am excited to announce the first release of notice-me, a lightweight Neovim plugin that helps you track important code annotations with colorful highlighting.

What is notice-me?

notice-me automatically highlights keywords like TODO, BUG, and NOTE in your code with distinct colors, making them easier to spot during development.

Features

  • Keyword Highlighting: Automatically highlights important keywords:
    • TODO (green)
    • BUG (red)
    • NOTE (yellow)
  • Buffer Integration: Highlighting applies when entering buffers or after saving
  • Toggle Functionality: Easily turn highlighting on/off with the :NoticeMeToggle command
  • Customizable: Add your own keywords and color schemes

Installation

Install with your favorite Neovim package manager:

  • packer.nvim:
use {
  'yourusername/notice-me',
  config = function()
    require('notice-me').setup()
  end
}
  • lazy.nvim:
{
  'yourusername/notice-me',
  config = function()
    require('notice-me').setup()
  end
}

Getting Started

The plugin works out of the box with default settings. To customize:

require('notice-me').setup({
  keywords = {
    TODO = { fg = "#00ff00" },
    BUG = { fg = "#ff0000" },
    NOTE = { fg = "#ffff00" },
    IMPORTANT = { fg = "#ff00ff" }, -- Add your own keywords
  }
})

Commands

  • :NoticeMe: Display currently highlighted keywords
  • :NoticeMeToggle: Toggle highlighting on/off

What's Next?

We're planning enhancements for future releases including:

  • Command to jump between highlighted keywords
  • Telescope integration for listing all highlighted keywords
  • Custom pattern matching options

Feedback & Contributions

We'd love to hear your feedback! Feel free to open issues or submit pull requests on our GitHub repository.


notice-me is licensed under MIT