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 15:40:48 -06:00
commit fb9a52eae8
17 files changed
+306

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/
+17
View File
@@ -0,0 +1,17 @@
# 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
- Auto-detect project root via configurable markers
- Window-local working directory via `lcd`
- Zero-config auto-loading via `plugin/` directory
[0.1.0]: https://github.com/swaits/tiny-rooter.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.
+62
View File
@@ -0,0 +1,62 @@
# tiny-rooter.nvim
A tiny project root detector for Neovim 0.12+. Automatically sets the
local working directory to the project root when opening a file.
Zero config. ~15 lines of Lua.
## Features
- Auto-detects project root via marker files
- Sets local working directory (`lcd`) per window
- Ships with a comprehensive default marker list
- Configurable markers for custom project structures
- 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-rooter.nvim",
```
Done. The plugin auto-loads with sensible defaults.
## Configuration
All options are optional. Call `setup()` only if you want to customize:
```lua
require("tiny-rooter").setup({
markers = { ".git", ".jj", "Cargo.toml", "pyproject.toml", "Makefile", "go.mod", "package.json" },
})
```
## Default markers
The default marker list covers most common project types:
| Marker | Ecosystem |
|--------|-----------|
| `.git` | Git repositories |
| `.jj` | Jujutsu repositories |
| `Cargo.toml` | Rust |
| `pyproject.toml` | Python |
| `Makefile` | C/C++ and general |
| `go.mod` | Go |
| `package.json` | Node.js |
## How it works
On `BufReadPost` and `BufNewFile`, the plugin calls `vim.fs.root()` with
the configured markers. If a root is found, it runs `lcd` to set the
window-local working directory.
## License
[MIT](LICENSE)
+67
View File
@@ -0,0 +1,67 @@
*tiny-rooter.txt* Auto-detect project root and set local working directory
Author: Stephen Waits <https://github.com/swaits>
License: MIT
==============================================================================
CONTENTS *tiny-rooter-contents*
1. Introduction .............................. |tiny-rooter-introduction|
2. Requirements .............................. |tiny-rooter-requirements|
3. Installation .............................. |tiny-rooter-installation|
4. Configuration ............................. |tiny-rooter-configuration|
==============================================================================
1. INTRODUCTION *tiny-rooter-introduction*
tiny-rooter.nvim automatically sets the window-local working directory to
the project root when opening a file. Works out of the box with zero
configuration.
==============================================================================
2. REQUIREMENTS *tiny-rooter-requirements*
- Neovim >= 0.12
==============================================================================
3. INSTALLATION *tiny-rooter-installation*
Add to your |vim.pack.add()| call: >lua
"https://github.com/swaits/tiny-rooter.nvim",
<
That's it. The plugin auto-loads with defaults. To customize, call setup: >lua
require("tiny-rooter").setup({
markers = { ".git", ".jj", "Cargo.toml" },
})
<
==============================================================================
4. CONFIGURATION *tiny-rooter-configuration*
*tiny-rooter.setup()*
setup({opts})
Optional. The plugin works with defaults if you never call this.
Calling setup reconfigures the plugin with the given options.
All options shown with defaults: >lua
require("tiny-rooter").setup({
markers = {
".git", ".jj", "Cargo.toml", "pyproject.toml",
"Makefile", "go.mod", "package.json",
},
})
<
Parameters: ~
{opts} (table|nil) Configuration table
Fields: ~
{markers} (table) List of file/directory names that indicate a
project root. Searched upward from the current file.
Default: { ".git", ".jj", "Cargo.toml", "pyproject.toml",
"Makefile", "go.mod", "package.json" }
==============================================================================
vim:tw=78:ts=8:ft=help:norl:
+18
View File
@@ -0,0 +1,18 @@
local M = {}
function M.setup(opts)
opts = opts or {}
local markers = opts.markers
or { ".git", ".jj", "Cargo.toml", "pyproject.toml", "Makefile", "go.mod", "package.json" }
vim.api.nvim_create_autocmd({ "BufReadPost", "BufNewFile" }, {
group = vim.api.nvim_create_augroup("tiny-rooter", { clear = true }),
callback = function()
local root = vim.fs.root(0, markers)
if root then
vim.cmd.lcd(root)
end
end,
})
end
return M
+1
View File
@@ -0,0 +1 @@
require("tiny-rooter").setup()
+4
View File
@@ -0,0 +1,4 @@
-- Minimal init for testing tiny-rooter.nvim
vim.opt.rtp:prepend(".")
vim.opt.rtp:prepend("deps/mini.nvim")
vim.cmd("runtime plugin/tiny-rooter.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-rooter" })
eq(#groups > 0, true)
end
T["setup"]["is idempotent"] = function()
require("tiny-rooter").setup()
require("tiny-rooter").setup()
local groups = vim.api.nvim_get_autocmds({ group = "tiny-rooter" })
eq(#groups > 0, true)
end
T["setup"]["respects custom markers"] = function()
require("tiny-rooter").setup({ markers = { ".git" } })
local groups = vim.api.nvim_get_autocmds({ group = "tiny-rooter" })
eq(#groups > 0, true)
end
return T
+2
View File
@@ -0,0 +1,2 @@
[vim]
any = true