abeldekat / harpoonline Goto Github PK

View Code? Open in Web Editor NEW

44.0 1.0 0.0 89 KB

Harpoon info for any statusline

License: Apache License 2.0

Lua 95.08% Makefile 4.92%

harpoon lua neovim neovim-plugin nvim nvim-plugin

harpoonline's People

Contributors

Stargazers

Watchers

harpoonline's Issues

Breaking changes in version v2.0

Purpose

Change the default options of the default "extended" formatter to be more neutral.
Make it easier to configure a built-in formatter

Builtin formatters

The options for the built-in formatters are now in the configuration. Function gen_override is not needed anymore and removed.

New example, overriding a builtin: Customize a built-in

Changed options for the extended formatter:

The icon is always shown when not an empty string.
Removed option separator. Change the spacing inside the indicators instead. Allows for more flexibility.
Option empty_slot is disabled by default.

Setup

The following example setup has been removed:

local Harpoonline = require("harpoonline").setup()

Please use:

local Harpoonline = require("harpoonline")
Harpoonline.setup()

Default formatter: Add something to the line when there are more marks than indicators

Efficiency: Return a cached version of the line when harpoon state is unchanged

A small improvement.

The plugin only updates its data on the appropriate events.
However, the format function still constructs the line dynamically, using string.format

Solution: Cache that line, and use it when nothing has changed for harpoon.

Breaking changes in v3

There are breaking changes if the config of the user:

Uses a custom_formatter function
Changed property empty_slots ( default empty )
Contains { formatter = "extended" }
Changed options in formatter_opts.extended

Changes in the custom formatter

Previously:

Harpoonline.setup({
  custom_formatter = Harpoonline.gen_formatter(
    ---@param data HarpoonLineData
    ---@return string
    function(data)
      -- create and return the line
    end
  ),
})

Now:

The gen_formatter wrapper has been removed
A second argument has been added: opts of type HarpoonlineConfig

Harpoonline.setup({
  ---@param data HarpoonlineData
  ---@param opts HarpoonLineConfig
  ---@return string
  custom_formatter = function(data, opts)
      -- create and return the line
  end,
})

`HarpoonLineData` is also changed

Changed the name into HarpoonlineData(lower l)

The data parameter for the custom_formatter used to contain:

---@class HarpoonLineData
H.data = {
  -- Harpoon's default list is in use when list_name = nil
  --- @type string|nil
  list_name = nil, -- the name of the current list
  --- @type number
  list_length = 0, -- the length of the current list
  --- @type number|nil
  buffer_idx = nil, -- the mark of the current buffer if harpooned
}

For more flexibility, the actual items in the harpoon list are now provided.
The length of the list can be inferred using #data.items

---@class HarpoonlineData
---@field list_name string|nil -- the name of the current list
---@field items HarpoonItem[] -- the items of the current list
---@field active_idx number|nil -- the harpoon index of the current buffer

See the examples in the readme.

Changes in the extended formatter

Previously, the default formatter to use when not overridden in the config:

---@type "extended" | "short"
formatter = 'extended', -- use a builtin formatter
-- Corresponding opts: formatter_opts.extended

The name of the default formatter is now just "default"

---@type "default" | "short"
formatter = 'default', -- use a builtin formatter
-- Corresponding opts: formatter_opts.default

Options

Empty slots

The config option for the extended formatter was already disabled:

formatter_opts = {
  extended = {
    -- 1 More indicators than items in the harpoon list:
    empty_slot = '', -- ' · ', -- middledot. Disable using empty string
  },
},

The option has been removed.

Indicators