+
+ + Atom's iconic One Dark theme for Neovim, written in Lua
@@ -180,11 +189,14 @@ vim.g.onedark_italic_variables = false ### Italic -``` -vim.g.onedark_italic_comments = true -vim.g.onedark_italic_keywords = true -vim.g.onedark_italic_functions = true -vim.g.onedark_italic_variables = true +```lua +require("onedark").setup({ + commentStyle = true, + keywordStyle = true, + functionStyle = true, + variableStyle = true, + -- ... your onedark config +}) ```
From b7ebff44c7c5c4f32036f0166f349c86fd3439c9 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sat, 19 Jun 2021 15:18:05 +0530 Subject: [PATCH 3/9] =?UTF-8?q?=F0=9F=A7=B9=20Clean=20global=20keys=20insi?= =?UTF-8?q?de=20`onedark.config`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++---------- lua/onedark/config.lua | 54 ++++++++++++++++-------------------------- lua/onedark/init.lua | 2 +- 3 files changed, 34 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 59f8cae..a36bbd3 100644 --- a/README.md +++ b/README.md @@ -101,13 +101,13 @@ vim.g.lightline = {colorscheme = "onedark"} | Option | Default | Description | | ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commentStyle | `true` | Make comments italic | -| keywordStyle | `true` | Make keywords italic | -| functionStyle | `false` | Make functions italic | -| variableStyle | `false` | Make variables and identifiers italic | +| commentStyle | `NONE` | Make comments italic **(Options:** `NONE` or `Italic`) | +| keywordStyle | `NONE` | Make keywords italic **(Options:** `NONE` or `Italic`) | +| functionStyle | `NONE` | Make functions italic **(Options:** `NONE` or `Italic`) | +| variableStyle | `NONE` | Make variables and identifiers italic **(Options:** `NONE` or `Italic`) | | transparent | `false` | Enable this to disable setting the background color | | hideInactiveStatusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. | -| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]` | +| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` | | darkSidebar | `true` | Sidebar like windows like `NvimTree` get a darker background | | darkFloat | `true` | Float windows like the lsp diagnostics windows get a darker background. | | colors | `{}` | You can override specific color groups to use other groups or a hex color | @@ -175,10 +175,10 @@ Extra color configs for **Kitty**, and **Alacritty** can be found in [extras](ex ```lua require("onedark").setup({ - commentStyle = false, - keywordStyle = false, - functionStyle = false, - variableStyle = false, + commentStyle = "NONE", + keywordStyle = "NONE", + functionStyle = "NONE", + variableStyle = "NONE" -- ... your onedark config }) ``` @@ -191,10 +191,10 @@ require("onedark").setup({ ```lua require("onedark").setup({ - commentStyle = true, - keywordStyle = true, - functionStyle = true, - variableStyle = true, + commentStyle = "Italic", + keywordStyle = "Italic", + functionStyle = "Italic", + variableStyle = "Italic" -- ... your onedark config }) ``` diff --git a/lua/onedark/config.lua b/lua/onedark/config.lua index 063105b..abf1992 100644 --- a/lua/onedark/config.lua +++ b/lua/onedark/config.lua @@ -1,53 +1,39 @@ ---@class Config local config +local vimConfig = false + -- shim vim for kitty and other generators vim = vim or {g = {}, o = {}} local function opt(key, default) + key = "onedark_" .. key if vim.g[key] == nil then return default end - if vim.g[key] == 0 then return false end + if vim.g[key] == 0 then + vimConfig = true + return false + end + vimConfig = true return vim.g[key] end -local g = { - transparent = "onedark_transparent", - commentStyle = "onedark_italic_comments", - keywordStyle = "onedark_italic_keywords", - functionStyle = "onedark_italic_functions", - variableStyle = "onedark_italic_variables", - hideInactiveStatusline = "onedark_hide_inactive_statusline", - sidebars = "onedark_sidebars", - colors = "onedark_colors", - dev = "onedark_dev", - darkFloat = "onedark_dark_float", - darkSidebar = "onedark_dark_sidebar" -} - config = { - transparent = opt(g.transparent, false), - commentStyle = opt(g.commentStyle, true) and "italic" or "NONE", - keywordStyle = opt(g.keywordStyle, true) and "italic" or "NONE", - functionStyle = opt(g.functionStyle, false) and "italic" or "NONE", - variableStyle = opt(g.variableStyle, false) and "italic" or "NONE", - hideInactiveStatusline = opt(g.hideInactiveStatusline, false), - sidebars = opt(g.sidebars, {}), - colors = opt(g.colors, {}), - dev = opt(g.dev, false), - darkFloat = opt(g.darkFloat, true), - darkSidebar = opt(g.darkSidebar, true), + transparent = opt("transparent", false), + commentStyle = opt("italic_comments", true) and "italic" or "NONE", + keywordStyle = opt("italic_keywords", true) and "italic" or "NONE", + functionStyle = opt("italic_functions", false) and "italic" or "NONE", + variableStyle = opt("italic_variables", false) and "italic" or "NONE", + hideInactiveStatusline = opt("hide_inactive_statusline", false), + sidebars = opt("sidebars", {}), + colors = opt("colors", {}), + dev = opt("dev", false), + darkFloat = opt("dark_float", true), + darkSidebar = opt("dark_sidebar", true), transform_colors = false } -local function isGlobals() - for key, gKey in pairs(g) do - if vim.g[gKey] ~= nil and vim.g[gKey] ~= config[key] then return true end - end - return false -end - local function applyConfiguration(userConfig) for key, value in pairs(userConfig) do config[key] = value end end -return {config = config, isGlobals = isGlobals, applyConfiguration = applyConfiguration} +return {config = config, vimConfig = vimConfig, applyConfiguration = applyConfiguration} diff --git a/lua/onedark/init.lua b/lua/onedark/init.lua index 842a4e4..2495d80 100644 --- a/lua/onedark/init.lua +++ b/lua/onedark/init.lua @@ -5,7 +5,7 @@ local configModule = require("onedark.config") local function setup(userConfig) if userConfig then configModule.applyConfiguration(userConfig) - elseif configModule.isGlobals() then + elseif configModule.vimConfig then vim.schedule(function() vim.api.nvim_err_writeln( [[ful1e5/onedark: onedark will stop supporting vimscript soon, change your config to lua or wrap it around lua << EOF ... EOF]]) -- luacheck: ignore From 33c8e3c211d1b0bf9bc4ca8b03ced17b5564d246 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sat, 19 Jun 2021 16:39:32 +0530 Subject: [PATCH 4/9] =?UTF-8?q?=F0=9F=91=94=20Load=20colorscheme=20inside?= =?UTF-8?q?=20`setup`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes: - load colorscheme inisde `setup` function - show Key error inside `applyConfiguration` --- CHANGELOG.md | 2 ++ README.md | 12 ++++++------ colors/onedark.vim | 2 +- lua/onedark/config.lua | 10 +++++++++- lua/onedark/init.lua | 1 + 5 files changed, 19 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a9749ee..1b62492 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,10 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `Makefile, .lua-format, .luacheckrc` init - format .lua code with (lua-format)[https://github.com/Koihik/LuaFormatter] - `kitty` tabs color changed +- onedark setting using `reqiure("onedark.config")` [monsonjeremy/onedark.nvim#5] ### Changed - **VertSplit** & **Inactive StatusLine** `fg` color changed to `bg_visual` +- configuration docs updated inside README.md ## [v0.0.1] - 14 June 2021 diff --git a/README.md b/README.md index a36bbd3..7d61050 100644 --- a/README.md +++ b/README.md @@ -101,10 +101,10 @@ vim.g.lightline = {colorscheme = "onedark"} | Option | Default | Description | | ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commentStyle | `NONE` | Make comments italic **(Options:** `NONE` or `Italic`) | -| keywordStyle | `NONE` | Make keywords italic **(Options:** `NONE` or `Italic`) | -| functionStyle | `NONE` | Make functions italic **(Options:** `NONE` or `Italic`) | -| variableStyle | `NONE` | Make variables and identifiers italic **(Options:** `NONE` or `Italic`) | +| commentStyle | `NONE` | Make comments italic **(Options:** `NONE` or `italic`) | +| keywordStyle | `NONE` | Make keywords italic **(Options:** `NONE` or `italic`) | +| functionStyle | `NONE` | Make functions italic **(Options:** `NONE` or `italic`) | +| variableStyle | `NONE` | Make variables and identifiers italic **(Options:** `NONE` or `italic`) | | transparent | `false` | Enable this to disable setting the background color | | hideInactiveStatusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. | | sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` | @@ -115,7 +115,7 @@ vim.g.lightline = {colorscheme = "onedark"} ```lua -- Example config in Lua require("onedark").setup({ - functionStyle = true, + functionStyle = "italic", sidebars = {"qf", "vista_kind", "terminal", "packer"}, -- Change the "hint" color to the "orange" color, and make the "error" color bright red @@ -127,7 +127,7 @@ require("onedark").setup({ " Example config in VimScript lua << EOF require("onedark").setup({ - functionStyle = true, + functionStyle = "italic", sidebars = {"qf", "vista_kind", "terminal", "packer"}, -- Change the "hint" color to the "orange" color, and make the "error" color bright red diff --git a/colors/onedark.vim b/colors/onedark.vim index 3e828bc..5e23e67 100644 --- a/colors/onedark.vim +++ b/colors/onedark.vim @@ -6,4 +6,4 @@ lua package.loaded['onedark.colors'] = nil lua package.loaded['onedark.util'] = nil lua package.loaded['onedark.config'] = nil -lua require('onedark').setup() +" lua require('onedark').setup() diff --git a/lua/onedark/config.lua b/lua/onedark/config.lua index abf1992..58ab994 100644 --- a/lua/onedark/config.lua +++ b/lua/onedark/config.lua @@ -33,7 +33,15 @@ config = { } local function applyConfiguration(userConfig) - for key, value in pairs(userConfig) do config[key] = value end + for key, value in pairs(userConfig) do + if config[key] ~= nil then + config[key] = value + else + vim.schedule(function() + vim.api.nvim_err_writeln("ful1e5/onedark: Unable to set option '" .. key .. "'") -- luacheck: ignore + end) + end + end end return {config = config, vimConfig = vimConfig, applyConfiguration = applyConfiguration} diff --git a/lua/onedark/init.lua b/lua/onedark/init.lua index 2495d80..c325017 100644 --- a/lua/onedark/init.lua +++ b/lua/onedark/init.lua @@ -12,6 +12,7 @@ local function setup(userConfig) end) end util.load(theme.setup(configModule.config)) + vim.cmd [[colorscheme onedark]] end return {setup = setup} From 99003adee4a30ee4279dc637ba10de6891dc6c0a Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sat, 19 Jun 2021 18:12:44 +0530 Subject: [PATCH 5/9] =?UTF-8?q?=F0=9F=94=A7=20typing=20&=20case=20checking?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- colors/onedark.vim | 2 -- lua/onedark/config.lua | 13 +++++++------ lua/onedark/theme.lua | 2 +- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/colors/onedark.vim b/colors/onedark.vim index 5e23e67..b6e5be8 100644 --- a/colors/onedark.vim +++ b/colors/onedark.vim @@ -5,5 +5,3 @@ lua package.loaded['onedark.theme'] = nil lua package.loaded['onedark.colors'] = nil lua package.loaded['onedark.util'] = nil lua package.loaded['onedark.config'] = nil - -" lua require('onedark').setup() diff --git a/lua/onedark/config.lua b/lua/onedark/config.lua index 58ab994..dc92fb0 100644 --- a/lua/onedark/config.lua +++ b/lua/onedark/config.lua @@ -32,14 +32,15 @@ config = { transform_colors = false } +---@param userConfig Config local function applyConfiguration(userConfig) for key, value in pairs(userConfig) do - if config[key] ~= nil then - config[key] = value - else - vim.schedule(function() - vim.api.nvim_err_writeln("ful1e5/onedark: Unable to set option '" .. key .. "'") -- luacheck: ignore - end) + if value ~= nil then + if config[key] ~= nil then + config[key] = value + else + error("ful1e5/onedark: Option " .. key .. " does not exist") -- luacheck: ignore + end end end end diff --git a/lua/onedark/theme.lua b/lua/onedark/theme.lua index 31f829e..43098e9 100644 --- a/lua/onedark/theme.lua +++ b/lua/onedark/theme.lua @@ -326,7 +326,7 @@ function M.setup(config) theme.base.StatusLineNC = inactive -- LuaLine - for _, section in ipairs({"a", "b", "c"}) do + for _, section in pairs({"a", "b", "c"}) do theme.plugins["lualine_" .. section .. "_inactive"] = inactive end end From 29afc27220836b28bafb727316185167885cdb5e Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 20 Jun 2021 10:39:42 +0530 Subject: [PATCH 6/9] =?UTF-8?q?=F0=9F=92=9D=20Tidy=20`vimConfig`=20set?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lua/onedark/config.lua | 13 ++++++++----- lua/onedark/init.lua | 11 +++++++---- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/lua/onedark/config.lua b/lua/onedark/config.lua index dc92fb0..ee051d6 100644 --- a/lua/onedark/config.lua +++ b/lua/onedark/config.lua @@ -8,13 +8,16 @@ vim = vim or {g = {}, o = {}} local function opt(key, default) key = "onedark_" .. key - if vim.g[key] == nil then return default end - if vim.g[key] == 0 then + if vim.g[key] == nil then + return default + else vimConfig = true - return false + if vim.g[key] == 0 then + return false + else + return vim.g[key] + end end - vimConfig = true - return vim.g[key] end config = { diff --git a/lua/onedark/init.lua b/lua/onedark/init.lua index c325017..9752b2e 100644 --- a/lua/onedark/init.lua +++ b/lua/onedark/init.lua @@ -3,16 +3,19 @@ local theme = require("onedark.theme") local configModule = require("onedark.config") local function setup(userConfig) - if userConfig then - configModule.applyConfiguration(userConfig) - elseif configModule.vimConfig then + -- Warning, If config set inside 'vim.g' + if configModule.vimConfig then vim.schedule(function() vim.api.nvim_err_writeln( [[ful1e5/onedark: onedark will stop supporting vimscript soon, change your config to lua or wrap it around lua << EOF ... EOF]]) -- luacheck: ignore end) end + + -- Applying user configuration + if userConfig then configModule.applyConfiguration(userConfig) end + + -- Load colorscheme util.load(theme.setup(configModule.config)) - vim.cmd [[colorscheme onedark]] end return {setup = setup} From 3fea0df70f410d1837cce5cd196ab3b952a1902b Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 20 Jun 2021 11:20:54 +0530 Subject: [PATCH 7/9] =?UTF-8?q?=F0=9F=96=8C=EF=B8=8F=20Linting=20fixed?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .luacheckrc | 5 +-- extras/alacritty_onedark_.yml | 2 - extras/kitty_onedark_.conf | 79 ++++++++++++++++---------------- lua/onedark/colors.lua | 4 +- lua/onedark/extra/alacritty.lua | 3 +- lua/onedark/extra/kitty.lua | 80 ++++++++++++++++----------------- lua/onedark/theme.lua | 2 +- 7 files changed, 84 insertions(+), 91 deletions(-) diff --git a/.luacheckrc b/.luacheckrc index e67ca30..02d32c2 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -1,3 +1,2 @@ -globals = { - "vim", -} +globals = {"vim"} +max_comment_line_length = false diff --git a/extras/alacritty_onedark_.yml b/extras/alacritty_onedark_.yml index 90dabd4..d6697b5 100644 --- a/extras/alacritty_onedark_.yml +++ b/extras/alacritty_onedark_.yml @@ -30,5 +30,3 @@ colors: indexed_colors: - { index: 16, color: '0xd19a66' } - { index: 17, color: '0xf65866' } - - \ No newline at end of file diff --git a/extras/kitty_onedark_.conf b/extras/kitty_onedark_.conf index 5ba9e7e..bf1fdf4 100644 --- a/extras/kitty_onedark_.conf +++ b/extras/kitty_onedark_.conf @@ -1,40 +1,39 @@ - # onedark colors for Kitty - - background #282c34 - foreground #abb2bf - selection_background #393f4a - selection_foreground #abb2bf - url_color #98c379 - cursor #abb2bf - - # Tabs - active_tab_background #61afef - active_tab_foreground #282c34 - inactive_tab_background #abb2bf - inactive_tab_foreground #282c34 - #tab_bar_background #20232A - - # normal - color0 #20232A - color1 #e86671 - color2 #98c379 - color3 #e0af68 - color4 #61afef - color5 #c678dd - color6 #56b6c2 - color7 #798294 - - # bright - color8 #5c6370 - color9 #e86671 - color10 #98c379 - color11 #e0af68 - color12 #61afef - color13 #c678dd - color14 #56b6c2 - color15 #abb2bf - - # extended colors - color16 #d19a66 - color17 #f65866 - \ No newline at end of file +# onedark colors for Kitty + +background #282c34 +foreground #abb2bf +selection_background #393f4a +selection_foreground #abb2bf +url_color #98c379 +cursor #abb2bf + +# Tabs +active_tab_background #61afef +active_tab_foreground #282c34 +inactive_tab_background #abb2bf +inactive_tab_foreground #282c34 +#tab_bar_background #20232A + +# normal +color0 #20232A +color1 #e86671 +color2 #98c379 +color3 #e0af68 +color4 #61afef +color5 #c678dd +color6 #56b6c2 +color7 #798294 + +# bright +color8 #5c6370 +color9 #e86671 +color10 #98c379 +color11 #e0af68 +color12 #61afef +color13 #c678dd +color14 #56b6c2 +color15 #abb2bf + +# extended colors +color16 #d19a66 +color17 #f65866 diff --git a/lua/onedark/colors.lua b/lua/onedark/colors.lua index 69e56a1..ff0dc5c 100644 --- a/lua/onedark/colors.lua +++ b/lua/onedark/colors.lua @@ -10,9 +10,7 @@ function M.setup(config) -- Color Palette ---@class ColorScheme - local colors = {} - - colors = { + local colors = { none = "NONE", bg = "#282c34", bg2 = "#21252b", diff --git a/lua/onedark/extra/alacritty.lua b/lua/onedark/extra/alacritty.lua index 017f8e4..090f583 100644 --- a/lua/onedark/extra/alacritty.lua +++ b/lua/onedark/extra/alacritty.lua @@ -46,8 +46,7 @@ colors: indexed_colors: - { index: 16, color: '${orange}' } - { index: 17, color: '${red1}' } - - ]], alacrittyColors) +]], alacrittyColors) return alacritty end diff --git a/lua/onedark/extra/kitty.lua b/lua/onedark/extra/kitty.lua index b3b5c71..c755893 100644 --- a/lua/onedark/extra/kitty.lua +++ b/lua/onedark/extra/kitty.lua @@ -9,46 +9,46 @@ function M.kitty(config) local colors = require("onedark.colors").setup(config) local kitty = util.template([[ - # onedark colors for Kitty - - background ${bg} - foreground ${fg} - selection_background ${bg_visual} - selection_foreground ${fg} - url_color ${green} - cursor ${fg} - - # Tabs - active_tab_background ${blue} - active_tab_foreground ${bg} - inactive_tab_background ${fg} - inactive_tab_foreground ${bg} - #tab_bar_background ${black} - - # normal - color0 ${black} - color1 ${red} - color2 ${green} - color3 ${yellow} - color4 ${blue} - color5 ${purple} - color6 ${cyan} - color7 ${fg_dark} - - # bright - color8 ${fg_gutter} - color9 ${red} - color10 ${green} - color11 ${yellow} - color12 ${blue} - color13 ${purple} - color14 ${cyan} - color15 ${fg} - - # extended colors - color16 ${orange} - color17 ${red1} - ]], colors) +# onedark colors for Kitty + +background ${bg} +foreground ${fg} +selection_background ${bg_visual} +selection_foreground ${fg} +url_color ${green} +cursor ${fg} + +# Tabs +active_tab_background ${blue} +active_tab_foreground ${bg} +inactive_tab_background ${fg} +inactive_tab_foreground ${bg} +#tab_bar_background ${black} + +# normal +color0 ${black} +color1 ${red} +color2 ${green} +color3 ${yellow} +color4 ${blue} +color5 ${purple} +color6 ${cyan} +color7 ${fg_dark} + +# bright +color8 ${fg_gutter} +color9 ${red} +color10 ${green} +color11 ${yellow} +color12 ${blue} +color13 ${purple} +color14 ${cyan} +color15 ${fg} + +# extended colors +color16 ${orange} +color17 ${red1} +]], colors) return kitty end diff --git a/lua/onedark/theme.lua b/lua/onedark/theme.lua index 43098e9..2d612d2 100644 --- a/lua/onedark/theme.lua +++ b/lua/onedark/theme.lua @@ -15,7 +15,7 @@ function M.setup(config) theme.colors = colors.setup(config) local c = theme.colors - theme.base = { + theme.base = { -- luacheck: ignore Comment = {fg = c.fg_gutter, style = config.commentStyle}, -- any comment ColorColumn = {bg = c.bg_visual}, -- used for the columns set with 'colorcolumn' Conceal = {fg = c.fg_gutter}, -- placeholder characters substituted for concealed text (see 'conceallevel') From 1e363e752acb3d7129a56a5dca6334c30ef3f945 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 20 Jun 2021 17:43:33 +0530 Subject: [PATCH 8/9] =?UTF-8?q?=F0=9F=94=A7=20Docs=20and=20linting=20Impro?= =?UTF-8?q?ved?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 2 +- README.md | 34 ++++++++++++++++++---------------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/Makefile b/Makefile index c2a192a..ee9b057 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,6 @@ format: @for file in `find . -name '*.lua'`;do lua-format $$file -i; done; lint: $(onedark_path) - @luacheck $(onedark_path) + @luacheck $(onedark_path) --config .luacheckrc check: format lint diff --git a/README.md b/README.md index 7d61050..7d75dac 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,8 @@ require('onedark').setup() To enable the `onedark` theme for `Lualine`, simply specify it in your lualine settings: +> **📝 NOTE:** Set `lualine` configuration **before** `onedark`. + ```lua require('lualine').setup { options = { @@ -99,18 +101,18 @@ vim.g.lightline = {colorscheme = "onedark"} ## ⚙️ Configuration -| Option | Default | Description | -| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| commentStyle | `NONE` | Make comments italic **(Options:** `NONE` or `italic`) | -| keywordStyle | `NONE` | Make keywords italic **(Options:** `NONE` or `italic`) | -| functionStyle | `NONE` | Make functions italic **(Options:** `NONE` or `italic`) | -| variableStyle | `NONE` | Make variables and identifiers italic **(Options:** `NONE` or `italic`) | -| transparent | `false` | Enable this to disable setting the background color | -| hideInactiveStatusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. | -| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` | -| darkSidebar | `true` | Sidebar like windows like `NvimTree` get a darker background | -| darkFloat | `true` | Float windows like the lsp diagnostics windows get a darker background. | -| colors | `{}` | You can override specific color groups to use other groups or a hex color | +| Option | Default | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| commentStyle | `italic` | Highlight style for comments (check `:help highlight-args` for options) | +| keywordStyle | `italic` | Highlight style for keywords (check `:help highlight-args` for options) | +| functionStyle | `NONE` | Highlight style for functions (check `:help highlight-args` for options) | +| variableStyle | `NONE` | Highlight style for variables and identifiers (check `:help highlight-args` for options) | +| transparent | `false` | Enable this to disable setting the background color | +| hideInactiveStatusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. | +| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` | +| darkSidebar | `true` | Sidebar like windows like `NvimTree` get a darker background | +| darkFloat | `true` | Float windows like the lsp diagnostics windows get a darker background. | +| colors | `{}` | You can override specific color groups to use other groups or a hex color | ```lua -- Example config in Lua @@ -191,10 +193,10 @@ require("onedark").setup({ ```lua require("onedark").setup({ - commentStyle = "Italic", - keywordStyle = "Italic", - functionStyle = "Italic", - variableStyle = "Italic" + commentStyle = "italic", + keywordStyle = "italic", + functionStyle = "italic", + variableStyle = "italic" -- ... your onedark config }) ``` From f2bce678894de4a5191015b77f865c64d87464c5 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 20 Jun 2021 19:03:07 +0530 Subject: [PATCH 9/9] =?UTF-8?q?=E2=9C=8D=EF=B8=8F=20Changelogs=20&=20Minim?= =?UTF-8?q?al=20config=20example?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 17 +++++++++++------ Makefile | 2 +- README.md | 38 ++++++++++++++++++++++++++++---------- 3 files changed, 40 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b62492..e0a23a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,16 +9,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- `Linting` Github Action init -- `Makefile, .lua-format, .luacheckrc` init -- format .lua code with (lua-format)[https://github.com/Koihik/LuaFormatter] -- `kitty` tabs color changed -- onedark setting using `reqiure("onedark.config")` [monsonjeremy/onedark.nvim#5] +- **Warning** on `vim.g` configuration +- Configure plugin in lua using `require('onedark').setup({})` **[fix monsonjeremy/onedark.nvim#5]** +- Minimal config example added inside [README.md#minimal](./README.md#minimal) +- Linting Github Action init +- Format .lua code with [lua-format](https://github.com/Koihik/LuaFormatter) +- **kitty tab** colors are changed +- Init: `Makefile, .lua-format, .luacheckrc` ### Changed +- Removed function `require('onedark').colorscheme()` +- Colorscheme **autoload removed** from `colors/onedark.vim` - **VertSplit** & **Inactive StatusLine** `fg` color changed to `bg_visual` -- configuration docs updated inside README.md +- StatusLine bug note inside [README.md#usage](./README.md#-usage) +- Configuration docs updated inside [README.md#configuration](./README.md#-configuration) ## [v0.0.1] - 14 June 2021 diff --git a/Makefile b/Makefile index ee9b057..c2a192a 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,6 @@ format: @for file in `find . -name '*.lua'`;do lua-format $$file -i; done; lint: $(onedark_path) - @luacheck $(onedark_path) --config .luacheckrc + @luacheck $(onedark_path) check: format lint diff --git a/README.md b/README.md index 7d75dac..44271ac 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ +
-
+
+
+ Atom's iconic One Dark theme for Neovim, written in Lua
- Atom's iconic One Dark theme for Neovim, written in Lua -
- -
- De-attach fork of monsonjeremy/onedark.nvim
+
+
+ 
+
+### Minimal
+
+```lua
+require("onedark").setup({
+ hideInactiveStatusline = true,
+ darkSidebar = false,
+ darkFloat = false
+ -- ... your onedark config
+})
+```
+
+
+ 
+
@@ -218,8 +239,6 @@ require("onedark").setup({
- [Wallpaper](https://hdqwalls.com/big-sur-4k-wallpaper)
- [dotfiles](https://github.com/ful1e5/dotfiles)
-
-
## Support
@@ -231,7 +250,6 @@ require("onedark").setup({
Follow me on **[Twitter](https://twitter.com/ful1e5)**
-
(◣_◢)