feat: further customise highlight colors #31

josh-nz · 2024-05-23T06:12:59Z

This adds the ability to define custom colors for the precognition highlight. This allows you to not have to rely in exisiting highlight values. It does this by creating a new highlight if the config for highlightColor is a table, otherwise it falls back to using the string specified as the highlight.

This is a very quick implementation based on some poking around and the code diff from #28 so it might not be considered good enough as it currently stands. In particular:

I'm unsure on how to set the correct @field type spec for the highlightColor now, and as a result the LSP complains that the call to nvim_set_hl doesn't accept a string, even though we know it is a table.
It may not be desirable for the entire set of highlight values to be configured. This may wish to be restricted to a subset.
I'm unsure if I'm creating custom highlights in the correct manner. There is an option to create in the global namespace by passing the value 0 instead of ns as the first argument to nvim_set_hl and this might be preferable.
I might have broken the tests introduced in feat: custom highlight colors #28 or at the very least, now added a feature not covered by the tests. This part is outside my knowledge and experience.
I might have selected the wrong branch to merge to. Apologies if I've done something incorrect in creating this pull request, I'm new to this.

willothy · 2024-05-23T06:53:21Z

lua/precognition/init.lua

@@ -355,6 +355,13 @@ function M.setup(opts)

    ns = vim.api.nvim_create_namespace("precognition")
    au = vim.api.nvim_create_augroup("precognition", { clear = true })
+
+    if type(config.highlightColor) == "table" then
+      vim.api.nvim_set_hl(ns, "precognition", config.highlightColor)


I think you're right, this should probably use the global namespace.

Also, mind capitalizing the hlgroup name? I don't think it actually matters, but pascal-case is generally used for hlgroups.

If I use the global namespace, it doesn't seem to apply the colors provided. I can see the lightlight is defined, :filter precog highlight but just with a grey color instead of my defined yellow. However, if I reload the plugin via :Lazy reload precog (where precog is the name I gave to the Lazy spec for this plugin), it then uses the correct colors. I can't find anything further on the correct way to do this, after a bit of searching. Any ideas or pointers?

Can you test the latest refactors i've done. It seems to work for me good now

willothy · 2024-05-23T06:53:36Z

Thanks for the PR!

tris203

Thanks for the PR!

lua/precognition/init.lua

tris203 · 2024-05-23T08:02:34Z

lua/precognition/init.lua

@@ -355,6 +355,13 @@ function M.setup(opts)

    ns = vim.api.nvim_create_namespace("precognition")
    au = vim.api.nvim_create_augroup("precognition", { clear = true })
+
+    if type(config.highlightColor) == "table" then


Should we drop the if here, and create the highlight group anyways and use it?

Possibly. I was trying to support your original implementation of just a highlight string as well as a custom highlight. Really what I wanted was a way to configure some basic colours or styles, and not have to try and find an existing highlight that could change when I changed my colorscheme. Perhaps we could drop support for the string highlight and just take a table and always make a custom highlight group. Internally we can still default to the Comment styles by just copying them across to the custom highlight.

I did some refactoring and dropped the string input

if you want to test it and give any other thoughts i think this is good now!

willothy

Just some small nits, then looks good to me!

README.md

lua/precognition/init.lua

willothy

Awesome, lgtm!

tris203 · 2024-05-23T22:09:12Z

Thanks for your help @josh-nz

Great idea and only a few tweaks were needed. Brilliant job if you are new

josh-nz · 2024-05-24T04:56:29Z

Is this working for anyone? I'm running into the issue I mentioned here:

#31 (comment)

Not working: Using the global namespace (as per code on main), it doesn't apply my config:

    vim.api.nvim_set_hl(0, hl_name, config.highlightColor)

Working: When using the specified namespace, it does apply my config:

    vim.api.nvim_set_hl(ns, hl_name, config.highlightColor)
    vim.api.nvim_set_hl_ns(ns)

I'm running Neovim 0.10.0 if that has any impact.

tris203 · 2024-05-24T05:47:48Z

Is this working for anyone? I'm running into the issue I mentioned here:

#31 (comment)

