Archives
/
nvim-libmodal
mirror of https://github.com/Iron-E/nvim-libmodal
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(README): use spaces instead of tabs

Browse Source
pull/20/head
Iron-E 1 year ago
parent 63c5604bfa
commit f9f9308d8d
No known key found for this signature in database
GPG Key ID: 83A6AEB40395D40D
1 changed files with 93 additions and 95 deletions
Show Stats Download Patch File Download Diff File

188
README.md
Unescape Escape View File

@ -21,11 +21,9 @@ Either use `packadd` or any package manager. I recommend using [lazy.nvim](https
#### packer.nvim #### packer.nvim
You can use [packer.nvim](https://github.com/wbthomason/packer.nvim) to install this plugin. The below example is for `packer.nvim`:
```lua ```lua
return require('packer').startup {function(use) return require('packer').startup {function(use)
use 'Iron-E/nvim-libmodal' use 'Iron-E/nvim-libmodal'
end} end}
``` ```
@ -150,8 +148,8 @@ require('heirline').setup({statusline =
#### lualine.nvim #### lualine.nvim
<details> <details>
<summary>An example config</summary> <summary>An example config</summary>
<pre lang = "lua"> <pre lang = "lua">
-- Defined in https://github.com/Iron-E/nvim-highlite -- Defined in https://github.com/Iron-E/nvim-highlite
local BLUE = '#7766ff' local BLUE = '#7766ff'
local CYAN = '#33dbc3' local CYAN = '#33dbc3'
@ -174,31 +172,31 @@ local YELLOW = '#f0df33'
   
local MODES = local MODES =
{ -- {{{ { -- {{{
['c'] = {'COMMAND-LINE', RED}, ['c'] = {'COMMAND-LINE', RED},
['ce'] = {'NORMAL EX', RED_DARK}, ['ce'] = {'NORMAL EX', RED_DARK},
['cv'] = {'EX', RED_LIGHT}, ['cv'] = {'EX', RED_LIGHT},
['i'] = {'INSERT', GREEN}, ['i'] = {'INSERT', GREEN},
['ic'] = {'INS-COMPLETE', GREEN_LIGHT}, ['ic'] = {'INS-COMPLETE', GREEN_LIGHT},
['n'] = {'NORMAL', PURPLE_LIGHT}, ['n'] = {'NORMAL', PURPLE_LIGHT},
['no'] = {'OPERATOR-PENDING', PURPLE}, ['no'] = {'OPERATOR-PENDING', PURPLE},
['r'] = {'HIT-ENTER', CYAN}, ['r'] = {'HIT-ENTER', CYAN},
['r?'] = {':CONFIRM', CYAN}, ['r?'] = {':CONFIRM', CYAN},
['rm'] = {'--MORE', ICE}, ['rm'] = {'--MORE', ICE},
['R'] = {'REPLACE', PINK}, ['R'] = {'REPLACE', PINK},
['Rv'] = {'VIRTUAL', PINK_LIGHT}, ['Rv'] = {'VIRTUAL', PINK_LIGHT},
['s'] = {'SELECT', TURQOISE}, ['s'] = {'SELECT', TURQOISE},
['S'] = {'SELECT', TURQOISE}, ['S'] = {'SELECT', TURQOISE},
['␓'] = {'SELECT', TURQOISE}, ['␓'] = {'SELECT', TURQOISE},
['t'] = {'TERMINAL', ORANGE}, ['t'] = {'TERMINAL', ORANGE},
['v'] = {'VISUAL', BLUE}, ['v'] = {'VISUAL', BLUE},
['V'] = {'VISUAL LINE', BLUE}, ['V'] = {'VISUAL LINE', BLUE},
['␖'] = {'VISUAL BLOCK', BLUE}, ['␖'] = {'VISUAL BLOCK', BLUE},
['!'] = {'SHELL', YELLOW}, ['!'] = {'SHELL', YELLOW},
   
-- libmodal -- libmodal
['BUFFERS'] = TEAL, ['BUFFERS'] = TEAL,
['TABLES'] = ORANGE_LIGHT, ['TABLES'] = ORANGE_LIGHT,
['TABS'] = TAN, ['TABS'] = TAN,
} -- }}} } -- }}}
   
local MODE_HL_GROUP = 'LualineViMode' local MODE_HL_GROUP = 'LualineViMode'
@ -206,39 +204,39 @@ local MODE_HL_GROUP = 'LualineViMode'
--[[/* FELINE CONFIG */]] --[[/* FELINE CONFIG */]]
   
vim.api.nvim_create_autocmd('ModeChanged', {callback = function() vim.api.nvim_create_autocmd('ModeChanged', {callback = function()
require('lualine').refresh {scope = 'window', place = {'statusline'}} require('lualine').refresh {scope = 'window', place = {'statusline'}}
end}) end})
   
require('lualine').setup {sections = {lualine_a = {{ require('lualine').setup {sections = {lualine_a = {{
function() -- auto change color according the vim mode function() -- auto change color according the vim mode
local mode_color, mode_name local mode_color, mode_name
   
if vim.g.libmodalActiveModeName then if vim.g.libmodalActiveModeName then
mode_name = vim.g.libmodalActiveModeName mode_name = vim.g.libmodalActiveModeName
mode_color = MODES[mode_name] mode_color = MODES[mode_name]
else else
local current_mode = MODES[vim.api.nvim_get_mode().mode] local current_mode = MODES[vim.api.nvim_get_mode().mode]
   
mode_name = current_mode[1] mode_name = current_mode[1]
mode_color = current_mode[2] mode_color = current_mode[2]
end end
   
vim.api.nvim_set_hl(0, MODE_HL_GROUP, {fg = mode_color, bold = true}) vim.api.nvim_set_hl(0, MODE_HL_GROUP, {fg = mode_color, bold = true})
   
return mode_name..' ' return mode_name..' '
end, end,
icon = {'▊', align = 'left'}, icon = {'▊', align = 'left'},
color = MODE_HL_GROUP, color = MODE_HL_GROUP,
padding = 0, padding = 0,
}}}} }}}}
</pre> </pre>
</details> </details>
#### staline.nvim #### staline.nvim
<details> <details>
<summary>An example config</summary> <summary>An example config</summary>
<pre lang = "lua"> <pre lang = "lua">
--[[/* CONSTANTS */]] --[[/* CONSTANTS */]]
   
-- Defined in https://github.com/Iron-E/nvim-highlite -- Defined in https://github.com/Iron-E/nvim-highlite
@ -263,31 +261,31 @@ local YELLOW = '#f0df33'
   
local MODES = local MODES =
{ -- {{{ { -- {{{
['c'] = {'COMMAND-LINE', RED}, ['c'] = {'COMMAND-LINE', RED},
['ce'] = {'NORMAL EX', RED_DARK}, ['ce'] = {'NORMAL EX', RED_DARK},
['cv'] = {'EX', RED_LIGHT}, ['cv'] = {'EX', RED_LIGHT},
['i'] = {'INSERT', GREEN}, ['i'] = {'INSERT', GREEN},
['ic'] = {'INS-COMPLETE', GREEN_LIGHT}, ['ic'] = {'INS-COMPLETE', GREEN_LIGHT},
['n'] = {'NORMAL', PURPLE_LIGHT}, ['n'] = {'NORMAL', PURPLE_LIGHT},
['no'] = {'OPERATOR-PENDING', PURPLE}, ['no'] = {'OPERATOR-PENDING', PURPLE},
['r'] = {'HIT-ENTER', CYAN}, ['r'] = {'HIT-ENTER', CYAN},
['r?'] = {':CONFIRM', CYAN}, ['r?'] = {':CONFIRM', CYAN},
['rm'] = {'--MORE', ICE}, ['rm'] = {'--MORE', ICE},
['R'] = {'REPLACE', PINK}, ['R'] = {'REPLACE', PINK},
['Rv'] = {'VIRTUAL', PINK_LIGHT}, ['Rv'] = {'VIRTUAL', PINK_LIGHT},
['s'] = {'SELECT', TURQOISE}, ['s'] = {'SELECT', TURQOISE},
['S'] = {'SELECT', TURQOISE}, ['S'] = {'SELECT', TURQOISE},
['␓'] = {'SELECT', TURQOISE}, ['␓'] = {'SELECT', TURQOISE},
['t'] = {'TERMINAL', ORANGE}, ['t'] = {'TERMINAL', ORANGE},
['v'] = {'VISUAL', BLUE}, ['v'] = {'VISUAL', BLUE},
['V'] = {'VISUAL LINE', BLUE}, ['V'] = {'VISUAL LINE', BLUE},
['␖'] = {'VISUAL BLOCK', BLUE}, ['␖'] = {'VISUAL BLOCK', BLUE},
['!'] = {'SHELL', YELLOW}, ['!'] = {'SHELL', YELLOW},
   
-- libmodal -- libmodal
['BUFFERS'] = TEAL, ['BUFFERS'] = TEAL,
['TABLES'] = ORANGE_LIGHT, ['TABLES'] = ORANGE_LIGHT,
['TABS'] = TAN, ['TABS'] = TAN,
} -- }}} } -- }}}
   
local MODE_HL_GROUP = 'StalineViMode' local MODE_HL_GROUP = 'StalineViMode'
@ -297,29 +295,29 @@ local MODE_HL_GROUP = 'StalineViMode'
vim.api.nvim_set_hl(0, MODE_HL_GROUP, {}) vim.api.nvim_set_hl(0, MODE_HL_GROUP, {})
require('staline').setup( require('staline').setup(
{ {
mode_colors = {}, mode_colors = {},
mode_icons = {}, mode_icons = {},
sections = {left = sections = {left =
{ {
function() function()
local mode_color, mode_name local mode_color, mode_name
   
if vim.g.libmodalActiveModeName then if vim.g.libmodalActiveModeName then
mode_name = vim.g.libmodalActiveModeName mode_name = vim.g.libmodalActiveModeName
mode_color = MODES[mode_name] mode_color = MODES[mode_name]
else else
local current_mode = MODES[vim.api.nvim_get_mode().mode] local current_mode = MODES[vim.api.nvim_get_mode().mode]
   
mode_name = current_mode[1] mode_name = current_mode[1]
mode_color = current_mode[2] mode_color = current_mode[2]
end end
   
vim.api.nvim_set_hl(0, MODE_HL_GROUP, {bold = true, fg = mode_color}) vim.api.nvim_set_hl(0, MODE_HL_GROUP, {bold = true, fg = mode_color})
return {MODE_HL_GROUP, mode_name} return {MODE_HL_GROUP, mode_name}
end, end,
}}, }},
}) })
</pre> </pre>
</details> </details>
## FAQ ## FAQ
@ -329,11 +327,11 @@ require('staline').setup(
The following is a list of expressions that work in `nvim-libmodal` but not `vim-libmodal`: The following is a list of expressions that work in `nvim-libmodal` but not `vim-libmodal`:
* `require 'libmodal'` in Lua. * `require 'libmodal'` in Lua.
* `vim-libmodal` does not support interacting with it through Lua, you must use the Vimscript interface. * `vim-libmodal` does not support interacting with it through Lua, you must use the Vimscript interface.
The following is a list of expressions that work in `vim-libmodal` but not `nvim-libmodal`: The following is a list of expressions that work in `vim-libmodal` but not `nvim-libmodal`:
* `call libmodal#Enter('FOO', funcref('bar'), baz)` in Vimscript. * `call libmodal#Enter('FOO', funcref('bar'), baz)` in Vimscript.
* Lua does not support passing `funcref`s from Vimscript. Try using the Lua interface instead. * Lua does not support passing `funcref`s from Vimscript. Try using the Lua interface instead.
* `call libmodal#Prompt('FOO', funcref('bar'), baz)` in Vimscript. * `call libmodal#Prompt('FOO', funcref('bar'), baz)` in Vimscript.
* Lua does not support passing `funcref`s from Vimscript. Try using the Lua interface instead. * Lua does not support passing `funcref`s from Vimscript. Try using the Lua interface instead.

Write Preview
Loading…
Cancel
Save