Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow installing yazi plugins from a plugin monorepo #177

Merged
merged 2 commits into from
Jul 11, 2024

Conversation

mikavilpas
Copy link
Owner

Some plugins are not found at the root of the repository, but in a
subdirectory. This change allows specifying a subdirectory when
installing a plugin.

It corresponds to using # in the plugin URL when installing plugins
without yazi.nvim with the ya pack command.

ya pack -a redbeardymcgee/yazi-plugins#keyjump

Is the same as:

---@type LazySpec
{
  "redbeardymcgee/yazi-plugins",
  lazy = true,
  build = function(plugin)
    require("yazi.plugin").build_plugin(plugin, { sub_dir = "keyjump.yazi" })
  end,
},

Some plugins are not found at the root of the repository, but in a
subdirectory. This change allows specifying a subdirectory when
installing a plugin.

It corresponds to using `#` in the plugin URL when installing plugins
without yazi.nvim with the `ya pack` command.

```sh
ya pack -a redbeardymcgee/yazi-plugins#keyjump
```

Is the same as:

```lua
---@type LazySpec
{
  "redbeardymcgee/yazi-plugins",
  lazy = true,
  build = function(plugin)
    require("yazi.plugin").build_plugin(plugin, { sub_dir = "keyjump.yazi" })
  end,
},
```
Plugins by the prolific DreamMaoMao have been taken down from GitHub. This
commit removes references to them from the documentation.

The plugins are now hosted in the redbeardymcgee/yazi-plugins
repository, see

<https://github.com/redbeardymcgee/yazi-flavors/pull/3>
@mikavilpas mikavilpas enabled auto-merge (rebase) July 11, 2024 05:15
@mikavilpas mikavilpas merged commit 6584924 into main Jul 11, 2024
13 checks passed
@mikavilpas mikavilpas deleted the new-plugin-urls branch July 11, 2024 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant