README.md

Arshamiser

Neovim status bar, colour scheme, and foldtext function.

1. Demo
2. Requirements
3. Installation
   • Config
   • Lazy Loading
4. License

Demo

Requirements

This library supports Neovim 0.7.0.

This plugin depends are the following libraries. Please make sure to add them as dependencies in your package manager:

• arshlib.nvim
• feline.nvim
• heirline.nvim
• nvim-web-devicons
• fidget.nvim
• sqls.nvim

Installation

Use your favourite package manager to install this library. Packer example:

use({
  "arsham/arshamiser.nvim",
  requires = {
    "arsham/arshlib.nvim",
    "famiu/feline.nvim",
    "rebelot/heirline.nvim",
    "kyazdani42/nvim-web-devicons",
    "j-hui/fidget.nvim",
  },
  config = function()
    -- ignore any parts you don't want to use
    vim.api.nvim_command("colorscheme arshamiser_light")
    require("arshamiser.feliniser")
    -- or:
    -- require("arshamiser.heirliniser")
    _G.custom_foldtext = require("arshamiser.folding").foldtext
    vim.opt.foldtext = "v:lua.custom_foldtext()"
  end,
})

Config

By default this pluging uses a palette for the colour scheme. You can use your own palette if you want:

local colouriser = require("arshamiser.colouriser")
local palette = {} -- see the palette.lua for the values
colouriser.setup(palette, "my_awesome_scheme")

Lazy Loading

You can defer setting the colorscheme until the UI loads. Packer example:

use({
  "arsham/arshamiser.nvim",
  requires = {
    "arsham/arshlib.nvim",
    "famiu/feline.nvim",
    "rebelot/heirline.nvim",
    "kyazdani42/nvim-web-devicons",
    "j-hui/fidget.nvim",
    "nanotee/sqls.nvim",
  },
  config = function()
    require("arshlib.quick").autocmd({ events = "UIEnter", pattern = "*",
      callback = function()
        vim.api.nvim_command("colorscheme arshamiser_light")
        require("arshamiser.feliniser")
        -- or:
        -- require("arshamiser.heirliniser")
        _G.custom_foldtext = require("arshamiser.folding").foldtext
        vim.opt.foldtext = "v:lua.custom_foldtext()"
      end,
    })
  end,
})

License

Licensed under the MIT License. Check the LICENSE file for details.