feat: telescope support

Author: rcarriga

README.md

@@ -1,7 +1,5 @@
 # nvim-notify
 
-**This is in proof of concept stage right now, changes are very likely but you are free to try it out and give feedback!**
-
 A fancy, configurable, notification manager for NeoVim
 
 ![notify](https://user-images.githubusercontent.com/24252670/130856848-e8289850-028f-4f49-82f1-5ea1b8912f5e.gif)
@@ -63,6 +61,32 @@ vim.notify("This is an error message.\nSomething went wrong!", "error", {
 })
 ```
 
+### Viewing History
+
+If you have [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) installed then you can use the `notify` extension to search the history:
+
+```vim
+:Telescope notify
+```
+or in lua
+```lua
+require('telescope').extensions.notify.notify(<opts>)
+```
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/24252670/136264308-2fcdfe57-a8f6-4b34-8ea1-e3a8349bc581.png" />
+</p>
+
+There is a command to display a log of the history.
+
+```vim
+:Notifications
+```
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/24252670/136264653-83038119-634b-48e7-8e8a-0edf4546efe2.png" />
+</p>
+
 You can get a list of past notifications with the history function
 ```lua
 require("notify").history()
@@ -74,7 +98,7 @@ which returns a list of tables with the following keys:
 - `icon: string` Icon used for notification
 - `time: number` Time of message, as returned by `vim.fn.localtime()`
 
-There is also a `:Notifications` command to display a log of the history.
+
 
 ## Configuration
 
@@ -93,6 +117,7 @@ require("notify").setup({
   timeout = 5000,
 
   -- For stages that change opacity this is treated as the highlight behind the window
+  -- Set this to either a highlight group or an RGB hex value e.g. "#000000"
   background_colour = "Normal",
 
   -- Icons for the different levels

lua/notify/init.lua

@@ -17,6 +17,12 @@ local M = {}
 
 function M.setup(user_config)
   config.setup(user_config)
+
+  local has_telescope = pcall(require, "telescope")
+  if has_telescope then
+    require("telescope").load_extension("notify")
+  end
+
   local animator_stages = config.stages()
   animator_stages = type(animator_stages) == "string" and stages[animator_stages] or animator_stages
   local animator = WindowAnimator(animator_stages)

lua/notify/service/buffer/init.lua

@@ -10,6 +10,7 @@ local NotifyBufHighlights = require("notify.service.buffer.highlights")
 ---@field _buffer number
 ---@field _height number
 ---@field _width number
+---@field _max_width number | nil
 local NotificationBuf = {}
 
 local BufState = {
@@ -19,6 +20,7 @@ local BufState = {
 
 function NotificationBuf:new(kwargs)
   local notif_buf = {
+    _max_width = kwargs.max_width,
     _notif = kwargs.notif,
     _buffer = kwargs.buffer,
     _state = BufState.CLOSED,
@@ -78,12 +80,13 @@ function NotificationBuf:render()
   api.nvim_buf_set_option(buf, "modifiable", true)
 
   local left_icon = notif.icon .. " "
-  local max_width = math.max(
-    math.max(unpack(vim.tbl_map(function(line)
-      return vim.fn.strchars(line)
-    end, notif.message))),
-    50
-  )
+  local max_width = self._max_width
+    or math.max(
+      math.max(unpack(vim.tbl_map(function(line)
+        return vim.fn.strchars(line)
+      end, notif.message))),
+      50
+    )
   local left_title = notif.title[1] .. string.rep(" ", max_width)
   local right_title = notif.title[2]
   api.nvim_buf_set_lines(buf, 0, 1, false, { "", "" })
@@ -135,6 +138,8 @@ end
 ---@param buf number
 ---@param notification Notification
 ---@return NotificationBuf
-return function(buf, notification)
-  return NotificationBuf:new({ buffer = buf, notif = notification })
+return function(buf, notification, opts)
+  return NotificationBuf:new(
+    vim.tbl_extend("keep", { buffer = buf, notif = notification }, opts or {})
+  )
 end

lua/telescope/_extensions/notify.lua

@@ -0,0 +1,105 @@
+local NotificationBuf = require("notify.service.buffer")
+local pickers = require("telescope.pickers")
+local finders = require("telescope.finders")
+local conf = require("telescope.config").values
+local actions = require("telescope.actions")
+local action_state = require("telescope.actions.state")
+local previewers = require("telescope.previewers")
+local entry_display = require("telescope.pickers.entry_display")
+
+local widths = {
+  time = 8,
+  title = nil,
+  icon = nil,
+  level = nil,
+  message = nil,
+}
+
+local displayer = entry_display.create({
+  separator = " ",
+  items = {
+    { width = widths.time },
+    { width = widths.title },
+    { width = widths.icon },
+    { width = widths.level },
+    { width = widths.message },
+  },
+})
+
+local telescope_notifications = function(opts)
+  local notifs = require("notify").history()
+  local reversed = {}
+  for i, notif in ipairs(notifs) do
+    reversed[#notifs - i + 1] = notif
+  end
+  pickers.new(opts, {
+    results_title = "Notifications",
+    prompt_title = "Filter Notifications",
+    finder = finders.new_table({
+      results = reversed,
+      entry_maker = function(notif)
+        return {
+          value = notif,
+          display = function(entry)
+            return displayer({
+              { vim.fn.strftime("%T", entry.value.time), "NotifyLogTime" },
+              { entry.value.title[1], "NotifyLogTitle" },
+              { entry.value.icon, "Notify" .. entry.value.level .. "Title" },
+              { entry.value.level, "Notify" .. entry.value.level .. "Title" },
+              { entry.value.message[1], "Normal" },
+            })
+          end,
+          ordinal = notif.title[1] .. " " .. notif.title[2] .. " " .. table.concat(
+            notif.message,
+            " "
+          ),
+        }
+      end,
+    }),
+    sorter = conf.generic_sorter(opts),
+    attach_mappings = function(prompt_bufnr, map)
+      actions.select_default:replace(function()
+        actions.close(prompt_bufnr)
+        local selection = action_state.get_selected_entry()
+        local notification = selection.value
+        local buf = vim.api.nvim_create_buf(false, true)
+        local notif_buf = NotificationBuf(buf, notification)
+        notif_buf:render()
+
+        local height = notif_buf:height()
+        local width = notif_buf:width()
+
+        local lines = vim.opt.lines:get()
+        local cols = vim.opt.columns:get()
+
+        local win = vim.api.nvim_open_win(buf, true, {
+          relative = "editor",
+          row = (lines - height) / 2,
+          col = (cols - width) / 2,
+          height = height,
+          width = width,
+          border = "rounded",
+          style = "minimal",
+        })
+        vim.wo[win].winhl = "Normal:Normal,FloatBorder:" .. notif_buf.highlights.border
+        vim.wo[win].wrap = false
+      end)
+      return true
+    end,
+    previewer = previewers.new_buffer_previewer({
+      title = "Message",
+      define_preview = function(self, entry, status)
+        local notification = entry.value
+        local max_width = vim.api.nvim_win_get_config(status.preview_win).width
+        local notif_buf = NotificationBuf(self.state.bufnr, notification, { max_width = max_width })
+        notif_buf:render()
+      end,
+    }),
+  }):find()
+end
+
+return require("telescope").register_extension({
+  exports = {
+    notify = telescope_notifications,
+  },
+})