feat: initial release
CI / lint (push) Canceled after 0s
CI / test (push) Canceled after 0s

This commit is contained in:
swaits committed 2026-04-09 17:30:30 -06:00
commit 8f9208f0d0
17 files changed
+252

No files matched your search

+1
View File
@@ -0,0 +1 @@
github: swaits
+21
View File
@@ -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):
+16
View File
@@ -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.
+30
View File
@@ -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
+6
View File
@@ -0,0 +1,6 @@
*.swp
*.swo
*~
.DS_Store
tags
deps/
+14
View File
@@ -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-checktime.nvim/releases/tag/v0.1.0
+21
View File
@@ -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.
+46
View File
@@ -0,0 +1,46 @@
# tiny-checktime.nvim
A tiny plugin for Neovim 0.12+ that checks for externally modified files when
focus returns.
Zero config. ~12 lines of Lua.
## Features
- Runs `:checktime` on focus gain and terminal events
- Pairs with `autoread` to auto-reload changed files
- Configurable trigger events
- 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-checktime.nvim",
```
## Configuration
All options are optional. Call `setup()` only if you want to customize:
```lua
require("tiny-checktime").setup({
events = { "FocusGained", "TermClose", "TermLeave" },
})
```
## How it works
When Neovim regains focus (switching back from another app or terminal pane),
it runs `:checktime` to ask Neovim to check if any buffers were modified on
disk. Combined with `vim.opt.autoread = true`, changed files reload
automatically.
## License
[MIT](LICENSE)
+34
View File
@@ -0,0 +1,34 @@
*tiny-checktime.txt* Check for external file changes on focus
Author: Stephen Waits <https://github.com/swaits>
License: MIT
==============================================================================
CONTENTS *tiny-checktime-contents*
1. Introduction ........................ |tiny-checktime-introduction|
2. Configuration ....................... |tiny-checktime-configuration|
==============================================================================
1. INTRODUCTION *tiny-checktime-introduction*
tiny-checktime.nvim runs |:checktime| when Neovim regains focus, so
externally modified files are detected. Pairs with 'autoread'.
==============================================================================
2. CONFIGURATION *tiny-checktime-configuration*
*tiny-checktime.setup()*
setup({opts})
Optional. All options shown with defaults: >lua
require("tiny-checktime").setup({
events = { "FocusGained", "TermClose", "TermLeave" },
})
<
Fields: ~
{events} (table) Events that trigger checktime.
==============================================================================
vim:tw=78:ts=8:ft=help:norl:
+16
View File
@@ -0,0 +1,16 @@
local M = {}
function M.setup(opts)
opts = opts or {}
local events = opts.events or { "FocusGained", "TermClose", "TermLeave" }
vim.api.nvim_create_autocmd(events, {
group = vim.api.nvim_create_augroup("tiny-checktime", { clear = true }),
callback = function()
if vim.o.buftype ~= "nofile" then
vim.cmd("checktime")
end
end,
})
end
return M
+1
View File
@@ -0,0 +1 @@
require("tiny-checktime").setup()
+4
View File
@@ -0,0 +1,4 @@
-- Minimal init for testing tiny-checktime.nvim
vim.opt.rtp:prepend(".")
vim.opt.rtp:prepend("deps/mini.nvim")
vim.cmd("runtime plugin/tiny-checktime.lua")
+11
View File
@@ -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')"
+1
View File
@@ -0,0 +1 @@
std = "vim"
+4
View File
@@ -0,0 +1,4 @@
column_width = 100
indent_type = "Spaces"
indent_width = 2
quote_style = "AutoPreferDouble"
+24
View File
@@ -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-checktime" })
eq(#groups > 0, true)
end
T["setup"]["is idempotent"] = function()
require("tiny-checktime").setup()
require("tiny-checktime").setup()
local groups = vim.api.nvim_get_autocmds({ group = "tiny-checktime" })
eq(#groups > 0, true)
end
T["setup"]["respects custom events"] = function()
require("tiny-checktime").setup({ events = { "FocusGained" } })
local groups = vim.api.nvim_get_autocmds({ group = "tiny-checktime" })
eq(#groups, 1)
end
return T
+2
View File
@@ -0,0 +1,2 @@
[vim]
any = true