Not working: Using the global namespace (as per code on main), it doesn't apply my config:
    vim.api.nvim_set_hl(0, hl_name, config.highlightColor)
Working: When using the specified namespace, it does apply my config:
    vim.api.nvim_set_hl(ns, hl_name, config.highlightColor)
    vim.api.nvim_set_hl_ns(ns)
I'm running Neovim 0.10.0 if that has any impact.

Does it not apply any config, eg its plain white text?
Or it applies the default config, eg its a comment text?

I can't produce this

josh-nz · 2024-05-24T06:00:48Z

I'm not sure if it's plain white, but it's not the comment highlight, at least not in a lua file.

My config:

return {
    "tris203/precognition.nvim",
    enabled = true,
    config = {
      highlightColor = {
        fg = "yellow",
        underline = true
      },
    },
}

If I add some print statements:

    print(config.highlightColor.fg)
    print(config.highlightColor.underline)
    vim.api.nvim_set_hl(0, hl_name, config.highlightColor)

I get yellow and true as expected, but then it results in the screenshot above as white(-ish).

tris203 · 2024-05-24T06:11:59Z

Can you try a hex code. Say #FFFF00

That's what I do in the test which seems to pass

Also try foreground as a property. Not fg

josh-nz · 2024-05-24T06:18:27Z

{ foreground = "red"} does not work
{ foreground = "#FF0000"} does not work

:lua print(vim.api.nvim_get_hl(0, { name = "PrecognitionHighlight"})) returns vim.empty_dict(), assuming I'm using that API correctly.

(:lua print(vim.api.nvim_get_hl(0, { name = "Comment"})) returns table... as expected).

tris203 · 2024-05-24T06:33:39Z

i am having no issues at all which is odd...

josh-nz · 2024-05-24T06:51:54Z

Using some of your config options, like the VeryLazy event and the toggle keymap, I can make it work. So this has given me some things to play with to try and isolate the issue. I'll let you know what I find when I have more time to play with it. It's looking like something to do with the way the Lazy plugin manager initializes things.

If you try with my exact config as here:

#31 (comment)

Does it work for you?

tris203 · 2024-05-24T06:57:35Z

Your exact config doesnt, but changing fg to foreground does

josh-nz · 2024-05-24T08:46:28Z

Using foreground with the above config still doesn't work for me, as per my previous attempt. What does work is adding the VeryLazy event back in. I've had a quick look at your dotfiles repo and can't immediately see anything obvious that would be forcing your above config to be implicitly lazy as opposed to eager.

Also, when I use the VeryLazy event, both fg and foreground work.

This is a strange intersection of different keys working/not working, and different loading events.

I'm not sure I have the time/energy/excitement/whatever to try and debug what appears to be some intersection between Nvim loading lifecycle and Lazy loading lifecycle (even though this doesn't explain why your above config works with foreground but not the offical docs fg key). I think I'll just leave the VeryLazy event in and add a comment about it.

You may wish to add a note to the readme that if others are having issues with getting the custom highlight config to work, to refer to this conversation.

If I do ever figure it out, I'll comment back here. Otherwise, thanks to you both @tris203 and @willothy for your help and assistance with this PR.

givensuman · 2024-06-03T16:14:57Z

I'm having a similar issue with highlight color not being changed

tris203 · 2024-06-03T16:40:35Z

I'm having a similar issue with highlight color not being changed

Interesting. Can you open an issue please @givensuman with neovim version info?

givensuman · 2024-06-03T18:23:48Z

I got it working, but I'll document the issue here for posterity.

$ nvim --version

NVIM v0.10.0
Build type: Release
LuaJIT 2.1.1713484068
Run "nvim -V1 -v" for more info

I'm a bit of a Neovim newbie and am using the AstroNvim framework which includes a packaged version of this plugin in it's Astrocommunity repo which was how I was using this plugin when I made the above comment.

That addition looks like this in my configuration (specifically, the community.lua file):

  { import = "astrocommunity.workflow.precognition-nvim" },
  {
    "tris203/precognition.nvim",
    event = "VeryLazy",
    config = {
      highlightColor = {
        foreground = "#FF4499",
      },
    },
  },

