freddiehaddad / feline.nvim Goto Github PK

View Code? Open in Web Editor NEW

265.0 7.0 8.0 661 KB

A minimal, stylish and customizable statusline, statuscolumn, and winbar for Neovim

License: GNU General Public License v3.0

Lua 100.00%

neovim neovim-lua neovim-plugin neovim-statusline neovim-statuscolumn neovim-winbar

feline.nvim's People

Contributors

Stargazers

Watchers

Forkers

fantomebeignet bartoszluka mrjones2014 ur4ltz zhangxxii systematicerror mrcjkb

feline.nvim's Issues

feature: statuscolumn support?

Did you check the docs?

I have read all the Feline docs

Is your feature request related to a problem? Please describe.

Would like to be able to configure statuscolumn with feline.nvim, just like heirline.nvim can.

Describe the solution you'd like

Same sort of API as statusline and winbar, but for statuscolumn

Describe alternatives you've considered

doing it manually, or spending dozens of hours switching to heirline, which I'm hesitant to do because it doesn't help with highlights as much as feline does

Additional context

I started some work on it in my fork here but can't get it to work, but I think I'm probably just missing some feline.nvim context. I don't think it should be too much work to support it. https://github.com/mrjones2014/feline.nvim

Edit icon of vi_mode without changing anything else from feline

Is it possible? I want to specify parameters for single components, for example changing the icon of the vi_mode component.

This is my config:

return {
	"freddiehaddad/feline.nvim",
	config = function(_, _opts)
		require("feline").setup()

		local lighthaus_theme = {
			fg = "#DCD7BA",
			bg = "#1F1F28",
			black = "#16161D",
			skyblue = "#16161D",
			cyan = "#6A9589",
			green = "#76946A",
			-- oceanblue = "#658594",
			oceanblue = "#1F1F28",
			magenta = "#D27E99",
			orange = "#FFA066",
			red = "#E82424",
			violet = "#957FB8",
			white = "#DCD7BA",
			yellow = "#FF9E3B",
		}

		require("feline").use_theme(lighthaus_theme)

		-- require("feline").winbar.setup()
	end,
}

Hi @freddiehaddad! The commit 1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e broke my custom git component that looks like this:

          Hi @freddiehaddad! The commit 1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e broke my custom git component that looks like this:

{
  provider = 'git_branch',
  icon = {
    str = '  ', -- Custom git icon
    hl = { fg = '#f34f29' },
  },
}

The default icon is now used instead of the custom one, and the custom highlight is no longer applied.

Is this expected behaviour?

Originally posted by @mawkler in #49 (comment)

Bring back `feline.add_theme()`

This PR seems to remove feline.add_theme(). It doesn't mention why, and add_theme() is still in the helpdocs which makes me belive that it was removed by mistake by @famiu.

bug: Lazy.nvim installs the `master` branch, not the `main` branch

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

v0.9.0

Operating system/version

Arch

Describe the bug

When I use lazy.nvim to install your plugin with the config

    {
        'freddiehaddad/feline.nvim',
        lazy = false,
    }

It actually installs the wrong version:
"feline.nvim": { "branch": "master", "commit": "c6eea890c4f81725f4c51eba48d9733a248513a2" },
( from lazy-lock.json )

This might be a lazy problem, but maybe you have some git setting pointing to master as the default branch?

Workaround

Add branch = 'main' and now it works.

Steps To Reproduce

See description

Expected Behavior

Install latest version

Repro

require("lazy").setup({
  {
    "freddiehaddad/feline.nvim",
    config = function()
      -- your configuration
    end,
  }
})

bug: it doesn't work

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

latest

Operating system/version

latest

Describe the bug

I added the lua import using LazyVim and the setup() inside init.lua and it doesn't work.

Steps To Reproduce

add this plugin inside plugins/
call setup() in init.lua

Note: I'm using lazyvim.

Expected Behavior

Well.... I expect it to work with the default configs?

Repro

require("lazy").setup({
  {
    "freddiehaddad/feline.nvim",
    config = function()
      -- your configuration
    end,
  }
})

bug: LuaRocks GHA failing on dependency.

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

Operating system/version

Describe the bug

@mrcjkb github action is failing with:

