✨ feat: Add keyword highlighting for TODO, BUG, NOTE

Author: LazyYuuki

README.md

@@ -0,0 +1,92 @@
+# notice-me
+
+A Neovim plugin that highlights important keywords in your code like TODO, BUG, and NOTE.
+
+## Features
+
+- Highlights keywords with different colors:
+  - TODO (green)
+  - BUG (red)
+  - NOTE (yellow)
+- Automatically applies highlighting when entering buffers or after saving
+- Toggle keyword highlighting on/off with a command
+
+## Installation
+
+Using [packer.nvim](https://github.com/wbthomason/packer.nvim):
+
+```lua
+use {
+  'yourusername/notice-me',
+  config = function()
+    require('notice-me').setup({
+      -- Optional custom configuration
+    })
+  end
+}
+```
+
+Using [lazy.nvim](https://github.com/folke/lazy.nvim):
+
+```lua
+{
+  'yourusername/notice-me',
+  config = function()
+    require('notice-me').setup({
+      -- Optional custom configuration
+    })
+  end
+}
+```
+
+## Configuration
+
+notice-me comes with the following defaults:
+
+```lua
+{
+  enable = true,
+  keywords = {
+    TODO = { fg = "#00ff00" }, -- green
+    BUG = { fg = "#ff0000" },  -- red
+    NOTE = { fg = "#ffff00" }  -- yellow
+  }
+}
+```
+
+You can customize the plugin by passing options to the setup function:
+
+```lua
+require('notice-me').setup({
+  enable = true, -- Enable/disable the plugin
+  keywords = {
+    TODO = { fg = "#00ff00" }, -- green
+    BUG = { fg = "#ff0000" },  -- red
+    NOTE = { fg = "#ffff00" },  -- yellow
+    IMPORTANT = { fg = "#ff00ff" }, -- add your own keywords and colors
+  }
+})
+```
+
+## Usage
+
+The plugin automatically highlights keywords in all buffers.
+
+## Commands
+
+- `:NoticeMe`: Display which keywords are being highlighted
+- `:NoticeMeToggle`: Toggle keyword highlighting on/off
+
+## API
+
+```lua
+-- Manually highlight keywords in the current buffer
+require('notice-me').highlight_keywords(vim.api.nvim_get_current_buf())
+
+-- Example function that displays highlighted keywords
+require('notice-me').example_function()
+```
+
+## License
+
+MIT

doc/notice-me.txt

@@ -0,0 +1,80 @@
+*notice-me.txt*  A plugin for Neovim
+
+==============================================================================
+CONTENTS                                                     *notice-me-contents*
+
+  1. Introduction ................. |notice-me-introduction|
+  2. Installation ................. |notice-me-installation|
+  3. Configuration ................ |notice-me-configuration|
+  4. Usage ........................ |notice-me-usage|
+  5. Commands ..................... |notice-me-commands|
+  6. API .......................... |notice-me-api|
+  7. License ...................... |notice-me-license|
+
+==============================================================================
+1. INTRODUCTION                                           *notice-me-introduction*
+
+A Neovim plugin for [brief description of what your plugin does].
+
+==============================================================================
+2. INSTALLATION                                           *notice-me-installation*
+
+Using packer.nvim:
+>
+  use {
+    'yourusername/notice-me',
+    config = function()
+      require('notice-me').setup({
+        -- your configuration goes here
+      })
+    end
+  }
+<
+
+Using lazy.nvim:
+>
+  {
+    'yourusername/notice-me',
+    config = function()
+      require('notice-me').setup({
+        -- your configuration goes here
+      })
+    end
+  }
+<
+
+==============================================================================
+3. CONFIGURATION                                         *notice-me-configuration*
+
+notice-me comes with the following defaults:
+>
+  {
+    enable = true,
+    -- Add more options as needed
+  }
+<
+
+==============================================================================
+4. USAGE                                                        *notice-me-usage*
+
+Describe how to use your plugin here.
+
+==============================================================================
+5. COMMANDS                                                  *notice-me-commands*
+
+:NoticeMe                                                          *:NoticeMe*
+        Example command that calls the example function.
+
+==============================================================================
+6. API                                                            *notice-me-api*
+
+require('notice-me').example_function()     *notice-me.example_function()*
+        Example function description.
+
+==============================================================================
+7. LICENSE                                                      *notice-me-license*
+
+MIT
+
+==============================================================================
+vim:tw=78:ts=8:ft=help:norl:

lua/notice-me/init.lua

@@ -0,0 +1,96 @@
+local M = {}
+
+-- Plugin configuration with default values
+M.config = {
+  enable = true,
+  keywords = {
+    TODO = { fg = "#00ff00" }, -- green
+    BUG = { fg = "#ff0000" },  -- red
+    NOTE = { fg = "#ffff00" }  -- yellow
+  }
+}
+
+-- Function to setup the plugin with user config
+function M.setup(opts)
+  -- Merge user config with defaults
+  opts = opts or {}
+  M.config = vim.tbl_deep_extend("force", M.config, opts)
+  
+  -- Initialize your plugin here
+  M.setup_highlights()
+  M.setup_autocmds()
+
+  -- Return the module for chaining
+  return M
+end
+
+-- Set up highlights for keywords
+function M.setup_highlights()
+  local ns_id = vim.api.nvim_create_namespace("notice_me")
+  M.namespace = ns_id
+  
+  -- Create highlight groups
+  for keyword, color in pairs(M.config.keywords) do
+    vim.api.nvim_set_hl(0, "NoticeMe" .. keyword, color)
+  end
+end
+
+-- Set up autocommands to apply highlighting
+function M.setup_autocmds()
+  vim.api.nvim_create_autocmd({"BufEnter", "BufWritePost"}, {
+    callback = function(args)
+      if not M.config.enable then return end
+      M.highlight_keywords(args.buf)
+    end,
+    desc = "Notice-me highlight keywords on buffer enter/write",
+  })
+  
+  -- Also highlight current buffer immediately
+  vim.schedule(function()
+    if vim.api.nvim_get_current_buf() then
+      M.highlight_keywords(vim.api.nvim_get_current_buf())
+    end
+  end)
+end
+
+-- Highlight keywords in a buffer
+function M.highlight_keywords(bufnr)
+  if not bufnr or not vim.api.nvim_buf_is_valid(bufnr) then return end
+  
+  -- Clear previous highlights
+  vim.api.nvim_buf_clear_namespace(bufnr, M.namespace, 0, -1)
+  
+  -- Get buffer content
+  local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
+  
+  -- Highlight keywords
+  for i, line in ipairs(lines) do
+    for keyword, _ in pairs(M.config.keywords) do
+      local start_idx = 1
+      while true do
+        local match_start, match_end = line:find(keyword, start_idx)
+        if not match_start then break end
+        
+        -- Apply highlight
+        vim.api.nvim_buf_add_highlight(
+          bufnr,
+          M.namespace,
+          "NoticeMe" .. keyword,
+          i - 1,
+          match_start - 1,
+          match_end
+        )
+        
+        start_idx = match_end + 1
+      end
+    end
+  end
+end
+
+-- Example function implementation
+function M.example_function()
+  print("Notice-me plugin function called!")
+  print("Keywords being highlighted:", vim.inspect(vim.tbl_keys(M.config.keywords)))
+end
+
+return M

lua/notice-me/utils.lua

@@ -0,0 +1,11 @@
+local M = {}
+
+-- Example utility function
+function M.is_enabled()
+  local notice_me = require("notice-me")
+  return notice_me.config.enable
+end
+
+-- Add more utility functions as needed
+
+return M

plugin/notice-me.lua

@@ -0,0 +1,28 @@
+if vim.g.loaded_notice_me then
+  return
+end
+vim.g.loaded_notice_me = true
+
+-- Initialize the plugin
+require("notice-me").setup()
+
+-- Create user commands
+vim.api.nvim_create_user_command("NoticeMe", function()
+  require("notice-me").example_function()
+end, { desc = "Example notice-me command" })
+
+vim.api.nvim_create_user_command("NoticeMeToggle", function()
+  local notice_me = require("notice-me")
+  notice_me.config.enable = not notice_me.config.enable
+  
+  if notice_me.config.enable then
+    -- Reapply highlights on current buffer
+    notice_me.highlight_keywords(vim.api.nvim_get_current_buf())
+    vim.notify("Keyword highlighting enabled")
+  else
+    -- Clear highlights on current buffer
+    local bufnr = vim.api.nvim_get_current_buf()
+    vim.api.nvim_buf_clear_namespace(bufnr, notice_me.namespace, 0, -1)
+    vim.notify("Keyword highlighting disabled")
+  end
+end, { desc = "Toggle notice-me keyword highlighting" })

tests/notice-me_spec.lua

@@ -0,0 +1,28 @@
+local notice_me = require("notice-me")
+
+describe("notice-me", function()
+  it("can be required", function()
+    assert.truthy(notice_me)
+  end)
+
+  it("has setup function", function()
+    assert.truthy(notice_me.setup)
+    assert.is_function(notice_me.setup)
+  end)
+
+  it("has example_function", function()
+    assert.truthy(notice_me.example_function)
+    assert.is_function(notice_me.example_function)
+  end)
+
+  it("can be configured", function()
+    local original_config = vim.deepcopy(notice_me.config)
+    
+    -- Test with custom config
+    notice_me.setup({ enable = false })
+    assert.equals(false, notice_me.config.enable)
+    
+    -- Reset config
+    notice_me.config = original_config
+  end)
+end)