Merge pull request #12 from doubleloop/customization

Allow for customization

Author: tanvirtin

README.md

@@ -30,14 +30,81 @@ In VimL:
 ```viml
 syntax on
 colorscheme monokai
-set termguicolors
+colorscheme monokai_pro
+colorscheme monokai_soda
 ```
 
 In Lua:
 
 ```lua
-require('monokai')
-vim.cmd('colorscheme monokai')
+require('monokai').setup {}
+require('monokai').setup { palette = require('monokai').pro }
+require('monokai').setup { palette = require('monokai').soda }
+```
+
+## Customization
+
+It is possible to customize Monokai theme with `setup` function (only in Lua). Passed argument will override default configuration values witch are:
+
+```lua
+{
+    palette = {
+        name = 'monokai',
+        base1 = '#272a30',
+        base2 = '#26292C',
+        base3 = '#2E323C',
+        base4 = '#333842',
+        base5 = '#4d5154',
+        base6 = '#9ca0a4',
+        base7 = '#b1b1b1',
+        border = '#a1b5b1',
+        brown = '#504945',
+        white = '#f8f8f0',
+        grey = '#8F908A',
+        black = '#000000',
+        pink = '#f92672',
+        green = '#a6e22e',
+        aqua = '#66d9ef',
+        yellow = '#e6db74',
+        orange = '#fd971f',
+        purple = '#ae81ff',
+        red = '#e95678',
+        diff_add = '#3d5213',
+        diff_remove = '#4a0f23',
+        diff_change = '#27406b',
+        diff_text = '#23324d',
+    },
+    custom_hlgroups = {},
+}
+```
+
+An example of this would be as follows:
+
+```lua
+local monokai = require('monokai')
+local palette = monokai.classic
+monokai.setup {
+    palette = {
+        diff_text = '#133337',
+    },
+    custom_hlgroups = {
+        TSInclude = {
+            fg = palette.aqua,
+        },
+        GitSignsAdd = {
+            fg = palette.green,
+            bg = palette.base2
+        },
+        GitSignsDelete = {
+            fg = palette.pink,
+            bg = palette.base2
+        },
+        GitSignsChange = {
+            fg = palette.orange,
+            bg = palette.base2
+        },
+    }
+}
 ```
 
 ## Extras

colors/monokai_pro.vim

@@ -1 +1 @@
-lua require('monokai').setup(require('monokai').pro)
+lua require('monokai').setup { palette = require('monokai').pro }

colors/monokai_soda.vim

@@ -1 +1 @@
-lua require('monokai').setup(require('monokai').soda)
+lua require('monokai').setup { palette = require('monokai').soda }

lua/monokai.lua

@@ -591,22 +591,31 @@ M.load_plugin_syntax = function(palette)
     }
 end
 
-M.setup = function(palette)
-    vim.cmd('hi clear')
-    if vim.fn.exists('syntax_on') then
-        vim.cmd('syntax reset')
+local default_config = {
+    palette = M.classic,
+    custom_hlgroups = {},
+}
+
+M.setup = function(config)
+    vim.cmd 'hi clear'
+    if vim.fn.exists 'syntax_on' then
+        vim.cmd 'syntax reset'
     end
     vim.o.background = 'dark'
     vim.o.termguicolors = true
-    local used_palette = palette or M.classic
+    config = config or {}
+    config = vim.tbl_deep_extend('keep', config, default_config)
+    local used_palette = config.palette or M.classic
     vim.g.colors_name = used_palette.name
     local syntax = M.load_syntax(used_palette)
+    syntax = vim.tbl_deep_extend('keep', config.custom_hlgroups, syntax)
     for group, colors in pairs(syntax) do
         M.highlight(group, colors)
     end
     local async_load_plugin = nil
     async_load_plugin = vim.loop.new_async(vim.schedule_wrap(function()
         local plugin_syntax = M.load_plugin_syntax(used_palette)
+        plugin_syntax = vim.tbl_deep_extend('keep', config.custom_hlgroups, plugin_syntax)
         for group, colors in pairs(plugin_syntax) do
             M.highlight(group, colors)
         end