swaits
0544840b42
Covers files missed by the first pass (.svelte/.astro components, bare org and profile links, plugin doc headers), plus content that needed rewriting rather than a URL swap: the chezmoi bootstrap script now provisions SSH for git.swaits.com (User git, port 2222) and initialises from Gitea. Link labels were updated to match their new targets.
68 lines
2.5 KiB
Plaintext
68 lines
2.5 KiB
Plaintext
*tiny-rooter.txt* Auto-detect project root and set local working directory
|
|
|
|
Author: Stephen Waits <https://git.swaits.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://git.swaits.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:
|