[{"result":{"data":[{"id":"7f498d6d-310f-405d-a252-57a748aef11b","title":"refactor!: remove auto-centering behavior in favor of `:h splitkeep`","text":"refactor!: remove auto-centering behavior in favor of `:h splitkeep`\n\nUsers of Neovim <0.9 are recommended to use `stabilize.nvim`\nto achieve this behavior.","type":"breaking-change","createdAt":"2023-09-20T02:13:14.653Z","breakingChange":{"id":45,"postId":"7f498d6d-310f-405d-a252-57a748aef11b","pluginId":550,"externalUrl":"https://github.com/nvim-focus/focus.nvim/commit/6536030d2f65a47379faa4eb6a628196af7c5a1c","sha":"6536030d2f65a47379faa4eb6a628196af7c5a1c","plugin":{"id":550,"owner":"beauwilliams","name":"focus.nvim","type":"github","source":"awesome-neovim","category":"split-and-window","link":"https://github.com/beauwilliams/focus.nvim","shortDescription":"Auto-Focusing and Auto-Resizing Splits/Windows for Neovim written in Lua. A full suite of window management enhancements. Vim splits on steroids!","createdAt":"2023-03-22T19:35:21.671Z","readme":"# focus.nvim\n\n[![GitHub stars](https://img.shields.io/github/stars/nvim-focus/focus.nvim.svg?style=social&label=Star)](https://GitHub.com/nvim-focus/focus.nvim/stargazers/)\n[![Requires Neovim 0.7+](https://img.shields.io/badge/requires-nvim%200.7%2B-9cf?logo=neovim)](https://neovim.io/)\n[![GitHub contributors](https://img.shields.io/github/contributors/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/graphs/contributors/)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/)\n[![GitHub issues](https://img.shields.io/github/issues/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/issues/)\n[![GitHub issues-closed](https://img.shields.io/github/issues-closed/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/issues?q=is%3Aissue+is%3Aclosed)\n\nAlways have a nice view over your split windows\n\n## Preview\n\n![screencast](https://i.ibb.co/0tsKww4/focusop.gif)\n\n*Note*: For reference this screencast features dimensions set to 40 rows and 120\ncolumns.\n\n*See a visual demonstration of each focus feature\n[here](https://github.com/nvim-focus/focus.nvim/blob/master/DEMO.md)*.\n\n## Features\n\n* 👌 Resizes split windows automatically based on [golden ratio](https://en.wikipedia.org/wiki/Golden_ratio)\n* ⚙️ Enables cursorline/signcolumn/numbers on focus window only\n* 🙌 Window creation or switch by direction\n* 🖥 Equalise splits or maximise focused splits, and toggle between the two\n* 🔌 Option to open tmux windows instead of creating new splits\n\n## Installation\n\nHere are code snippets for some common installation methods (use only one):\n\n

With folke/lazy.nvim

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`{ 'nvim-focus/focus.nvim', version = false },`
'focus.nvim' library	Stable	`{ 'nvim-focus/focus.nvim', version = '*' },`

\n\n

With wbthomason/packer.nvim

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`use 'nvim-focus/focus.nvim'`
'focus.nvim' library	Stable	`use { 'nvim-focus/focus.nvim', branch = 'stable' }`

\n\n

With junegunn/vim-plug

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`Plug 'nvim-focus/focus.nvim'`
'focus.nvim' library	Stable	`Plug 'nvim-focus/focus.nvim', { 'branch': 'stable' }`

\n\n
\n\n## Configuration\n\nFor basic setup with all batteries included:\n\n```lua\nrequire(\"focus\").setup()\n```\n\nConfiguration can be passed to the setup function. Here is an example with the\ndefault settings:\n\n```lua\nrequire(\"focus\").setup({\n enable = true, -- Enable module\n commands = true, -- Create Focus commands\n autoresize = {\n enable = true, -- Enable or disable auto-resizing of splits\n width = 0, -- Force width for the focused window\n height = 0, -- Force height for the focused window\n minwidth = 0, -- Force minimum width for the unfocused window\n minheight = 0, -- Force minimum height for the unfocused window\n height_quickfix = 10, -- Set the height of quickfix panel\n },\n split = {\n bufnew = false, -- Create blank buffer for new split windows\n tmux = false, -- Create tmux splits instead of neovim splits\n },\n ui = {\n number = false, -- Display line numbers in the focussed window only\n relativenumber = false, -- Display relative line numbers in the focussed window only\n hybridnumber = false, -- Display hybrid line numbers in the focussed window only\n absolutenumber_unfocussed = false, -- Preserve absolute numbers in the unfocussed windows\n\n cursorline = true, -- Display a cursorline in the focussed window only\n cursorcolumn = false, -- Display cursorcolumn in the focussed window only\n colorcolumn = {\n enable = false, -- Display colorcolumn in the foccused window only\n list = '+1', -- Set the comma-saperated list for the colorcolumn\n },\n signcolumn = true, -- Display signcolumn in the focussed window only\n winhighlight = false, -- Auto highlighting for focussed/unfocussed windows\n }\n})\n```\n\n> **Note**\n> To manage window views when resizing, see `:h splitkeep`.
\n> For users of Neovim <= 0.8, it is recommended to use the\n> [stabilize](https://github.com/luukvbaal/stabilize.nvim) plugin.\n\n### Setup options\n\n**Enable/Disable Focus**\n```lua\n-- Completely disable this plugin\n-- Default: true\nrequire(\"focus\").setup({enable = false})\n```\n\n**Enable/Disable Focus Commands**\n```lua\n-- This not export :Focus* commands\n-- Default: true\nrequire(\"focus\").setup({commands = false})\n```\n\n**Enable/Disable Focus Window Autoresizing**\n```lua\n--The focussed window will no longer automatically resize. Other focus features are still available\n-- Default: true\nrequire(\"focus\").setup({ autoresize = { enable = false } })\n```\n\n\n**Set Focus Width**\n```lua\n-- Force width for the focused window\n-- Default: Calculated based on golden ratio\nrequire(\"focus\").setup({ autoresize = { width = 120 } })\n```\n\n**Set Focus Minimum Width**\n```lua\n-- Force minimum width for the unfocused window\n-- Default: Calculated based on golden ratio\nrequire(\"focus\").setup({ autoresize = { minwidth = 80} })\n```\n\n**Set Focus Height**\n```lua\n-- Force height for the focused window\n-- Default: Calculated based on golden ratio\nrequire(\"focus\").setup({ autoresize = { height = 40 } })\n```\n\n**Set Focus Minimum Height**\n```lua\n-- Force minimum height for the unfocused window\n-- Default: 0\nrequire(\"focus\").setup({ autoresize = { minheight = 10} })\n```\n\n**Set Focus Quickfix Height**\n```lua\n-- Sets the height of quickfix panel, in case you pass the height to\n-- `:copen `\n-- Default: 10\nrequire(\"focus\").setup({ autoresize = { height_quickfix = 10 })\n```\n\n**When creating a new split window, do/don't initialise it as an empty buffer**\n```lua\n-- True: When a :Focus.. command creates a new split window, initialise it as a new blank buffer\n-- False: When a :Focus.. command creates a new split, retain a copy of the current window in the new window\n-- Default: false\nrequire(\"focus\").setup({ split = { bufnew = true } })\n```\n\n**Set Focus Auto Numbers**\n```lua\n-- Displays line numbers in the focussed window only\n-- Not displayed in unfocussed windows\n-- Default: true\nrequire(\"focus\").setup({ui = { number = false } })\n```\n\n**Set Focus Auto Relative Numbers**\n```lua\n-- Displays relative line numbers in the focussed window only\n-- Not displayed in unfocussed windows\n-- See :help relativenumber\n-- Default: false\nrequire(\"focus\").setup({ ui = { relativenumber = true } })\n```\n\n**Set Focus Auto Hybrid Numbers**\n```lua\n-- Displays hybrid line numbers in the focussed window only\n-- Not displayed in unfocussed windows\n-- Combination of :help relativenumber, but also displays the line number of the\n-- current line only\n-- Default: false\nrequire(\"focus\").setup({ ui = { hybridnumber = true} })\n```\n\n**Set Presrve Absolute Numbers**\n```lua\n-- Preserve absolute numbers in the unfocussed windows\n-- Works in combination with relativenumber or hybridnumber\n-- Default: false\nrequire(\"focus\").setup({ ui = { absolutenumber_unfocussed = true } })\n```\n\n**When creating a new split window, use tmux split instead of neovim**\n```lua\n-- True: Create tmux splits instead of neovim splits\n-- False: Create neovim split windows\n-- Default: false\nrequire(\"focus\").setup({ split = { tmux = true } })\n```\n\n**Set Focus Auto Cursor Line**\n```lua\n-- Displays a cursorline in the focussed window only\n-- Not displayed in unfocussed windows\n-- Default: true\nrequire(\"focus\").setup({ ui = { cursorline = false } })\n```\n\n**Set Focus Auto Cursor Column**\n```lua\n-- Displays a cursor column in the focussed window only\n-- See :help cursorcolumn for more options\n-- Default: false\nrequire(\"focus\").setup({ ui = { cursorcolumn = true } })\n```\n\n**Set Focus Auto Color Column**\n```lua\n-- Displays a color column in the focussed window only\n-- See :help colorcolumn for more options\n-- Default: enable = false, list = '+1'\nrequire(\"focus\").setup({\n ui = {\n colorcolumn = {\n enable = true,\n list = '+1,+2'\n }\n }\n})\n```\n\n**Set Focus Auto Sign Column**\n```lua\n-- Displays a sign column in the focussed window only\n-- Gets the vim variable setcolumn when focus.setup() is run\n-- See :help signcolumn for more options e.g :set signcolum=yes\n-- Default: true, signcolumn=auto\nrequire(\"focus\").setup({ ui = { signcolumn = false } })\n```\n\n**Set Focus Window Highlighting**\n```lua\n-- Enable auto highlighting for focussed/unfocussed windows\n-- Default: false\nrequire(\"focus\").setup({ ui = { winhighlight = true } })\n\n-- By default, the highlight groups are setup as such:\n-- hi default link FocusedWindow VertSplit\n-- hi default link UnfocusedWindow Normal\n-- To change them, you can link them to a different highlight group, see\n-- `:help hi-default` for more info.\nvim.highlight.link('FocusedWindow', 'CursorLine', true)\nvim.highlight.link('UnfocusedWindow', 'VisualNOS', true)\n```\n\n## Disabling Focus\n\nFocus can be disabled by setting a variable for just one window,\n(`vim.w.focus_disable = true`), just one buffer (`vim.b.focus_disable = true`), or globally (`vim.g.focus_disable = true`).\n\nIf you want to disable Focus for certain buffer or file types you can do\nthis by setting up autocommands (`:help autocmd`) in your configuration.\n\nHere is an example:\n\n```lua\nlocal ignore_filetypes = { 'neo-tree' }\nlocal ignore_buftypes = { 'nofile', 'prompt', 'popup' }\n\nlocal augroup =\n vim.api.nvim_create_augroup('FocusDisable', { clear = true })\n\nvim.api.nvim_create_autocmd('WinEnter', {\n group = augroup,\n callback = function(_)\n if vim.tbl_contains(ignore_buftypes, vim.bo.buftype)\n then\n vim.w.focus_disable = true\n else\n vim.w.focus_disable = false\n end\n end,\n desc = 'Disable focus autoresize for BufType',\n})\n\nvim.api.nvim_create_autocmd('FileType', {\n group = augroup,\n callback = function(_)\n if vim.tbl_contains(ignore_filetypes, vim.bo.filetype) then\n vim.b.focus_disable = true\n else\n vim.b.focus_disable = false\n end\n end,\n desc = 'Disable focus autoresize for FileType',\n})\n```\n\n## Vim Commands\n\n*For more information on below commands scroll down to see them each described\nin more detail*\n\n| _Command_ | _Description_ |\n| -------------------------- | ----------------------------------------------- |\n| `:FocusDisable` | Disable the plugin per session. Splits will be normalized back to defaults and then spaced evenly. |\n| `:FocusEnable` | Enable the plugin per session. Splits will be resized back to your configs or defaults if not set. |\n| `:FocusToggle` | Toggle focus on and off again. |\n| `:FocusSplitNicely` | Split a window based on the golden ratio rule. |\n| `:FocusSplitCycle` | If there are no splits, create one and move to it, else cycle focussed split. `:FocusSplitCycle reverse` for counterclockwise |\n| `:FocusDisableWindow` | Disable resizing of the current window (winnr). |\n| `:FocusEnableWindow` | Enable resizing of the current window (winnr). |\n| `:FocusToggleWindow` | Toggle focus on and off again on a per window basis. |\n| `:FocusGetDisabledWindows` | Pretty prints the list of disabled window ID's along with the current window ID. |\n| `:FocusSplitLeft` | Move to existing or create a new split to the left of your current window + open file or custom command. |\n| `:FocusSplitDown` | Move to existing or create a new split to the bottom of your current window + open file or custom command. |\n| `:FocusSplitUp` | Move to existing or create a new split to the top of your current window + open file or custom command. |\n| `:FocusSplitRight` | Move to existing or create a new split to the right of your current window + open file or custom command. |\n| `:FocusEqualise` | Temporarily equalises the splits so they are all of similar width/height. |\n| `:FocusMaximise` | Temporarily maximises the focussed window. |\n| `:FocusMaxOrEqual` | Toggles Between having the splits equalised or the focussed window maximised. |\n\n## Splitting Nicely\n\nFocus allows you to split windows to tiled windows nicely and sized according to\nthe golden ratio.\n\n```\n+----------------+------------+\n| | S1 |\n| | |\n| +------------+\n| | |\n| MAIN PANE | S2 |\n| | |\n| | |\n| | |\n+----------------+------------+\n```\n\nTo get this view you would press the key combination 2 times.\n\n### Split nicely with ``\n\n```lua\nkeymap('n', '', function()\n require('focus').split_nicely()\nend, { desc = 'split nicely' })\n```\n\nAdditionally you can open a file or a run a custom command with the\n`:FocusSplitNicely` command\n\n*Opens a file in the split created by `FocusSplitNicely` command*\n\n`:FocusSplitNicely README.md`\n\n*Opens a terminal window in the split created by `FocusSplitNicely` command by\n using the cmd arg to run a custom command*\n\n`:FocusSplitNicely cmd term`\n\n\n## Split directionally\n\nInstead of worrying about multiple commands and shortcuts, *simply think about\nsplits as to which direction you would like to go*.\n\nCalling a focus split command i.e :FocusSplitRight will do one of two things,\n**it will attempt to move across to the window** in the specified direction.\nOtherwise, **if no window exists in the specified direction** relative to the\ncurrent window **then it will instead create a new blank buffer window** in the\ndirection specified, and then move to that window.\n\n### Leverage hjkl to move or create your splits directionally\n\n```lua\nlocal focusmap = function(direction)\n vim.keymap.set('n', ''..direction, function()\n require('focus').split_command(direction)\n end, { desc = string.format('Create or move to split (%s)', direction) })\nend\n\n-- Use `h` to split the screen to the left, same as command FocusSplitLeft etc\nfocusmap('h')\nfocusmap('j')\nfocusmap('k')\nfocusmap('l')\n```\n\nAdditionally you can open a file or a run a custom command with the\n`:FocusSplit` command\n\n*Opens a file in a split that was either created or moved to*\n\n`:FocusSplitRight README.md`\n\n*Opening a terminal window by using the cmd arg to run a custom command in a\nsplit that was created or moved to*\n\n`:FocusSplitDown cmd term`\n\n## FAQ\n\n* **I have a small display and I am finding splits are resized too much**\n\n If for example your screen resolution is *1024x768* --> i.e on the smaller\n side, you may notice that focus by default can maximise a window *too much*.\n\n That is, the window will sort of 'crush' some of your other splits due to the\n limited screen real estate. This is not an issue with focus, but an issue with\n minimal screen real estate. In this case, you can simply reduce the\n width/height of focus.\n\n\n* **Quickfix window opens in the right split always.\n Is this caused by focus.lua?**\n\n No. This is a\n [documented](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#quickfix)\n design decision by core vim, this might be something that can be adjusted\n upstream.\n\n In the meantime, you can open a quickfix window occupying the the full width\n of the window with `:botright copen`\n\n* **I tried to lazy load focus with `:FocusToggle`, but I need to toggle it\n again to get auto-resizing working**\n\n Please note if you lazy load with command `:FocusToggle`, it will load focus,\n but will toggle it off initially. See\n [#34](https://github.com/nvim-focus/focus.nvim/issues/34).\n\n This is because focus is toggled on by default when you load focus, so if you\n load it and then run the command `:FocusToggle`, it toggles it off again.\n\n## Similar plugins\n\n* [anuvyklack/windows.nvim](https://github.com/anuvyklack/windows.nvim)\n* [zhaocai/GoldenView.Vim](https://github.com/zhaocai/GoldenView.Vim)\n* [Bekaboo/deadcolumn.nvim](https://github.com/Bekaboo/deadcolumn.nvim)\n\n## Developers Only\n\n### Contributing\n\nPlease before submitting a PR install\n[stylua](https://github.com/JohnnyMorganz/StyLua) and run it in the root folder\nof `focus.nvim`.\n\n```sh\nstylua .\n```\n\nThis will format the code according to the guidelines set in `.stylua.toml`.\n\n### Testing\n\nYou can run the tests using `make test` if you initialise the git submodules.\n","dotfyleShieldAddedAt":null,"stars":572,"lastSyncedAt":"2023-11-30T02:20:05.911Z","addedLastWeek":0}}},{"id":"8ba33f44-9130-4570-b317-5e5693e06a3f","title":"refactor!: use window-local vars for disabling","text":"refactor!: use window-local vars for disabling\n\nEnsures that autoresize is disabled by window, as specified by the commands, and\nthat autoresize won't run when disabled.","type":"breaking-change","createdAt":"2023-08-18T02:11:03.178Z","breakingChange":{"id":33,"postId":"8ba33f44-9130-4570-b317-5e5693e06a3f","pluginId":550,"externalUrl":"https://github.com/nvim-focus/focus.nvim/commit/38a2df37614532feade3eb68dff35cb7c9de5e1e","sha":"38a2df37614532feade3eb68dff35cb7c9de5e1e","plugin":{"id":550,"owner":"beauwilliams","name":"focus.nvim","type":"github","source":"awesome-neovim","category":"split-and-window","link":"https://github.com/beauwilliams/focus.nvim","shortDescription":"Auto-Focusing and Auto-Resizing Splits/Windows for Neovim written in Lua. A full suite of window management enhancements. Vim splits on steroids!","createdAt":"2023-03-22T19:35:21.671Z","readme":"# focus.nvim\n\n[![GitHub stars](https://img.shields.io/github/stars/nvim-focus/focus.nvim.svg?style=social&label=Star)](https://GitHub.com/nvim-focus/focus.nvim/stargazers/)\n[![Requires Neovim 0.7+](https://img.shields.io/badge/requires-nvim%200.7%2B-9cf?logo=neovim)](https://neovim.io/)\n[![GitHub contributors](https://img.shields.io/github/contributors/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/graphs/contributors/)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/)\n[![GitHub issues](https://img.shields.io/github/issues/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/issues/)\n[![GitHub issues-closed](https://img.shields.io/github/issues-closed/nvim-focus/focus.nvim.svg)](https://GitHub.com/nvim-focus/focus.nvim/issues?q=is%3Aissue+is%3Aclosed)\n\nAlways have a nice view over your split windows\n\n## Preview\n\n![screencast](https://i.ibb.co/0tsKww4/focusop.gif)\n\n*Note*: For reference this screencast features dimensions set to 40 rows and 120\ncolumns.\n\n*See a visual demonstration of each focus feature\n[here](https://github.com/nvim-focus/focus.nvim/blob/master/DEMO.md)*.\n\n## Features\n\n* 👌 Resizes split windows automatically based on [golden ratio](https://en.wikipedia.org/wiki/Golden_ratio)\n* ⚙️ Enables cursorline/signcolumn/numbers on focus window only\n* 🙌 Window creation or switch by direction\n* 🖥 Equalise splits or maximise focused splits, and toggle between the two\n* 🔌 Option to open tmux windows instead of creating new splits\n\n## Installation\n\nHere are code snippets for some common installation methods (use only one):\n\n

With folke/lazy.nvim

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`{ 'nvim-focus/focus.nvim', version = false },`
'focus.nvim' library	Stable	`{ 'nvim-focus/focus.nvim', version = '*' },`

\n\n

With wbthomason/packer.nvim

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`use 'nvim-focus/focus.nvim'`
'focus.nvim' library	Stable	`use { 'nvim-focus/focus.nvim', branch = 'stable' }`

\n\n

With junegunn/vim-plug

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Github repo	Branch	Code snippet
'focus.nvim' library	Main	`Plug 'nvim-focus/focus.nvim'`
'focus.nvim' library	Stable	`Plug 'nvim-focus/focus.nvim', { 'branch': 'stable' }`