Error: Failed installing dependency: https://luarocks.org/gitsigns.nvim-scm-1.rockspec - Build error: Failed installing lua/gitsigns/diff_ffi.lua in /home/runner/work/_temp/tmp.n5kdcAxHNW/lib/luarocks/rocks-5.1/gitsigns.nvim/scm-1/lua/gitsigns/diff_ffi.lua: lua/gitsigns/diff_ffi.lua: No such file or directory

https://github.com/freddiehaddad/feline.nvim/actions/runs/8754394451/job/24026039795#step:4:485

Looking into the problem, but maybe you can shed some light. I do see gitsigns registered with LuaRocks, so I don't think the issue is there.

Steps To Reproduce

Run the GHA workflow.

Expected Behavior

Successful push to LuaRocks repository.

Repro

na

bug: component does not use custom highlight name

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.9.5

Operating system/version

macOS 14.2

Describe the bug

Setting a custom provider highlight name using a function does create a highlight name using it's other properties (e.g. fg / bg) instead of using the predefined name.

The example in USAGE.md doesn't work either. The Name of the hl should be something like StatusComponentVim... (according to https://github.com/freddiehaddad/feline.nvim/blob/main/lua/feline/providers/vi_mode.lua#L56) but rather creates StatusComponent_60A040_1F1F23_bold

TLDR: After some digging around i found function parse_hl https://github.com/freddiehaddad/feline.nvim/blob/main/lua/feline/generator.lua#L120, which just ignores the predefined hl.name. My naive approach was to just return the hl.name or generate a new name if none was passed and that seems to work

Steps To Reproduce

Define component (see Repro for complete example):

local p_vi_mode = require("feline.providers.vi_mode")

local vi_mode_component = {
    provider = function()
        return string.format(" %s ", p_vi_mode.get_vim_mode())
    end,
    hl = function()
        return {
            name = "FelineStatusbarViMode" .. p_vi_mode.get_mode_highlight_name(),
            fg = "#ffffff",
            bg = "#ff0000"
        }
    end
}

Restart Nvim to update config
Check output of :filter /^FelineStatusbarViMode/ highlight which should be empty
Check output of :filter /^StatusComponent_/ highlight which should output the auto-generated hl: StatusComponent_ffffff_ff0000_NONE xxx guifg=#ffffff guibg=#ff0000

Expected Behavior

I would expect that Feline does create a hl for me but uses the predefined name FelineStatusbarViMode instead of the fallback StatusComponent_...

Repro

require("lazy").setup(
    {
        {
            "freddiehaddad/feline.nvim",
            config = function()
                local f = require("feline")

                local p_vi_mode = require("feline.providers.vi_mode")

                local c = {
                    mode = {
                        provider = function()
                            return string.format(" %s ", p_vi_mode.get_vim_mode())
                        end,
                        hl = function()
                            return {
                                name = "FelineStatusbarViMode" .. p_vi_mode.get_mode_highlight_name(),
                                fg = "#ffffff",
                                bg = "#ff0000"
                            }
                        end
                    }
                }

                local components = {
                    active = {
                        {
                            c.mode
                        }
                    },
                    inactive = {}
                }

                f.setup({components = components})
            end
        }
    }
)

bug: git branch component not working

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.9.5

Operating system/version

6.7.4-zen1-1-zen

Describe the bug

Everything else works fine but the Git Branch provider doesn't.

I have the other sections setup in my config but this is everything where git_branch is used.

I definitely have lewis6991/gitsigns.nvim added as a dependency.

Steps To Reproduce

use config above
reload and see no git_branch

Expected Behavior

visible git_branch

Repro

