feat: initial release
This commit is contained in:
17 files changed
+279
No files matched your search
@@ -0,0 +1 @@
|
||||
github: swaits
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior.
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Environment**
|
||||
- Neovim version:
|
||||
- OS:
|
||||
- Config (if relevant):
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem?**
|
||||
A clear and concise description of what the problem is.
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the feature request here.
|
||||
@@ -0,0 +1,30 @@
|
||||
name: CI
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: JohnnyMorganz/stylua-action@v4
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
version: latest
|
||||
args: --check lua/ plugin/
|
||||
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install Neovim
|
||||
run: |
|
||||
wget -q https://github.com/neovim/neovim/releases/download/v0.12.0/nvim-linux-x86_64.appimage -O /tmp/nvim.appimage
|
||||
chmod +x /tmp/nvim.appimage
|
||||
/tmp/nvim.appimage --appimage-extract > /dev/null 2>&1
|
||||
echo "$PWD/squashfs-root/usr/bin" >> $GITHUB_PATH
|
||||
- name: Run tests
|
||||
run: ./scripts/test.sh
|
||||
@@ -0,0 +1,6 @@
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
.DS_Store
|
||||
tags
|
||||
deps/
|
||||
@@ -0,0 +1,14 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.1.0] - 2026-04-09
|
||||
|
||||
### Added
|
||||
|
||||
- Initial release
|
||||
|
||||
[0.1.0]: https://github.com/swaits/tiny-shoo.nvim/releases/tag/v0.1.0
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Stephen Waits
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,43 @@
|
||||
# tiny-shoo.nvim
|
||||
|
||||
A tiny plugin for Neovim 0.12+ that makes transient windows easy to dismiss.
|
||||
|
||||
Zero config. ~25 lines of Lua.
|
||||
|
||||
## Features
|
||||
|
||||
- Press `q` to close special buffers (help, quickfix, checkhealth, etc.)
|
||||
- Auto-closes quickfix window when it's the last window open
|
||||
- Marks transient buffers as unlisted
|
||||
- Configurable filetype list
|
||||
- Works out of the box — no setup call required
|
||||
|
||||
## Requirements
|
||||
|
||||
- Neovim >= 0.12
|
||||
|
||||
## Installation
|
||||
|
||||
Add to your `vim.pack.add()` call:
|
||||
|
||||
```lua
|
||||
"https://github.com/swaits/tiny-shoo.nvim",
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
All options are optional. Call `setup()` only if you want to customize:
|
||||
|
||||
```lua
|
||||
require("tiny-shoo").setup({
|
||||
filetypes = {
|
||||
"checkhealth", "help", "lspinfo", "man", "neotest-output",
|
||||
"neotest-output-panel", "neotest-summary", "notify", "qf",
|
||||
"query", "startuptime",
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
@@ -0,0 +1,40 @@
|
||||
*tiny-shoo.txt* Dismiss transient windows easily
|
||||
|
||||
Author: Stephen Waits <https://github.com/swaits>
|
||||
License: MIT
|
||||
|
||||
==============================================================================
|
||||
CONTENTS *tiny-shoo-contents*
|
||||
|
||||
1. Introduction ............................. |tiny-shoo-introduction|
|
||||
2. Configuration ............................ |tiny-shoo-configuration|
|
||||
|
||||
==============================================================================
|
||||
1. INTRODUCTION *tiny-shoo-introduction*
|
||||
|
||||
tiny-shoo.nvim makes transient windows easy to dismiss. Press `q` to
|
||||
close special buffers (help, quickfix, etc.) and the quickfix window
|
||||
auto-closes when it's the last window. Zero configuration needed.
|
||||
|
||||
==============================================================================
|
||||
2. CONFIGURATION *tiny-shoo-configuration*
|
||||
|
||||
*tiny-shoo.setup()*
|
||||
setup({opts})
|
||||
|
||||
Optional. All options shown with defaults: >lua
|
||||
|
||||
require("tiny-shoo").setup({
|
||||
filetypes = {
|
||||
"checkhealth", "help", "lspinfo", "man",
|
||||
"neotest-output", "neotest-output-panel",
|
||||
"neotest-summary", "notify", "qf", "query",
|
||||
"startuptime",
|
||||
},
|
||||
})
|
||||
<
|
||||
Fields: ~
|
||||
{filetypes} (table) Filetypes that get q-to-close behavior.
|
||||
|
||||
==============================================================================
|
||||
vim:tw=78:ts=8:ft=help:norl:
|
||||
@@ -0,0 +1,40 @@
|
||||
local M = {}
|
||||
|
||||
function M.setup(opts)
|
||||
opts = opts or {}
|
||||
local filetypes = opts.filetypes
|
||||
or {
|
||||
"checkhealth",
|
||||
"help",
|
||||
"lspinfo",
|
||||
"man",
|
||||
"neotest-output",
|
||||
"neotest-output-panel",
|
||||
"neotest-summary",
|
||||
"notify",
|
||||
"qf",
|
||||
"query",
|
||||
"startuptime",
|
||||
}
|
||||
local group = vim.api.nvim_create_augroup("tiny-shoo", { clear = true })
|
||||
|
||||
vim.api.nvim_create_autocmd("FileType", {
|
||||
group = group,
|
||||
pattern = filetypes,
|
||||
callback = function(event)
|
||||
vim.bo[event.buf].buflisted = false
|
||||
vim.keymap.set("n", "q", "<cmd>close<cr>", { buffer = event.buf, silent = true })
|
||||
end,
|
||||
})
|
||||
|
||||
vim.api.nvim_create_autocmd("WinEnter", {
|
||||
group = group,
|
||||
callback = function()
|
||||
if vim.fn.winnr("$") == 1 and vim.bo.buftype == "quickfix" then
|
||||
vim.cmd("quit")
|
||||
end
|
||||
end,
|
||||
})
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1 @@
|
||||
require("tiny-shoo").setup()
|
||||
@@ -0,0 +1,4 @@
|
||||
-- Minimal init for testing tiny-shoo.nvim
|
||||
vim.opt.rtp:prepend(".")
|
||||
vim.opt.rtp:prepend("deps/mini.nvim")
|
||||
vim.cmd("runtime plugin/tiny-shoo.lua")
|
||||
Executable
+11
@@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Clone mini.nvim for test framework (if not cached)
|
||||
if [ ! -d deps/mini.nvim ]; then
|
||||
mkdir -p deps
|
||||
git clone --depth 1 https://github.com/echasnovski/mini.nvim deps/mini.nvim
|
||||
fi
|
||||
|
||||
# Run tests
|
||||
nvim --headless -u scripts/minimal_init.lua -c "lua require('mini.test').setup(); MiniTest.run_file('tests/test_init.lua')"
|
||||
@@ -0,0 +1 @@
|
||||
std = "vim"
|
||||
@@ -0,0 +1,4 @@
|
||||
column_width = 100
|
||||
indent_type = "Spaces"
|
||||
indent_width = 2
|
||||
quote_style = "AutoPreferDouble"
|
||||
@@ -0,0 +1,24 @@
|
||||
local T = MiniTest.new_set()
|
||||
local eq = MiniTest.expect.equality
|
||||
|
||||
T["setup"] = MiniTest.new_set()
|
||||
|
||||
T["setup"]["creates augroup"] = function()
|
||||
local groups = vim.api.nvim_get_autocmds({ group = "tiny-shoo" })
|
||||
eq(#groups > 0, true)
|
||||
end
|
||||
|
||||
T["setup"]["is idempotent"] = function()
|
||||
require("tiny-shoo").setup()
|
||||
require("tiny-shoo").setup()
|
||||
local groups = vim.api.nvim_get_autocmds({ group = "tiny-shoo" })
|
||||
eq(#groups > 0, true)
|
||||
end
|
||||
|
||||
T["setup"]["respects custom filetypes"] = function()
|
||||
require("tiny-shoo").setup({ filetypes = { "help", "qf" } })
|
||||
local groups = vim.api.nvim_get_autocmds({ group = "tiny-shoo", event = "FileType" })
|
||||
eq(#groups > 0, true)
|
||||
end
|
||||
|
||||
return T
|
||||
Reference in new issue
Block a user