https://github.com/sohanemon/cdx.yazi
A Yazi plugin that enhances directory navigation
https://github.com/sohanemon/cdx.yazi
lua neovim yazi yazi-plugin
Last synced: 5 months ago
JSON representation
A Yazi plugin that enhances directory navigation
- Host: GitHub
- URL: https://github.com/sohanemon/cdx.yazi
- Owner: sohanemon
- License: gpl-3.0
- Created: 2025-02-15T01:13:18.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T01:48:37.000Z (8 months ago)
- Last Synced: 2025-02-15T02:30:00.835Z (8 months ago)
- Topics: lua, neovim, yazi, yazi-plugin
- Language: Lua
- Homepage: https://sohanjs.web.app/cdx.yazi
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cdx - Change Directory Extended
A [Yazi](https://yazi-rs.github.io/) plugin that enhances directory navigation with smart path resolution, fallback strategies, and configuration support.
## Features
- **Smart Path Resolution:** Handles both absolute and relative paths.
- **Multiple Fallbacks:** Tries several strategies to find a valid directory.
- **Configurable:** Customize behavior via a `sohanscript.json` file.
- **$NVIM_CWD Integration:** (Requires [Yazi.nvim](https://github.com/mikavilpas/yazi.nvim))
- **User Notifications:** Alerts when a path is invalid.
- **Extensible:** Easily add custom path handling.
## Installation
### Git Clone
```sh
git clone https://github.com/sohanemon/cdx.yazi ~/.config/yazi/plugins/cdx.yazi
```
### Using `ya`
```sh
ya pack -a sohanemon/cdx
```
### Using `lazy.nvim` (Requires [Yazi.nvim](https://github.com/mikavilpas/yazi.nvim))
```lua
{
"sohanemon/cdx.yazi",
lazy = true,
build = function(plugin)
require("yazi.plugin").build_plugin(plugin)
end,
},
```
## Usage
Configure keymaps in your `~/.config/yazi/keymap.toml`. For example:
```toml
[manager]
prepend_keymap = [
{ on = ["g", "d"], run = "plugin cdx --args='~/Downloads'", desc = "Downloads" },
{ on = ["g", "t"], run = "plugin cdx --args='~/temp'", desc = "Temporary" },
{ on = ["g", "h"], run = "plugin cdx --args='/'", desc = "Home/Src" },
{ on = ["g", "s"], run = "plugin cdx --args='/styles /style /css ~/Sync'", desc = "Styles" },
{ on = ["g", "u"], run = "plugin cdx --args='/components/ui /components'", desc = "UI Components" },
{ on = ["g", "l"], run = "plugin cdx --args='/lib /libs /utils'", desc = "Library" },
{ on = ["g", "p"], run = "plugin cdx --args='/app/(index) /app/[locale] /app /pages /routes'", desc = "Pages" },
{ on = ["g", "a"], run = "plugin cdx --args='/public/assets /public/images /public'", desc = "Assets" },
{ on = ["g", "C"], run = "plugin cdx --args='~/Code'", desc = "Code" },
{ on = ["g", "S"], run = "plugin cdx --args='~/Sync'", desc = "Syncthing" },
{ on = ["g", "c"], run = "plugin cdx --args='/components ~/Code'", desc = "Components" }
]
```
The plugin automatically resolves and validates paths using its fallback strategies, notifying you if no valid path is found.
## Notes
- **Priority:** Uses `$NVIM_CWD` when available, falling back to the home directory or relative paths.
- **Base Path:** Defaults are set via `sohanscript.json`.
- **Extensibility:** Built to allow custom path handling.
## Configuration (Optional)
Create a `sohanscript.json` in your working directory to set defaults and fallbacks:
```json
{
"$schema": "https://sohanjs.web.app/draft/next/schema.json",
"packageManager": "bun",
"cwd": "$NVIM_CWD/src",
"directories": {
"lib": "$NVIM_CWD/src/lib",
"public": "$NVIM_CWD/public"
}
}
```
This file lets you define a base directory, package manager, and custom directory mappings.