https://github.com/MasouShizuka/projects.yazi

A yazi plugin that adds the functionality to save and load projects.
https://github.com/MasouShizuka/projects.yazi

yazi-plugin

Last synced: about 5 hours ago
JSON representation

A yazi plugin that adds the functionality to save and load projects.

• Host: GitHub
• URL: https://github.com/MasouShizuka/projects.yazi
• Owner: MasouShizuka
• License: mit
• Created: 2024-04-30T10:27:14.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T00:59:02.000Z (3 months ago)
• Last Synced: 2024-08-05T01:56:39.252Z (3 months ago)
• Topics: yazi-plugin
• Language: Lua
• Homepage:
• Size: 20.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-yazi - projects - A yazi plugin that adds the functionality to save and load projects. (Plugins)
• awesome-yazi - projects - A yazi plugin that adds the functionality to save and load projects. (Plugins)

README

        
# projects.yazi

A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the functionality to save, load and merge projects.

A project means all `tabs` and their status, including `cwd` and so on.

> [!NOTE]

> The latest main branch of Yazi is required at the moment.

https://github.com/MasouShizuka/projects.yazi/assets/44764707/79c3559a-7776-48cd-8317-dd1478314eed

## Features

 - Save/load projects

 - Load last project

 - Projects persistence

 - Merge a project or its current tab to other projects

## Installation

```sh

ya pack -a MasouShizuka/projects.yazi

```

or

```sh

# Windows

git clone https://github.com/MasouShizuka/projects.yazi.git %AppData%\yazi\config\plugins\projects.yazi

# Linux/macOS

git clone https://github.com/MasouShizuka/projects.yazi.git ~/.config/yazi/plugins/projects.yazi

```

## Configuration

Add this to your `keymap.toml`:

```toml

[[manager.prepend_keymap]]

on = [ "P", "s" ]

run = "plugin projects --args=save"

desc = "Save current project"

[[manager.prepend_keymap]]

on = [ "P", "l" ]

run = "plugin projects --args=load"

desc = "Load project"

[[manager.prepend_keymap]]

on = [ "P", "P" ]

run = "plugin projects --args=load_last"

desc = "Load last project"

[[manager.prepend_keymap]]

on = [ "P", "d" ]

run = "plugin projects --args=delete"

desc = "Delete project"

[[manager.prepend_keymap]]

on = [ "P", "D" ]

run = "plugin projects --args=delete_all"

desc = "Delete all projects"

[[manager.prepend_keymap]]

on = [ "P", "m" ]

run = "plugin projects --args='merge current'"

desc = "Merge current tab to other projects"

[[manager.prepend_keymap]]

on = [ "P", "M" ]

run = "plugin projects --args='merge all'"

desc = "Merge current project to other projects"

```

If you want to save the last project when exiting, map the default `quit` key to:

```toml

[[manager.prepend_keymap]]

on = [ "q" ]

run = "plugin projects --args=quit"

desc = "Save last project and exit the process"

```

---

Additionally there are configurations that can be done using the plugin's `setup` function in Yazi's `init.lua`, i.e. `~/.config/yazi/init.lua`.

The following are the default configurations:

```lua

require("projects"):setup({

    save = {

        method = "yazi", -- yazi | lua

        lua_save_path = "", -- windows: "%APPDATA%/yazi/state/projects.json", unix: "~/.config/yazi/state/projects.json"

    },

    last = {

        update_after_save = true,

        update_after_load = true,

    },

    merge = {

        quit_after_merge = false,

    },

    notify = {

        enable = true,

        title = "Projects",

        timeout = 3,

        level = "info",

    },

})

```

### `save`

> [!NOTE]

> Yazi's api sometimes doesn't work on Windows, which is why the `lua` method is proposed

`method` means the method of saving projects:

- `yazi`: using `yazi` api to save to `.dds` file

- `lua`: using Lua to save

`lua_save_path` means the path of saved file with lua api, the defalut is

- `Windows`: `%APPDATA%/yazi/state/projects.json`

- `Unix`: `~/.config/yazi/state/projects.json`

### `last`

The last project is loaded by `load_last` command.

When `update_after_save` enabled, the saved project will be saved to last project.

When `update_after_load` enabled, the loaded project will be saved to last project.

### `merge`

When `quit_after_merge` enabled, the merged project will be exited after merging.

### `notify`

When enabled, notifications will be shown when the user saves/loads/deletes/merges a project and deletes all projects.

`title`, `timeout`, `level` are the same as [ya.notify](https://yazi-rs.github.io/docs/plugins/utils/#ya.notify).