BREAKING_CHANGE: set lualine theme with theme="auto"

check updated docs at https://github.com/projekt0n/github-nvim-theme/blob/main/LUALINE.md

Author: ful1e5

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - refactor: implement highlight override function in `util.load`
 - enhance: `overrides` function is now able to add custom highlight in `dev` mode.
 - docs: about developer mode
+- breaking-change: set lualine theme with `theme="auto"`
 
 ### Fixes
 

LUALINE.md

@@ -1,4 +1,4 @@
-To enable the `github` theme for `Lualine`, simply specify it in your lualine settings **after theme settings**:
+To enable the `github` theme for `Lualine`, simply specify it in your lualine settings **after theme settings**:A
 
 ### packer
 
@@ -9,7 +9,7 @@ use {
   config = function()
     require("lualine").setup {
       options = {
-        theme = "github" -- or "auto"
+        theme = "auto" -- or you can assign github_* themes individually.
         -- ... your lualine config
       }
     }
@@ -32,7 +32,7 @@ use {
 lua << EOF
 require('lualine').setup {
   options = {
-    theme = 'github', -- or "auto"
+    theme = "auto" -- or you can assign github_* themes individually.
     -- ... your lualine config
   }
 }
@@ -44,63 +44,63 @@ EOF
 ```lua
 require('lualine').setup {
   options = {
-    theme = 'github', -- or "auto"
+    theme = "auto" -- or you can assign github_* themes individually.
     -- ... your lualine config
   }
 }
 ```
 
-### Screenshots
+### Lualine Themes
 
-#### dark
+#### github_dark
 
 ![normal](https://imgur.com/zBRwlUm.png)
 ![insert](https://imgur.com/n5DG48e.png)
 ![visual](https://imgur.com/MWQXJLD.png)
 ![command](https://imgur.com/HGIYVSN.png)
 ![terminal](https://imgur.com/pEWjIJ8.png)
 
-#### dimmed
+#### github_dimmed
 
 ![normal](https://imgur.com/R800MhA.png)
 ![insert](https://imgur.com/42M0X0O.png)
 ![visual](https://imgur.com/euIfZtW.png)
 ![command](https://imgur.com/E4tzBCD.png)
 ![terminal](https://imgur.com/RASnrFw.png)
 
-#### dark_default
+#### github_dark_default
 
 ![normal](https://imgur.com/yHa1cK1.png)
 ![insert](https://imgur.com/mMX2364.png)
 ![visual](https://imgur.com/SNwhnph.png)
 ![command](https://imgur.com/aLifoAv.png)
 ![terminal](https://imgur.com/Q7mG5m8.png)
 
-#### dark_colorblind
+#### github_dark_colorblind
 
 ![normal](https://imgur.com/yHa1cK1.png)
 ![insert](https://imgur.com/mMX2364.png)
 ![visual](https://imgur.com/SNwhnph.png)
 ![command](https://imgur.com/aLifoAv.png)
 ![terminal](https://imgur.com/Q7mG5m8.png)
 
-#### light
+#### github_light
 
 ![normal](https://imgur.com/om8f3S5.png)
 ![insert](https://imgur.com/qawZ4G6.png)
 ![visual](https://imgur.com/3j3ThxU.png)
 ![command](https://imgur.com/ItcANVN.png)
 ![terminal](https://imgur.com/8SgNyIU.png)
 
-#### light_default
+#### github_light_default
 
 ![normal](https://imgur.com/lwTCVXc.png)
 ![insert](https://imgur.com/zh9uPGS.png)
 ![visual](https://imgur.com/e3xYvfu.png)
 ![command](https://imgur.com/TrjrA3i.png)
 ![terminal](https://imgur.com/7ukHRhL.png)
 
-#### light_colorblind
+#### github_light_colorblind
 
 ![normal](https://imgur.com/lwTCVXc.png)
 ![insert](https://imgur.com/zh9uPGS.png)

lua/github-theme/plugins/lualine.lua

@@ -0,0 +1,47 @@
+local util = require('github-theme.util')
+
+local lualine = {}
+
+--- build lualine theme for github theme
+---@param c gt.ColorPalette
+lualine.build_lualine_theme = function(c)
+  --- create lualine group colors for github-theme
+  ---@param color string
+  ---@return table
+  local tint_lualine_group = function(color)
+    local group = {
+      a = { bg = color, fg = c.bg },
+      b = { bg = util.darken(color, 0.2), fg = util.lighten(color, 0.2) },
+    }
+    if vim.o.background == 'dark' then
+      group.c = {
+        bg = util.darken(color, 0.01, c.bg2),
+        fg = util.lighten(color, 0.4, c.fg),
+      }
+    else
+      -- inverting colors for light colorschemes
+      group.c = {
+        bg = util.lighten(color, 0.01, c.bg2),
+        fg = util.darken(color, 0.4, c.fg),
+      }
+    end
+    return group
+  end
+
+  local inactive_hi = { bg = c.bg2, fg = util.darken(c.fg, 0.3) }
+  return {
+    normal = tint_lualine_group(c.blue),
+    insert = tint_lualine_group(c.green),
+    command = tint_lualine_group(c.bright_magenta),
+    visual = tint_lualine_group(c.yellow),
+    replace = tint_lualine_group(c.red),
+    terminal = tint_lualine_group(c.orange),
+    inactive = {
+      a = inactive_hi,
+      b = inactive_hi,
+      c = inactive_hi,
+    },
+  }
+end
+
+return lualine

lua/lualine/themes/github.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'dark' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_dark.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'dark_colorblind' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_dark_colorblind.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'dark_default' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_dark_default.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'dimmed' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_dimmed.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'light' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_light.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'light_colorblind' })
+return lualine.build_lualine_theme(c)

lua/lualine/themes/github_light_colorblind.lua

@@ -0,0 +1,5 @@
+local colors = require('github-theme.colors')
+local lualine = require('github-theme.plugins.lualine')
+
+local c = colors.setup({ theme_style = 'light_default' })
+return lualine.build_lualine_theme(c)