I scrubbed that out and manually imported the plugin in a LazySpec file like this (specifically, the plugins/user.lua file:

  {
    "tris203/precognition.nvim",
    event = "VeryLazy",
    opts = {},
    config = function()
      require("precognition").setup {
        highlightColor = {
          foreground = "#FF4499",
        },
      }
    end,
  },

This seems more likely an AstroNvim issue than a precognition.nvim one, but I'm actually having trouble recreating it to open an issue there.

Anyways, thanks for the sweet plugin!

feat: further customise highlight colors

1cdbde3

willothy reviewed May 23, 2024

View reviewed changes

Fixes indentation, highlight casing.

e8b35c4

tris203 reviewed May 23, 2024

View reviewed changes

tris203 added 2 commits May 23, 2024 17:22

refactor: drop string input add tests

48b95de

docs: update docs

3220992

tris203 requested a review from willothy May 23, 2024 16:28

willothy reviewed May 23, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

lua/precognition/init.lua Show resolved Hide resolved

docs: clearer wording

2ac25e8

willothy approved these changes May 23, 2024

View reviewed changes

tris203 merged commit 83d452d into tris203:main May 23, 2024
9 checks passed

github-actions bot mentioned this pull request May 22, 2024

chore(main): release 1.0.0 #14

Merged

tris203 mentioned this pull request May 24, 2024

Incorrect syntax for highlightColor in README #36

Closed

josh-nz deleted the feature/custom-highlights branch May 31, 2024 23:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: further customise highlight colors #31

feat: further customise highlight colors #31

josh-nz commented May 23, 2024 •

edited

Loading

willothy May 23, 2024

josh-nz May 23, 2024

tris203 May 23, 2024

willothy commented May 23, 2024

tris203 left a comment

tris203 May 23, 2024

josh-nz May 23, 2024 •

edited

Loading

tris203 May 23, 2024

willothy left a comment

willothy left a comment

tris203 commented May 23, 2024 •

edited

Loading

josh-nz commented May 24, 2024 •

edited

Loading

tris203 commented May 24, 2024

josh-nz commented May 24, 2024

tris203 commented May 24, 2024 •

edited

Loading

josh-nz commented May 24, 2024 •

edited

Loading

tris203 commented May 24, 2024

josh-nz commented May 24, 2024

tris203 commented May 24, 2024

josh-nz commented May 24, 2024 •

edited

Loading

givensuman commented Jun 3, 2024

tris203 commented Jun 3, 2024

givensuman commented Jun 3, 2024

feat: further customise highlight colors #31

feat: further customise highlight colors #31

Conversation

josh-nz commented May 23, 2024 • edited Loading

willothy May 23, 2024

Choose a reason for hiding this comment

josh-nz May 23, 2024

Choose a reason for hiding this comment

tris203 May 23, 2024

Choose a reason for hiding this comment

willothy commented May 23, 2024

tris203 left a comment

Choose a reason for hiding this comment

tris203 May 23, 2024

Choose a reason for hiding this comment

josh-nz May 23, 2024 • edited Loading

Choose a reason for hiding this comment

tris203 May 23, 2024

Choose a reason for hiding this comment

willothy left a comment

Choose a reason for hiding this comment

willothy left a comment

Choose a reason for hiding this comment

tris203 commented May 23, 2024 • edited Loading

josh-nz commented May 24, 2024 • edited Loading

tris203 commented May 24, 2024

josh-nz commented May 24, 2024

tris203 commented May 24, 2024 • edited Loading

josh-nz commented May 24, 2024 • edited Loading

tris203 commented May 24, 2024

josh-nz commented May 24, 2024

tris203 commented May 24, 2024

josh-nz commented May 24, 2024 • edited Loading

givensuman commented Jun 3, 2024

tris203 commented Jun 3, 2024

givensuman commented Jun 3, 2024

josh-nz commented May 23, 2024 •

edited

Loading

josh-nz May 23, 2024 •

edited

Loading

tris203 commented May 23, 2024 •

edited

Loading

josh-nz commented May 24, 2024 •

edited

Loading

tris203 commented May 24, 2024 •

edited

Loading

josh-nz commented May 24, 2024 •

edited

Loading

josh-nz commented May 24, 2024 •

edited

Loading