{
'freddiehaddad/feline.nvim',
config = function()
local c = {
  git_branch = {
    provider = "git_branch",
  }
}
local left = {
  c.git_branch,
}

local components = {
  active = {
    left
  }
  inactive = {
    right
  }

require('feline').setup({
  components = components,
})
end
}

bug: error "(UNKNOWN PLUGIN): Error executing lua: attempt to call a number value" is shown in screen

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.9.4 Build type: Release LuaJIT 2.1.1696795921

Operating system/version

MacOs 13.4.1

Describe the bug

I've encountered a peculiar bug that's a bit challenging to articulate. Essentially, an error message appears at the top of the screen. While this error doesn't impede the functionality of Neovim, its presence can be somewhat bothersome. Reproducing the error is possible in various scenarios, but it consistently involves the usage of feline.

Initially, I suspected catppuccin was the root cause and opened an issue there: link to the issue. However, upon further investigation, I discovered that the error also manifests with a minimal config containing feline, treesitter.

The error itself is truncated so basically no information is shown:

Steps To Reproduce

nvim --clean -u repro.lua
:qa<cr>
nvim --clean -u repro.lua newfile.lua
Type a non existing cmd, e.g.: :lkdjflkdjf<cr>

-- > Error is shown

Expected Behavior

No error

Repro

-- DO NOT change the paths and don't remove the colorscheme
local root = vim.fn.fnamemodify("./.repro", ":p")

-- set stdpaths to use .repro
for _, name in ipairs({ "config", "data", "state", "cache" }) do
    vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
end

-- bootstrap lazy
local lazypath = root .. "/plugins/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
    vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", lazypath })
end
vim.opt.runtimepath:prepend(lazypath)

-- termguicolors must be enabled for feline
vim.opt.termguicolors = true

-- This is needed for reproduction of the error
vim.opt.foldmethod = 'expr'

-- install plugins
local plugins = {
    {
        'freddiehaddad/feline.nvim',
        config = function()
            require('feline').setup()
        end,
    },
    {
        'nvim-treesitter/nvim-treesitter',
        config = function()
            require('nvim-treesitter.configs').setup {
                highlight = { enable = true },
                ensure_installed = { 'lua' },
            }
        end,
    }
}
require 'lazy'.setup(plugins, {
    root = root .. '/plugins',
})

feature: winbar improvements

Did you check the docs?

I have read all the Feline docs

Is your feature request related to a problem? Please describe.

I have some code in my config that I feel could be integrated into feline for others to easily use

Describe the solution you'd like

Winbar theme

Currently, the theme in the setup is for both statusline and winbar, but I really like having a separate background color for winbar. I am proposing adding a theme to the winbar setup, and then falling back to the global theme if not specified

Local winbar

I like to disable winbar on some buffers like a terminal buffer, startify buffer, etc... I feel like having an option to only list the buffer filetypes, and having feline disabling it for those buffers would be awesome!

I just wanted to open an issue first to hear if you would be open to these changes. I would be happy to implement these changes myself in that case🙌

Describe alternatives you've considered

Having it as it is in my config

Additional context

No response

bug: sign removed

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.10.0-dev-1617+g143a17833-Homebrew

Operating system/version

MacOS 13.3.1

Describe the bug

this sign has been removed from nerd-fonts

Steps To Reproduce

{ provider = "git_diff_changed" }

in your config

Expected Behavior

expected the symbol to be there but instead it looks like this

Repro

require("lazy").setup({
  {
    "freddiehaddad/feline.nvim",
    config = function()
      require("feline").setup({ components = { provider = "git_diff_changed" } })
    end,
  }
})

`:Rocks sync` fails on feline.nvim if ssh key has passphrase

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.10.0-dev-2937+g8e5c48b08-dirt

Operating system/version

Gentoo

Describe the bug

:Rocks sync tries to git clone feline, feline rockspec has ssh+git url, so git tries to read ssh key but it has a passphrase and luarocks or rocks.nvim can't handle that, failing install.

This was first reported to rocks.nvim, got moved to nvim-neorocks and closed there with suggestion to create an issue to feline repo with suggested fix of "change the source URL to HTTPS". Here I am ._.

Steps To Reproduce

:Rocks install feline.nvim, also have a passphrase on your ssh key.

Expected Behavior

Installs feline.nvim

Repro

require("lazy").setup({
  {
    "freddiehaddad/feline.nvim",
    config = function()
      -- your configuration
    end,
  }
})

bug: Deprecation of `vim.lsp.get_active_clients()` in NVIM 0.11.0-dev

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.11.0-dev-164+g3a1515bfee

Operating system/version

Arch Linux

Describe the bug

Deprecation of vim.lsp.get_active_clients(). The fix is just one line, swapping the get_active_clients function for get_clients and leaving the parameters unchanged, it seems.

Steps To Reproduce

Open neovim
Observe warning (as elaborated on below)

vim.lsp.get_active_clients() is deprecated. Run ":checkhealth vim.deprecated" for more information

Which leads to the following:


 ~
- WARNING vim.lsp.get_active_clients() is deprecated. Feature will be removed in Nvim 0.12
  - ADVICE:
    - use vim.lsp.get_clients() instead.
    - stack traceback:
        /home/<user_name>/.local/share/nvim/lazy/catppuccin/lua/catppuccin/groups/integrations/feline.lua:415
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:301
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:447
        [C]:-1
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:498
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:615
    - stack traceback:
        /home/<user_name>/.local/share/nvim/lazy/catppuccin/lua/catppuccin/groups/integrations/feline.lua:415
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:301
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:447
        [C]:-1
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:498
        /home/<user_name>/.local/share/nvim/lazy/feline.nvim/lua/feline/generator.lua:615
        [C]:-1
        /usr/share/nvim/runtime/lua/vim/health.lua:353
        nvim>:1

Expected Behavior

Open neovim
No warning

Repro

No response

bug: Wrong symbol being shown for git branch (only sometimes... :O)

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.8.3

Operating system/version

Arch

Describe the bug

I sometimes get a weird symbol for the git branch. It stays for the whole session unchanged.

I have changed my config multiple times now. Whenever I change it, the symbol is fine until the next restart(?) of the PC? I never had any problems with other missing symbols before?

Funny enough this works fine with my dotfiles (managed with YADM, which is probably supplied by gitsigns. On all the other cloned Git repos it doesn't work...

Here is a picture:

Steps To Reproduce

...?

Expected Behavior

Show actual branch symbol

Repro

require("lazy").setup({
    {
        'freddiehaddad/feline.nvim',
        lazy = false,
        dependencies = { 'nvim-lua/plenary.nvim', 'kyazdani42/nvim-web-devicons', 'rebelot/kanagawa.nvim', 'lewis6991/gitsigns.nvim' },
        config = function ()
            local colors = function ()
                local theme = require('kanagawa.colors').setup({ theme = 'wave' }).theme
                return {
                    bg = theme.ui.bg,
                    bg_dim = theme.ui.bg_dim,
                    fg = theme.ui.fg,
                    fg_dim = theme.ui.fg_dim,
                    fg_reverse = theme.ui.fg_reverse,
                    special = theme.ui.special,
                    diag_warn = theme.diag.warning,
                    diag_error = theme.diag.error,
                    diag_hint = theme.diag.hint,
                    diag_info = theme.diag.info,
                    git_del = theme.vcs.removed,
                    git_add = theme.vcs.added,
                    git_change = theme.vcs.changed,
                }
            end

            local c = {
                fileinfo = {
                    provider = {
                        name = "file_info",
                        opts = {
                            type = "relative-short",
                        },
                    },
                    hl = {
                        style = "bold",
                    },
                    right_sep = "block",
                },
                gitBranch = {
                    provider = 'git_branch',
                    left_sep = "block",
                    right_sep = "block",
                    hl = {
                        fg = "special",
                    },
                },
                gitDiffAdded = {
                    provider = "git_diff_added",
                    hl = {
                        fg = "git_add",
                    },
                    left_sep = "block",
                    right_sep = "block",
                },
                gitDiffRemoved = {
                    provider = "git_diff_removed",
                    hl = {
                        fg = "git_del",
                    },
                    left_sep = "block",
                    right_sep = "block",
                },
                gitDiffChanged = {
                    provider = "git_diff_changed",
                    hl = {
                        fg = "git_change",
                    },
                    left_sep = "block",
                    right_sep = "right_filled",
                },
                separator = {
                    provider = "",
                },
                diagnostic_errors = {
                    provider = "diagnostic_errors",
                    hl = {
                        fg = "diag_error"
                    },
                },
                diagnostic_warnings = {
                    provider = "diagnostic_warnings",
                    hl = {
                        fg = "diag_warn",
                    },
                },
                diagnostic_hints = {
                    provider = "diagnostic_hints",
                    hl = {
                        fg = "diag_hint",
                    },
                },
                diagnostic_info = {
                    provider = "diagnostic_info",
                    hl = {
                        fg = "diag_info",
                    },
                },
                lsp_client_names = {
                    provider = "lsp_client_names",
                    hl = {
                        style = "bold",
                        fg = "special"
                    },
                    left_sep = "left_filled",
                    right_sep = "block",
                },
                file_type = {
                    provider = {
                        name = "file_type",
                        opts = {
                            filetype_icon = false,
                            case = "uppercase",
                        },
                    },
                    hl = {
                        style = "bold",
                        fg = "fg",
                    },
                    left_sep = "block",
                    right_sep = "block",
                },
                position = {
                    provider = "position",
                    hl = {
                        fg = "fg",
                        style = "bold",
                    },
                    left_sep = "block",
                    right_sep = "block",
                },
                line_percentage = {
                    provider = "line_percentage",
                    hl = {
                        style = "bold",
                    },
                    left_sep = "block",
                    right_sep = "block",
                },
                scroll_bar = {
                    provider = {
                        name = "scroll_bar",
                        opts = {
                            reverse = true
                        }
                    },
                    hl = {
                        bg = "fg",
                        fg = 'bg',
                        style = "bold",
                    },
                },
            }

            local left = {
                c.fileinfo,
                c.gitBranch,
                c.gitDiffAdded,
                c.gitDiffRemoved,
                c.gitDiffChanged,
                c.separator,
            }

            local right = {
                c.lsp_client_names,
                c.diagnostic_errors,
                c.diagnostic_warnings,
                c.diagnostic_info,
                c.diagnostic_hints,
                c.file_type,
                c.position,
                c.line_percentage,
                c.scroll_bar,
            }

            local components = {
                active = {
                    left,
                    right,
                },
                inactive = {
                    left,
                    right,
                },
            }

            require('feline').setup({
                components = components,
                theme = colors()
            })
        end
    }
})

whereeeee's the Themeeee

I really liked this theme but unable to find the link to get one.

bug: Icon is overwritten when the highlight of the icon is changed

Did you check docs and existing issues?

I have read all the Feline docs
I have searched the existing issues of Feline
I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

NVIM v0.9.2

Operating system/version

MacOs 13.4.1

Describe the bug

Most default providers return an icon. It is possible to overwrite the icon by adding

icon = {
    str = 'new_icon', 
    hl = {
        fg = '#ff0000',
        bg = '#00ff00',
    }
}

to the component. However, it is not possible to ONLY change the highlight and keep the default icon of the provider

Steps To Reproduce

nvim -u repro.lua
--> icon is not shown
Delete the following part

icon = {
    hl = {
        fg = '#ff0000',
        bg = '#00ff00',
    }
}

--> icon is shown

Expected Behavior

I would like the ability to customize the icon highlighting of providers without losing the associated icon string.

Repro

local comp = {
    provider = {
        name = 'file_type',
        opts = {
            filetype_icon = true
        }
    },
    -- As soon as you add this, the icon is not shown anymore
    icon = {
        hl = {
            fg = '#ff0000',
            bg = '#00ff00',
        }
    }
}

require('lazy').setup({
    {
        'freddiehaddad/feline.nvim',
        config = function()
            require('feline').setup {
                components = {
                    active = { { comp } }
                }
            }
        end,
    }
})

> Hi @freddiehaddad! The commit [1dcf6bf](https://github.com/freddiehaddad/feline.nvim/commit/1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e) broke my custom git component that looks like this:

          > Hi @freddiehaddad! The commit [1dcf6bf](https://github.com/freddiehaddad/feline.nvim/commit/1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e) broke my custom git component that looks like this:

{
  provider = 'git_branch',
  icon = {
    str = '  ', -- Custom git icon
    hl = { fg = '#f34f29' },
  },
}
The default icon is now used instead of the custom one, and the custom highlight is no longer applied.

Is this expected behaviour?

Hm.. That's strange. I tested your case explicitly w/o issue. Mind sharing your config so I can test it? At first glance, I don't see why it's failing.

EDIT:

The default component.icon table is merged with yours and should keep your settings instead of the default. I might need to look at the remaining providers as there could be a case I missed.

To answer your question, it should have been a non-breaking change. I will address it.

Originally posted by @freddiehaddad in #49 (comment)

Hi @freddiehaddad! The commit 1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e broke my custom git component that looks like this:

          Hi @freddiehaddad! The commit 1dcf6bf0b7fcaf2a2cddec377266eb2e6a41492e broke my custom git component that looks like this:

{
  provider = 'git_branch',
  icon = {
    str = '  ', -- Custom git icon
    hl = { fg = '#f34f29' },
  },
}

The default icon is now used instead of the custom one, and the custom highlight is no longer applied.

Is this expected behaviour?

Originally posted by @mawkler in #49 (comment)