DarthMooMancer/min-kanso.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BREAKING CHANGE: rename "contrast" to "saturated" throughout codebase

Browse Source 
This change renames all occurrences of "contrast" to "saturated" to better describe the functionality:
- Config option `foreground` now accepts "saturated" instead of "contrast"
- All internal color palette variables renamed from *Contrast to *Saturated
- Documentation updated to reflect the new terminology

Migration guide:
- If using `foreground = "contrast"`, change to `foreground = "saturated"`
- If using `foreground = { dark = "contrast", light = "contrast" }`, change to `foreground = { dark = "saturated", light = "saturated" }`
This commit is contained in:
Webhooked
2025-07-28 09:33:50 +02:00
parent 9a81f41042
commit d1ba9eaf7c
4 changed files with 115 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -11
View File
@@ -30,7 +30,7 @@
- 🔌 Compatible with popular plugins out of the box - 🔌 Compatible with popular plugins out of the box
- ⚡ Compilation to lua byte code for fast startup times - ⚡ Compilation to lua byte code for fast startup times
- 🎨 Four beautiful theme variants to match your mood and environment - 🎨 Four beautiful theme variants to match your mood and environment
- 🔆 Contrast mode for enhanced syntax highlighting visibility - 🔆 Saturated mode for enhanced syntax highlighting visibility
- 👁️ WCAG 2.1 AA compliant - 👁️ WCAG 2.1 AA compliant
## 📦 Installation ## 📦 Installation
@@ -98,7 +98,7 @@ require('kanso').setup({
dark = "ink", -- try "zen" ! dark = "ink", -- try "zen" !
light = "pearl" -- try "mist" ! light = "pearl" -- try "mist" !
}, },
foreground = "default", -- "default" or "contrast" (can also be a table like background) foreground = "default", -- "default" or "saturated" (can also be a table like background)
}) })
-- setup must be called before loading -- setup must be called before loading
@@ -137,12 +137,12 @@ Kansō comes in four beautiful variants:
<br/><br/> <br/><br/>
<h3>✧ Ink ✧</h3> <h3>✧ Ink ✧</h3>
<p>Balanced theme with elegant contrast.</p> <p>Balanced theme with elegant colors.</p>
<img src="kanso_ink.png" width="900"> <img src="kanso_ink.png" width="900">
<br/><br/> <br/><br/>
<h3>✧ Mist ✧</h3> <h3>✧ Mist ✧</h3>
<p>Soft & muted dark theme with gentle contrast.</p> <p>Soft & muted dark theme with gentle colors.</p>
<img src="kanso_mist.png" width="900"> <img src="kanso_mist.png" width="900">
<br/><br/> <br/><br/>
@@ -178,12 +178,12 @@ require("kanso").load("zen")
</details> </details>
## 🌟 Foreground Contrast ## 🌟 Foreground Saturation
Kansō now supports a foreground contrast option that enhances the saturation of syntax highlighting colors while keeping the same background colors. This is useful for improving visibility in certain lighting conditions or personal preference. Kansō now supports a foreground saturation option that enhances the saturation of syntax highlighting colors while keeping the same background colors. This is useful for improving visibility in certain lighting conditions or personal preference.
<details> <details>
<summary><strong>🔆 Using Contrast Mode</strong></summary> <summary><strong>🔆 Using Saturated Mode</strong></summary>
The `foreground` option can be configured per background mode: The `foreground` option can be configured per background mode:
@@ -191,12 +191,12 @@ The `foreground` option can be configured per background mode:
require('kanso').setup({ require('kanso').setup({
foreground = { foreground = {
dark = "default", -- Use default colors in dark mode dark = "default", -- Use default colors in dark mode
light = "contrast" -- Use higher saturation in light mode light = "saturated" -- Use higher saturation in light mode
}, },
}) })
``` ```
When set to `"contrast"`, syntax highlighting colors will have increased saturation making them stand out more against the background: When set to `"saturated"`, syntax highlighting colors will have increased saturation making them stand out more against the background:
- Zen, Ink, and Mist themes: 20% more vibrant colors - Zen, Ink, and Mist themes: 20% more vibrant colors
- Pearl theme: 40% more vibrant colors - Pearl theme: 40% more vibrant colors
@@ -205,9 +205,9 @@ This is particularly useful:
- In bright environments where you need more color distinction - In bright environments where you need more color distinction
- For users who prefer more vibrant syntax highlighting - For users who prefer more vibrant syntax highlighting
- When using the light themes where contrast can be beneficial - When using the light themes where increased saturation can be beneficial
The contrast adjustment only affects syntax highlighting colors (strings, keywords, functions, etc.) and does not change UI elements or background colors. The saturation adjustment only affects syntax highlighting colors (strings, keywords, functions, etc.) and does not change UI elements or background colors.
</details> </details>
lua/kanso/colors.lua
+48 -48
View File
@@ -57,29 +57,29 @@ local palette = {
orange2 = "#b98d7b", orange2 = "#b98d7b",
aqua = "#8ea4a2", aqua = "#8ea4a2",
-- Contrast variants (20% more saturation) -- Saturated variants (20% more saturation)
redContrast = "#C93134", redSaturated = "#C93134",
red2Contrast = "#ED5965", red2Saturated = "#ED5965",
red3Contrast = "#CA675F", red3Saturated = "#CA675F",
yellowContrast = "#E59F49", yellowSaturated = "#E59F49",
yellow2Contrast = "#EDC272", yellow2Saturated = "#EDC272",
yellow3Contrast = "#CAAC7A", yellow3Saturated = "#CAAC7A",
greenContrast = "#8FC055", greenSaturated = "#8FC055",
green2Contrast = "#7CAF7C", green2Saturated = "#7CAF7C",
green3Contrast = "#7F9F6E", green3Saturated = "#7F9F6E",
green4Contrast = "#5B9A82", green4Saturated = "#5B9A82",
green5Contrast = "#6BAE97", green5Saturated = "#6BAE97",
blueContrast = "#6EBBD4", blueSaturated = "#6EBBD4",
blue2Contrast = "#568B8F", blue2Saturated = "#568B8F",
blue3Contrast = "#7EAABA", blue3Saturated = "#7EAABA",
blue4Contrast = "#81AAA9", blue4Saturated = "#81AAA9",
violetContrast = "#8A88B0", violetSaturated = "#8A88B0",
violet2Contrast = "#7E91AF", violet2Saturated = "#7E91AF",
violet3Contrast = "#8A9FBE", violet3Saturated = "#8A9FBE",
pinkContrast = "#A08AA2", pinkSaturated = "#A08AA2",
orangeContrast = "#BC8A6C", orangeSaturated = "#BC8A6C",
orange2Contrast = "#BF856B", orange2Saturated = "#BF856B",
aquaContrast = "#81AAA9", aquaSaturated = "#81AAA9",
-- Fg and Comments -- Fg and Comments
fg = "#C5C9C7", fg = "#C5C9C7",
@@ -133,29 +133,29 @@ local palette = {
pearlTeal3 = "#5a7785", pearlTeal3 = "#5a7785",
pearlCyan = "#d7e3d8", pearlCyan = "#d7e3d8",
-- Pearl contrast variants (40% more saturation) -- Pearl saturated variants (40% more saturation)
pearlGreenContrast = "#5E8F2F", pearlGreenSaturated = "#5E8F2F",
pearlGreen2Contrast = "#5B9945", pearlGreen2Saturated = "#5B9945",
pearlGreen3Contrast = "#A8DA9B", pearlGreen3Saturated = "#A8DA9B",
pearlPinkContrast = "#C04062", pearlPinkSaturated = "#C04062",
pearlOrangeContrast = "#E05700", pearlOrangeSaturated = "#E05700",
pearlOrange2Contrast = "#FF7700", pearlOrange2Saturated = "#FF7700",
pearlYellowContrast = "#656720", pearlYellowSaturated = "#656720",
pearlYellow2Contrast = "#72612B", pearlYellow2Saturated = "#72612B",
pearlYellow3Contrast = "#F28C00", pearlYellow3Saturated = "#F28C00",
pearlYellow4Contrast = "#FFD56D", pearlYellow4Saturated = "#FFD56D",
pearlRedContrast = "#D72436", pearlRedSaturated = "#D72436",
pearlRed2Contrast = "#E42D2C", pearlRed2Saturated = "#E42D2C",
pearlRed3Contrast = "#F50000", pearlRed3Saturated = "#F50000",
pearlRed4Contrast = "#E4977B", pearlRed4Saturated = "#E4977B",
pearlAquaContrast = "#3E8366", pearlAquaSaturated = "#3E8366",
pearlAqua2Contrast = "#428F6A", pearlAqua2Saturated = "#428F6A",
pearlTeal1Contrast = "#2E96B0", pearlTeal1Saturated = "#2E96B0",
pearlTeal2Contrast = "#469FD3", pearlTeal2Saturated = "#469FD3",
pearlTeal3Contrast = "#3D8077", pearlTeal3Saturated = "#3D8077",
pearlBlue4Contrast = "#2A73B1", pearlBlue4Saturated = "#2A73B1",
pearlBlue5Contrast = "#3E56B8", pearlBlue5Saturated = "#3E56B8",
pearlViolet4Contrast = "#44418F", pearlViolet4Saturated = "#44418F",
} }
local M = {} local M = {}
@@ -165,7 +165,7 @@ local M = {}
--- Defaults to KansoConfig.colors. --- Defaults to KansoConfig.colors.
--- - theme: Use selected theme. Defaults to KansoConfig.theme --- - theme: Use selected theme. Defaults to KansoConfig.theme
--- according to the value of 'background' option. --- according to the value of 'background' option.
---@param opts? { colors?: table, theme?: string, foreground?: "default"|"contrast" } ---@param opts? { colors?: table, theme?: string, foreground?: "default"|"saturated" }
---@return { theme: ThemeColors, palette: PaletteColors} ---@return { theme: ThemeColors, palette: PaletteColors}
function M.setup(opts) function M.setup(opts)
opts = opts or {} opts = opts or {}
@@ -188,7 +188,7 @@ function M.setup(opts)
or (type(kanso_config.foreground) == "table" and kanso_config.foreground[bg_mode]) or (type(kanso_config.foreground) == "table" and kanso_config.foreground[bg_mode])
or kanso_config.foreground or kanso_config.foreground
or "default" or "default"
---@cast foreground "default"|"contrast" ---@cast foreground "default"|"saturated"
local theme_colors = require("kanso.themes")[theme](updated_palette_colors, foreground) local theme_colors = require("kanso.themes")[theme](updated_palette_colors, foreground)
-- Add to and/or override theme_colors -- Add to and/or override theme_colors
lua/kanso/init.lua
+3 -3
View File
@@ -27,7 +27,7 @@ M.config = {
---@type { dark: string, light: string } ---@type { dark: string, light: string }
background = { dark = "ink", light = "pearl" }, background = { dark = "ink", light = "pearl" },
theme = "ink", theme = "ink",
---@type { dark: "default"|"contrast", light: "default"|"contrast" }|"default"|"contrast" ---@type { dark: "default"|"saturated", light: "default"|"saturated" }|"default"|"saturated"
foreground = "default", foreground = "default",
compile = false, compile = false,
} }
@@ -88,7 +88,7 @@ function M.load(theme)
else else
local foreground_setting = type(M.config.foreground) == "table" and M.config.foreground[vim.o.background] local foreground_setting = type(M.config.foreground) == "table" and M.config.foreground[vim.o.background]
or M.config.foreground or M.config.foreground
---@cast foreground_setting "default"|"contrast" ---@cast foreground_setting "default"|"saturated"
local colors = local colors =
require("kanso.colors").setup({ theme = theme, colors = M.config.colors, foreground = foreground_setting }) require("kanso.colors").setup({ theme = theme, colors = M.config.colors, foreground = foreground_setting })
local highlights = require("kanso.highlights").setup(colors, M.config) local highlights = require("kanso.highlights").setup(colors, M.config)
@@ -128,7 +128,7 @@ function M.compile()
else else
-- Fallback for backward compatibility -- Fallback for backward compatibility
local foreground_str = M.config.foreground local foreground_str = M.config.foreground
---@cast foreground_str "default"|"contrast" ---@cast foreground_str "default"|"saturated"
local colors = require("kanso.colors").setup({ local colors = require("kanso.colors").setup({
theme = theme, theme = theme,
colors = M.config.colors, colors = M.config.colors,
lua/kanso/themes.lua
+53 -53
View File
@@ -92,7 +92,7 @@
return { return {
---@param palette PaletteColors ---@param palette PaletteColors
---@param foreground? "default"|"contrast" ---@param foreground? "default"|"saturated"
---@return ThemeColors ---@return ThemeColors
zen = function(palette, foreground) zen = function(palette, foreground)
return { return {
@@ -142,25 +142,25 @@ return {
}, },
}, },
syn = { syn = {
string = foreground == "contrast" and palette.green3Contrast or palette.green3, string = foreground == "saturated" and palette.green3Saturated or palette.green3,
variable = "NONE", variable = "NONE",
number = foreground == "contrast" and palette.pinkContrast or palette.pink, number = foreground == "saturated" and palette.pinkSaturated or palette.pink,
constant = foreground == "contrast" and palette.orangeContrast or palette.orange, constant = foreground == "saturated" and palette.orangeSaturated or palette.orange,
identifier = foreground == "contrast" and palette.violet2Contrast or palette.violet2, identifier = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
parameter = palette.gray3, parameter = palette.gray3,
fun = foreground == "contrast" and palette.blue3Contrast or palette.blue3, fun = foreground == "saturated" and palette.blue3Saturated or palette.blue3,
statement = foreground == "contrast" and palette.violet2Contrast or palette.violet2, statement = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
keyword = foreground == "contrast" and palette.violet2Contrast or palette.violet2, keyword = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
operator = palette.gray3, operator = palette.gray3,
preproc = palette.gray3, preproc = palette.gray3,
type = foreground == "contrast" and palette.aquaContrast or palette.aqua, type = foreground == "saturated" and palette.aquaSaturated or palette.aqua,
regex = foreground == "contrast" and palette.red3Contrast or palette.red3, regex = foreground == "saturated" and palette.red3Saturated or palette.red3,
deprecated = palette.gray, deprecated = palette.gray,
punct = palette.gray3, punct = palette.gray3,
comment = palette.gray4, comment = palette.gray4,
special1 = foreground == "contrast" and palette.yellow3Contrast or palette.yellow3, special1 = foreground == "saturated" and palette.yellow3Saturated or palette.yellow3,
special2 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special2 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
special3 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special3 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
}, },
diag = { diag = {
error = palette.red, error = palette.red,
@@ -204,7 +204,7 @@ return {
} }
end, end,
---@param palette PaletteColors ---@param palette PaletteColors
---@param foreground? "default"|"contrast" ---@param foreground? "default"|"saturated"
---@return ThemeColors ---@return ThemeColors
ink = function(palette, foreground) ink = function(palette, foreground)
return { return {
@@ -254,25 +254,25 @@ return {
}, },
}, },
syn = { syn = {
string = foreground == "contrast" and palette.green3Contrast or palette.green3, string = foreground == "saturated" and palette.green3Saturated or palette.green3,
variable = "NONE", variable = "NONE",
number = foreground == "contrast" and palette.pinkContrast or palette.pink, number = foreground == "saturated" and palette.pinkSaturated or palette.pink,
constant = foreground == "contrast" and palette.orangeContrast or palette.orange, constant = foreground == "saturated" and palette.orangeSaturated or palette.orange,
identifier = foreground == "contrast" and palette.violet2Contrast or palette.violet2, identifier = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
parameter = palette.gray3, parameter = palette.gray3,
fun = foreground == "contrast" and palette.blue3Contrast or palette.blue3, fun = foreground == "saturated" and palette.blue3Saturated or palette.blue3,
statement = foreground == "contrast" and palette.violet2Contrast or palette.violet2, statement = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
keyword = foreground == "contrast" and palette.violet2Contrast or palette.violet2, keyword = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
operator = palette.gray3, operator = palette.gray3,
preproc = palette.gray3, preproc = palette.gray3,
type = foreground == "contrast" and palette.aquaContrast or palette.aqua, type = foreground == "saturated" and palette.aquaSaturated or palette.aqua,
regex = foreground == "contrast" and palette.red3Contrast or palette.red3, regex = foreground == "saturated" and palette.red3Saturated or palette.red3,
deprecated = palette.gray, deprecated = palette.gray,
punct = palette.gray3, punct = palette.gray3,
comment = palette.gray4, comment = palette.gray4,
special1 = foreground == "contrast" and palette.yellow3Contrast or palette.yellow3, special1 = foreground == "saturated" and palette.yellow3Saturated or palette.yellow3,
special2 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special2 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
special3 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special3 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
}, },
diag = { diag = {
error = palette.red, error = palette.red,
@@ -316,7 +316,7 @@ return {
} }
end, end,
---@param palette PaletteColors ---@param palette PaletteColors
---@param foreground? "default"|"contrast" ---@param foreground? "default"|"saturated"
---@return ThemeColors ---@return ThemeColors
pearl = function(palette, foreground) pearl = function(palette, foreground)
return { return {
@@ -365,25 +365,25 @@ return {
}, },
}, },
syn = { syn = {
string = foreground == "contrast" and palette.pearlGreenContrast or palette.pearlGreen, string = foreground == "saturated" and palette.pearlGreenSaturated or palette.pearlGreen,
variable = "NONE", variable = "NONE",
number = foreground == "contrast" and palette.pearlPinkContrast or palette.pearlPink, number = foreground == "saturated" and palette.pearlPinkSaturated or palette.pearlPink,
constant = foreground == "contrast" and palette.pearlOrangeContrast or palette.pearlOrange, constant = foreground == "saturated" and palette.pearlOrangeSaturated or palette.pearlOrange,
identifier = foreground == "contrast" and palette.pearlViolet4Contrast or palette.pearlViolet4, identifier = foreground == "saturated" and palette.pearlViolet4Saturated or palette.pearlViolet4,
parameter = foreground == "contrast" and palette.pearlBlue5Contrast or palette.pearlBlue5, parameter = foreground == "saturated" and palette.pearlBlue5Saturated or palette.pearlBlue5,
fun = foreground == "contrast" and palette.pearlBlue4Contrast or palette.pearlBlue4, fun = foreground == "saturated" and palette.pearlBlue4Saturated or palette.pearlBlue4,
statement = foreground == "contrast" and palette.pearlViolet4Contrast or palette.pearlViolet4, statement = foreground == "saturated" and palette.pearlViolet4Saturated or palette.pearlViolet4,
keyword = foreground == "contrast" and palette.pearlViolet4Contrast or palette.pearlViolet4, keyword = foreground == "saturated" and palette.pearlViolet4Saturated or palette.pearlViolet4,
operator = palette.pearlGray3, operator = palette.pearlGray3,
preproc = palette.pearlGray2, preproc = palette.pearlGray2,
type = foreground == "contrast" and palette.pearlAquaContrast or palette.pearlAqua, type = foreground == "saturated" and palette.pearlAquaSaturated or palette.pearlAqua,
regex = foreground == "contrast" and palette.pearlYellow2Contrast or palette.pearlYellow2, regex = foreground == "saturated" and palette.pearlYellow2Saturated or palette.pearlYellow2,
deprecated = palette.pearlGray3, deprecated = palette.pearlGray3,
comment = palette.pearlGray3, comment = palette.pearlGray3,
punct = palette.pearlGray3, punct = palette.pearlGray3,
special1 = foreground == "contrast" and palette.pearlYellow2Contrast or palette.pearlYellow2, special1 = foreground == "saturated" and palette.pearlYellow2Saturated or palette.pearlYellow2,
special2 = foreground == "contrast" and palette.pearlViolet4Contrast or palette.pearlViolet4, special2 = foreground == "saturated" and palette.pearlViolet4Saturated or palette.pearlViolet4,
special3 = foreground == "contrast" and palette.pearlViolet4Contrast or palette.pearlViolet4, special3 = foreground == "saturated" and palette.pearlViolet4Saturated or palette.pearlViolet4,
}, },
vcs = { vcs = {
added = palette.pearlGreen2, added = palette.pearlGreen2,
@@ -427,7 +427,7 @@ return {
} }
end, end,
---@param palette PaletteColors ---@param palette PaletteColors
---@param foreground? "default"|"contrast" ---@param foreground? "default"|"saturated"
---@return ThemeColors ---@return ThemeColors
mist = function(palette, foreground) mist = function(palette, foreground)
return { return {
@@ -477,25 +477,25 @@ return {
}, },
}, },
syn = { syn = {
string = foreground == "contrast" and palette.green3Contrast or palette.green3, string = foreground == "saturated" and palette.green3Saturated or palette.green3,
variable = "NONE", variable = "NONE",
number = foreground == "contrast" and palette.pinkContrast or palette.pink, number = foreground == "saturated" and palette.pinkSaturated or palette.pink,
constant = foreground == "contrast" and palette.orangeContrast or palette.orange, constant = foreground == "saturated" and palette.orangeSaturated or palette.orange,
identifier = foreground == "contrast" and palette.violet2Contrast or palette.violet2, identifier = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
parameter = palette.gray3, parameter = palette.gray3,
fun = foreground == "contrast" and palette.blue3Contrast or palette.blue3, fun = foreground == "saturated" and palette.blue3Saturated or palette.blue3,
statement = foreground == "contrast" and palette.violet2Contrast or palette.violet2, statement = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
keyword = foreground == "contrast" and palette.violet2Contrast or palette.violet2, keyword = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
operator = palette.gray3, operator = palette.gray3,
preproc = palette.gray3, preproc = palette.gray3,
type = foreground == "contrast" and palette.aquaContrast or palette.aqua, type = foreground == "saturated" and palette.aquaSaturated or palette.aqua,
regex = foreground == "contrast" and palette.red3Contrast or palette.red3, regex = foreground == "saturated" and palette.red3Saturated or palette.red3,
deprecated = palette.gray, deprecated = palette.gray,
punct = palette.gray3, punct = palette.gray3,
comment = palette.gray4, comment = palette.gray4,
special1 = foreground == "contrast" and palette.yellow3Contrast or palette.yellow3, special1 = foreground == "saturated" and palette.yellow3Saturated or palette.yellow3,
special2 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special2 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
special3 = foreground == "contrast" and palette.violet2Contrast or palette.violet2, special3 = foreground == "saturated" and palette.violet2Saturated or palette.violet2,
}, },
diag = { diag = {
error = palette.red, error = palette.red,