From 38c06f758fcd714bc371b767ab8ba860b8d2d556 Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Thu, 9 Apr 2026 17:30:27 -0600 Subject: [PATCH] feat: initial release --- .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 21 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 +++++++++ .github/workflows/ci.yml | 30 ++++++++++++++++ .gitignore | 6 ++++ CHANGELOG.md | 14 ++++++++ LICENSE | 21 +++++++++++ README.md | 43 +++++++++++++++++++++++ doc/tiny-shoo.txt | 40 +++++++++++++++++++++ lua/tiny-shoo/init.lua | 40 +++++++++++++++++++++ plugin/tiny-shoo.lua | 1 + scripts/minimal_init.lua | 4 +++ scripts/test.sh | 11 ++++++ selene.toml | 1 + stylua.toml | 4 +++ tests/test_init.lua | 24 +++++++++++++ vim.toml | 2 ++ 17 files changed, 279 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 doc/tiny-shoo.txt create mode 100644 lua/tiny-shoo/init.lua create mode 100644 plugin/tiny-shoo.lua create mode 100644 scripts/minimal_init.lua create mode 100755 scripts/test.sh create mode 100644 selene.toml create mode 100644 stylua.toml create mode 100644 tests/test_init.lua create mode 100644 vim.toml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..d2b37e7 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: swaits diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1865fe3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..8b76998 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..dea83c1 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..009393c --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.swp +*.swo +*~ +.DS_Store +tags +deps/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e9971bd --- /dev/null +++ b/CHANGELOG.md @@ -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 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1c20050 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f19eb04 --- /dev/null +++ b/README.md @@ -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) diff --git a/doc/tiny-shoo.txt b/doc/tiny-shoo.txt new file mode 100644 index 0000000..a934a77 --- /dev/null +++ b/doc/tiny-shoo.txt @@ -0,0 +1,40 @@ +*tiny-shoo.txt* Dismiss transient windows easily + +Author: Stephen Waits +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: diff --git a/lua/tiny-shoo/init.lua b/lua/tiny-shoo/init.lua new file mode 100644 index 0000000..335f635 --- /dev/null +++ b/lua/tiny-shoo/init.lua @@ -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", "close", { 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 diff --git a/plugin/tiny-shoo.lua b/plugin/tiny-shoo.lua new file mode 100644 index 0000000..850fa97 --- /dev/null +++ b/plugin/tiny-shoo.lua @@ -0,0 +1 @@ +require("tiny-shoo").setup() diff --git a/scripts/minimal_init.lua b/scripts/minimal_init.lua new file mode 100644 index 0000000..ffa6db6 --- /dev/null +++ b/scripts/minimal_init.lua @@ -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") diff --git a/scripts/test.sh b/scripts/test.sh new file mode 100755 index 0000000..f54b001 --- /dev/null +++ b/scripts/test.sh @@ -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')" diff --git a/selene.toml b/selene.toml new file mode 100644 index 0000000..d03ab0a --- /dev/null +++ b/selene.toml @@ -0,0 +1 @@ +std = "vim" diff --git a/stylua.toml b/stylua.toml new file mode 100644 index 0000000..9218af5 --- /dev/null +++ b/stylua.toml @@ -0,0 +1,4 @@ +column_width = 100 +indent_type = "Spaces" +indent_width = 2 +quote_style = "AutoPreferDouble" diff --git a/tests/test_init.lua b/tests/test_init.lua new file mode 100644 index 0000000..8340d99 --- /dev/null +++ b/tests/test_init.lua @@ -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 diff --git a/vim.toml b/vim.toml new file mode 100644 index 0000000..0fa5c4f --- /dev/null +++ b/vim.toml @@ -0,0 +1,2 @@ +[vim] +any = true