Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/miversen33/sunglasses.nvim

Put on your shades so you only see what you care about
https://github.com/miversen33/sunglasses.nvim

Last synced: about 2 months ago
JSON representation

Put on your shades so you only see what you care about

Host: GitHub
URL: https://github.com/miversen33/sunglasses.nvim
Owner: miversen33
License: gpl-3.0
Created: 2023-10-14T03:38:28.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-02-19T14:53:03.000Z (4 months ago)
Last Synced: 2024-02-19T16:14:27.179Z (4 months ago)
Language: Lua
Size: 85.9 KB
Stars: 76
Watchers: 2
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-neovim - miversen33/sunglasses.nvim - Dynamic Colorscheme/highlight adjuster on window switching. (Color / PHP)
awesome-neovim - miversen33/sunglasses.nvim - Dynamic Colorscheme/highlight adjuster on window switching. (Color / Markdown and LaTeX)
awesome-neovim - miversen33/sunglasses.nvim - Dynamic Colorscheme/highlight adjuster on window switching. (Color / Markdown and LaTeX)

README

# sunglasses.nvim

Put on your shades so you only see what you care about

## Installation

### Lazy

```lua
require("lazy").setup({"miversen33/sunglasses.nvim", config = true})
```

#### Super Lazy
If you want, you can lazy load sunglasses, tied to the UIEnter event.
By default though, sunglasses already does most of its "work" after this
event fires so you aren't really gaining much by lazy loading sunglasses.

But I am not here to stop you from getting every last millisecond shaved
off your startup time so here ya go

```lua
require("lazy").setup({"miversen33/sunglasses.nvim", config = true, event = "UIEnter"})
```

## Pictures
Feel to submit a pr to add more images to this. At least until I get tired of updating it

Pictures are worth a thousand words (or however many are in your buffers ;) )

