feat!: change italics configuration for finer control

[delafthi]

Instead of just enabling or disabling italics provide a table where the user can enable italics for different keywords.

    italics = {
        enabled = true, -- Enable/disable italics globally
        -- Enable/disable italics on a finer level. Changing settings below will only have effect when 'enabled' is set to true
        attributes = false,
        builtins = true,
        comments = false,
        constructors = true,
        conditionals = true,
        defines = false,
        emphasis = true,
        exceptions = false,
        fields = false,
        functions = true,
        includes = false,
        keywords = false,
        labels = true,
        parameters = true,
        properties = false,
        repeats = true,
        types = false,
        variables = false,
    },

This change breaks old configurations (the old settings just won't have any effect) due to:

• italic changed to italics, which requires a table now
• italic_comments merged into the italics table

[andersevenrud]

Just some minor comments on the structuring and definitions on this new feature.

I'm open to leaving things as a string: boolean table, but I think maybe just a flat set of strings might be nicer.

[andersevenrud]

Having enabled inside a table like this together with all of the toggles feels a bit weird. Maybe something like this instead ?

{
  italic = true,
  italics = { 'attributes', 'comments' } -- and so on
}

[delafthi]

What do you think about this approach?

{
  italics = false -- or {} to disable italics
}
{
  italics = { 'attributes', 'comments', ...} -- to enable italics for named keywords
}

If someone doesn't define the italics key in his config it gets extended by the defaults anyway.

One drawback I see, with a list of strings is that if someone wants to add one keyword to the defaults he has to define all the defaults as well. In this case it would be nice to have an append method.

[andersevenrud]

One drawback I see, with a list of strings is that if someone wants to add one keyword to the defaults he has to define all the defaults as well. In this case it would be nice to have an append method.

Indeed. Another alternative to having that string: boolean table could possibly be to have a callback that provides the list of defaults so that you can define like this:

-- No italics
italics = false

-- Just use defaults
italics = true

-- Custom list
italics = { 'a', 'b', 'c' }

-- With defaults
italics = function(def) return vim.tbl_extend({ 'a', 'b', 'c' }, def) end

This would have the benefit of consolidating things as well, but not sure the callback pattern is super intuitive 🤷‍♂️

But I'm open to your initial suggestion. Combined with the map loop it won't be as verbose as initially was.

[andersevenrud]

One drawback I see, with a list of strings is that if someone wants to add one keyword to the defaults he has to define all the defaults as well. In this case it would be nice to have an append method.

This goes the other way as well. If someone wants to disable any of the defaults some definition would have to be added (with the original implementation).

The more I think of it, the more I lean towards having a plain set of names 🤔 Another solution that came to mind for doing appending is having some kind of "magic" string (like _ or _defaults_ or whatever), but I don't like magical things in configurations 😅

[delafthi]

I thought about a possible solution this weekend. What do you think about something similar to https://github.com/folke/tokyonight.nvim#%EF%B8%8F-configuration?

[andersevenrud]

Sorry about late reply @delafthi, the notification slipped my mind.

Something like that would be nice, but I feel like #70 should come first because that would make things a bit nicer to work with in general (and very easy to manage backward compatability just as is here today).

[andersevenrud]

Continuation from last comment, this probably also should be put into an italics table which can be mapped to make things less verbose:

-- Revert to defaults if none was configured
local italicDefaults = { 'comments' }
local italicDefinitions = #options.italics == 0 and italicDefaults or options.italics

-- Map the configured names into styles
-- Could probably just be empty and skip the loop even if disabled. Should have same effect
local italics = {}
for _, v in ipairs(italicDefinitions) do
  italics[v] = options.italic and s.italic or s.none
end

-- Put as a custom style table
local cs = {
  italics = italics
  -- ...
}

Which can be used as { comments, c.grayish, c.none, cs.italics.comments }. Even if the italics table does not contain all available names, it should work as expected because nil should get converted to a "none" down the line.