chore: add license statements and update benchmarks

This commit is contained in:
shadmansaleh 2021-09-20 17:46:38 +06:00
parent df1ac83a96
commit 9f556fdf37
19 changed files with 74 additions and 21 deletions

View File

@ -14,4 +14,6 @@ test:
docgen: docgen:
@bash ./scripts/docgen.sh @bash ./scripts/docgen.sh
precommit_check: docgen format test lint
check: lint test check: lint test

View File

@ -59,14 +59,19 @@ For those who want to break the norms. You can create custom looks in lualine.
Unlike other statusline plugins lualine loads only defined components, nothing else. Unlike other statusline plugins lualine loads only defined components, nothing else.
Startup time performance measured with an amazing plugin [tweekmonster/startuptime.vim](https://github.com/tweekmonster/startuptime.vim) Startup time performance measured with an amazing plugin [dstein64/vim-startuptime](https://github.com/dstein64/vim-startuptime)
All times are measured with only `startuptime.vim` and given statusline plugin installed All times are measured with clean `init.vim` with only `vim-startuptime`,
`vim-plug` and given statusline plugin installed.
In controle just `vim-startuptime` and`vim-plug` is installed.
And mesured time is complete startuptime of vim not time spent
on specific plugin.
| clean vimrc | lualine | lightline | airline | | control | lualine | lightline | airline |
| :------------: | :----------: | :----------: | :----------: | | :--------: | :-------: | :-------: | :-------: |
| 8.943 ms | 9.034 ms | 11.463 ms | 13.425 ms | | 8.943 ms | 10.140 ms | 12.522 ms | 38.850 ms |
Last Updated On: 20-09-2021
## Installation ## Installation
@ -76,7 +81,6 @@ All times are measured with only `startuptime.vim` and given statusline plugin i
Plug 'hoob3rt/lualine.nvim' Plug 'hoob3rt/lualine.nvim'
" If you want to have icons in your statusline choose one of these " If you want to have icons in your statusline choose one of these
Plug 'kyazdani42/nvim-web-devicons' Plug 'kyazdani42/nvim-web-devicons'
Plug 'ryanoasis/vim-devicons'
``` ```
### [packer.nvim](https://github.com/wbthomason/packer.nvim) ### [packer.nvim](https://github.com/wbthomason/packer.nvim)
@ -88,6 +92,8 @@ use {
} }
``` ```
You'll also have need to have a patched font if you want icons.
## Usage and customization ## Usage and customization
Lualine has sections as shown below. Lualine has sections as shown below.

View File

@ -32,15 +32,19 @@ Unlike other statusline plugins lualine loads only defined components, nothing
else. else.
Startup time performance measured with an amazing plugin Startup time performance measured with an amazing plugin
tweekmonster/startuptime.vim <https://github.com/tweekmonster/startuptime.vim> dstein64/vim-startuptime <https://github.com/dstein64/vim-startuptime>
All times are measured with only `startuptime.vim` and given statusline plugin All times are measured with clean `init.vim` with only `vim-startuptime`,
installed `vim-plug` and given statusline plugin installed. In controle just
`vim-startuptime` and`vim-plug` is installed. And mesured time is complete
startuptime of vim not time spent on specific plugin.
│clean vimrc│lualine │lightline│ airline │ │control │ lualine │lightline│ airline │
8.943 ms │9.034 ms│11.463 ms│13.425 ms│ 8.943 ms│10.140 ms│12.522 ms│38.850 ms│
Last Updated On: 20-09-2021
INSTALLATION *lualine-installation* INSTALLATION *lualine-installation*
VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~ VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
@ -49,7 +53,6 @@ VIM-PLUG <HTTPS://GITHUB.COM/JUNEGUNN/VIM-PLUG> ~
Plug 'hoob3rt/lualine.nvim' Plug 'hoob3rt/lualine.nvim'
" If you want to have icons in your statusline choose one of these " If you want to have icons in your statusline choose one of these
Plug 'kyazdani42/nvim-web-devicons' Plug 'kyazdani42/nvim-web-devicons'
Plug 'ryanoasis/vim-devicons'
< <
@ -63,6 +66,8 @@ PACKER.NVIM <HTTPS://GITHUB.COM/WBTHOMASON/PACKER.NVIM> ~
< <
Youll also have need to have a patched font if you want icons.
USAGE AND CUSTOMIZATION *lualine-usage-and-customization* USAGE AND CUSTOMIZATION *lualine-usage-and-customization*
Lualine has sections as shown below. Lualine has sections as shown below.

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local EvalFuncComponent = require('lualine.component'):new() local EvalFuncComponent = require('lualine.component'):new()
EvalFuncComponent.update_status = function(self) EvalFuncComponent.update_status = function(self)

View File

@ -1,3 +1,5 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local FunctionComponent = require('lualine.component'):new() local FunctionComponent = require('lualine.component'):new()
FunctionComponent.update_status = function(self, is_focused) FunctionComponent.update_status = function(self, is_focused)

View File

@ -1,3 +1,5 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local VarComponent = require('lualine.component'):new() local VarComponent = require('lualine.component'):new()
VarComponent.update_status = function(self) VarComponent.update_status = function(self)
local component = self.options[1] local component = self.options[1]

View File

@ -1,3 +1,5 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local utils = require 'lualine.utils.utils' local utils = require 'lualine.utils.utils'
local loader = require 'lualine.utils.loader' local loader = require 'lualine.utils.loader'

View File

@ -1,3 +1,5 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
-- stylua: ignore -- stylua: ignore
local colors = { local colors = {
black = '#3c3836', black = '#3c3836',

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local lualine_require = require 'lualine_require' local lualine_require = require 'lualine_require'
local modules = lualine_require.lazy_require { local modules = lualine_require.lazy_require {
utils_notices = 'lualine.utils.notices', utils_notices = 'lualine.utils.notices',

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
-- Wrapper arround job api -- Wrapper arround job api
local Job = setmetatable({ local Job = setmetatable({
start = function(self) start = function(self)

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
-- To provide notices for user -- To provide notices for user
local M = {} local M = {}
local notices = {} local notices = {}

View File

@ -1,3 +1,5 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local M = {} local M = {}
M.sep = package.config:sub(1, 1) M.sep = package.config:sub(1, 1)

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local eq = assert.are.same local eq = assert.are.same
local M = {} local M = {}

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
-- load lualine and plenary -- load lualine and plenary
vim.api.nvim_exec( vim.api.nvim_exec(
[[ [[

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local helpers = require 'tests.helpers' local helpers = require 'tests.helpers'
local eq = assert.are.same local eq = assert.are.same

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local eq = assert.are.same local eq = assert.are.same
describe('config parsing', function() describe('config parsing', function()

View File

@ -1,3 +1,6 @@
-- Copyright (c) 2020-2021 shadmansaleh
-- MIT license, see LICENSE for more details.
local helpers = require 'tests.helpers' local helpers = require 'tests.helpers'
local eq = assert.are.same local eq = assert.are.same

View File

@ -1,3 +1,6 @@
# Copyright (c) 2020-2021 shadmansaleh
# MIT license, see LICENSE for more details.
PANVIMDOC_TAG_VERSION="v2.7.1" # panvimdoc version PANVIMDOC_TAG_VERSION="v2.7.1" # panvimdoc version
# panvimdocs metadata # panvimdocs metadata