**Vscode.nvim**
[Theme](https://github.com/Mofiqul/vscode.nvim)
[Dotfiles](https://github.com/miversen33/miversen-dotfiles/blob/713b446f5665dd471f76da5fa28a726d1315dbf8/editors/nvim/lua/plugins/ui/)

### Shaded
![vscode.nvim shaded](https://github.com/miversen33/sunglasses.nvim/assets/2640668/4f77977e-6d01-4d18-9525-cee012fb69fa)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "SHADE",
filter_percent = .65
}
```

### Tinted
![vscode.nvim tinted](https://github.com/miversen33/sunglasses.nvim/assets/2640668/35c7948e-d163-490a-a063-887ba7674168)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "TINT",
filter_percent = .65
}
```

### NOSYNTAX
![vscode.nvim nosyntax](https://github.com/miversen33/sunglasses.nvim/assets/2640668/61aec001-eecd-4cda-a969-4708c7343e99)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "NOSYNTAX",
filter_percent = .65
}
```

**Catppuccin**
[Theme](https://github.com/catppuccin/nvim)

### Shaded
![catppuccin shaded](https://github.com/miversen33/sunglasses.nvim/assets/2640668/686f0745-d01e-4074-8ba7-fdf6873347bf)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "NOSYNTAX",
filter_percent = .65
}
```

### Tinted
![catppuccin tinted](https://github.com/miversen33/sunglasses.nvim/assets/2640668/df0ef0db-7068-4d10-bace-a6980f7624c0)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "TINT",
filter_percent = .65
}
```

### NOSYNTAX
![catppuccin nosyntax](https://github.com/miversen33/sunglasses.nvim/assets/2640668/c90754fc-75de-499b-8e65-118102b5250f)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "NOSYNTAX",
filter_percent = .65
}
```

**TokyoNight**
### Shaded
![tokyonight shaded](https://github.com/miversen33/sunglasses.nvim/assets/2640668/ac2a4be6-6af4-42d1-ba90-148e9420d508)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "SHADE",
filter_percent = .65
}
```

### Tinted
![tokyonight tinted](https://github.com/miversen33/sunglasses.nvim/assets/2640668/24c286eb-19f6-488f-a65b-1d0e06d5cfe2)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "TINT",
filter_percent = .65
}
```

### NOSYNTAX
![tokyonight nosyntax](https://github.com/miversen33/sunglasses.nvim/assets/2640668/f0ea28ae-4474-417d-9ecc-06d5749a163a)
```lua
-- Config: https://github.com/miversen33
{
filter_type = "NOSYNTAX",
filter_percent = .65
}
```

## Features

- Able to be used with **any** neovim _or_ vim theme
- Works with Sessions
- Works with Transparent buffers
- Easy to Setup
- Easy to Customize
- No external dependencies
- _Only a minimal amount of shenanigans happening!_

## Requirements

- Currently only supports neovim 0.9 newer

## Configuration

Sunglasses has sane defaults (as shown below) and therefore doesn't require configuration to get started. However, if you would like below is the list of defaults and changes that can be applied to them

```lua
-- lua
local sunglasses_defaults = {
filter_percent = 0.65,
filter_type = "SHADE",
log_level = "ERROR",
refresh_timer = 5,
excluded_filetypes = {
"dashboard",
"lspsagafinder",
"packer",
"checkhealth",
"mason",
"NvimTree",
"neo-tree",
"plugin",
"lazy",
"TelescopePrompt",
"alpha",
"toggleterm",
"sagafinder",
"better_term",
"fugitiveblame",
"starter",
"NeogitPopup",
"NeogitStatus",
"DiffviewFiles",
"DiffviewFileHistory",
"DressingInput",
"spectre_panel",
"zsh",
"registers",
"startuptime",
"OverseerList",
"Navbuddy",
"noice",
"notify",
"saga_codeaction",
"sagarename"
},
excluded_highlights = {
"WinSeparator",
{"lualine_.*", glob = true},
}
}

-- The above table will is the default configuration.
-- If you do not wish to set any configuration options, you can simply
-- pass nil into your setup
require("sunglasses").setup()
-- Or you can provide your own values. Please configure your
-- options by looking at each option available and setting it
require("sunglasses").setup({
filter_percent = 0.65,
filter_type = "SHADE",
log_level = "ERROR",
refresh_timer = 5,
excluded_filetypes = {
"dashboard",
"lspsagafinder",
"packer",
"checkhealth",
"mason",
"NvimTree",
"neo-tree",
"plugin",
"lazy",
"TelescopePrompt",
"alpha",
"toggleterm",
"sagafinder",
"better_term",
"fugitiveblame",
"starter",
"NeogitPopup",
"NeogitStatus",
"DiffviewFiles",
"DiffviewFileHistory",
"DressingInput",
"spectre_panel",
"zsh",
"registers",
"startuptime",
"OverseerList",
"Navbuddy",
"noice",
"notify",
"saga_codeaction",
"sagarename"
},
excluded_highlights = {
"WinSeparator",
{"lualine_.*", glob = true},
}
})
```

### Config.filter_percent
Version Added: 0.1
Default: .65

This is the percentage to modify inactive buffer's highlights. This value must
be between 0 and 1 and is clamped as such. An example of how to use this is
as follows

```lua
-- lua
local sunglasses_options = {
filter_percent = 0.65
}

require("sunglasses").setup(sunglasses_options)
```

### Config.filter_type
Version Added: 0.1
Version Updated: 0.2.01
Default: "SHADE"

This is the kind of filter to apply to inactive buffers. Valid filter_types
are
- "SHADE"
- "TINT"
- "NOSYNTAX"

#### SHADE
Darkens the inactive buffer's highlights

#### TINT
Brightens the inactive buffers highlights

#### NOSYNTAX
Disables syntax highlighting on the inactive buffer.

An example of how to use this is as follows

```lua
-- lua
local sunglasses_options = {
filter_type = "SHADE"
}

require("sunglasses").setup(sunglasses_options)
```

### Config.log_level
Version Added: 0.1
Default: "ERROR"

This is the level to filter all logs against. This means that logs with a
level under "ERROR" will not be written to the file. If you are looking to
submit a bug report, please set this to a lower level.

Your sunglasses log can be located with the following command
```lua
-- lua
print(vim.fn.stdpath('log') .. '/sunglasses.log')
```

Below are a list of valid log levels (in filter order). Anything lower than the
level in this list will be filtered at that level. As an example, with a level
of "ERROR" (the default), logs of level "WARNING" will be filtered

- "CRITICAL"
- "ERROR"
- "WARNING"
- "INFO"
- "DEBUG"
- "TRACE"
- "TRACE2"
- "TRACE3"

**** Be aware, any of the trace levels will very quickly produce lots of logs

An example of how to set this is as follows
```lua
-- lua
local sunglasses_options = {
filter_level = "ERROR"
}
require("sunglasses").setup(sunglasses_options)
```

### Config.refresh_timer
Version Added: 0.1
Default: 5

This tells sunglasses how often (in seconds) to refresh its internal
highlights cache. This is how sunglasses is able to deal with highlight groups
that are dynamically created over time.

An example of how to set this is as follows
```lua
-- lua
local sunglasses_options = {
refresh_timer = 5
}
require("sunglasses").setup(refresh_timer)
```

### Config.excluded_filetypes
Version Added: 0.1
Default:
```lua
-- lua
{
"dashboard",
"lspsagafinder",
"packer",
"checkhealth",
"mason",
"NvimTree",
"neo-tree",
"plugin",
"lazy",
"TelescopePrompt",
"alpha",
"toggleterm",
"sagafinder",
"better_term",
"fugitiveblame",
"starter",
"NeogitPopup",
"NeogitStatus",
"DiffviewFiles",
"DiffviewFileHistory",
"DressingInput",
"spectre_panel",
"zsh",
"registers",
"startuptime",
"OverseerList",
"Navbuddy",
"noice",
"notify",
"saga_codeaction",
"sagarename"
}
```

This is a list of filetypes to be excluded when shading inactive windows.

**If you are making changes to this table, consider submitting a PR to**
**update it for everyone instead!**

An example of how to set this is as follows

```lua
-- lua
local sunglasses_options = {
excluded_filetypes = {
"lazy"
}
}
require("sunglasses").setup(sunglasses_options)
```

### Config.excluded_highlights
Version Added: 0.1
Default:
```lua
-- lua
{
"WinSeparator",
{"lualine_.*", glob = true},
}
```

This is a list of highlights to exclude modifying on inactive windows.

**If you are making changes to this table, consider submitting a PR to**
**update it for everyone instead!**

Entries in this table can be either a string or a table (as shown above).
If its a string, it is treated as the exact name of the highlight to exclude.
If it is in table form (and has the `glob = true` value in the table), then
it is treated as a glob in which all highlights that *match* the glob are
excluded.

You may be wondering why lualine is included here. It seems that vim will
apply the namespace highlight to lualine in the event that all other windows
in the tabpage are already in that namespace. That makes lualine look super
weird, so this fixes that.

An example of how to set this is as follows
```lua
-- lua
local sunglasses_options = {
excluded_highlights = {
"WinSeparator"
}
}
require("sunglasses").setup(sunglasses_options)
```

## Commands

### :SunglassesOn
Version Added: 0.1
Valid Args: false, true
Related: [SunglassesOff](#sunglassesoff),[SunglassesToggle](#sunglassestoggle)

Command SunglassesOn will shade the buffer your cursor is currently in.

If true is passed with the command, this will force shade the buffer.
This means that if the filetype of the buffer is marked as excluded, the buffer
will still be shaded. This force is only temporary however. In general this
means that if a window contains an excluded filetype and you force shade it,
the shade will only last until the next time sunglasses attempts to shade the
buffer, in which case it will not be shaded.

### :SunglassesOff
Version Added: 0.1
Related: [SunglassesOn](#sunglasseson),[SunglassesToggle](#sunglassestoggle)

Command SunglassesOff will unshade the buffer your cursor is currently in.

### :SunglassesToggle
Version Added: 0.3
Related: [SunglassesOff](#sunglassesoff),[SunglassesOn](#sunglasseson)

Command SunglassesToggle will toggle sunglasses on the currently focused window

### :SunglassesEnable
Version Added: 0.1
Related: [SunglassesDisable](#sunglassesdisable)

Command SunglassesEnable will shade all inactive buffers (while obeying
excluded filetypes)

### :SunglassesEnableToggle
Version Added: 0.4
Related: [SunglassesToggle](#sunglassestoggle),[SunglassesEnable](#sunglassesenable),[SunglassesDisable](#sunglassesdisable)

Command SunglassesEnableToggle will actively toggle sunglasses across _all_ windows (while still obeying filetypes). This is a shortcut (with a bit of logic) to [SunglassesEnable](#sunglassesenable) and [SunglassesDisable](#sunglassesdisable)

### :SunglassesDisable
Version Added: 0.1
Related: [SunglassesEnable](#sunglassesenable)

Command SunglassesDisable will unshade all buffers

### :SunglassesRefresh
Version Added: 0.1
Related: [Config.refresh_timer](#configrefreshtimer)

Command to manually refresh the highlight groups modified by sunglasses.
Note, sunglasses by default refreshes its highlights based on
[Config.refresh_timer](#configrefreshtimer)

### :SunglassesPause
Version Added: 0.2
Related: [SunglassesResume](#sunglassesresume) [SunglassesDisable](#sunglassesdisable) [SunglassesOff](#sunglassesoff)

Command to manually exclude the window under the cursor from Sunglasses Auto
Adjuster. This does _not_ persist through sessions

### :SunglassesResume
Version Added: 0.2
Related: [SunglassesPause](#sunglassespause) [SunglassesEnable](#sunglassesenable) [SunglassesOn](#sunglasseson)

Command to manually unexclude (note, not the same as "include") the window
under the cursor, allowing Sunglasses Auto Adjuster to continue adjusting it
on window leave.

Why is unexclude not the same as include? Well include would suggest that the
window under the cursor will now be shaded on window leave, which is not the
case. For that, you will need [SunglassesOn](#sunglasseson). This simply undoes the pause set
by [SunglassesPause](#sunglassespause)

## Related Plugins
- [Shade.nvim](https://github.com/sunjon/Shade.nvim)
- [tint.nvim](https://github.com/levouh/tint.nvim)
- [catppuccin/nvim](https://github.com/catppuccin/nvim)