zsh/zdharma-continuum.zinit-annex-meta-plugins
1
0
Fork 0
mirror of https://github.com/zdharma-continuum/zinit-annex-meta-plugins.git synced 2026-09-10 07:16:29 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add lint gh action workflow

Browse source
This commit is contained in:
Vladislav Doster 2023-04-14 17:11:08 -05:00
parent db112b274a
commit 789b3a58af
No known key found for this signature in database
2 changed files with 57 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
.github/workflows/lint.yml vendored Normal file
View file

@ -0,0 +1,15 @@
name: Lint
on:
pull_request:
branches: [main, master]
push:
branches: [main, master]
tags: ["v*.*.*"]
workflow_dispatch:
jobs:
commit:
uses: zdharma-continuum/.github/.github/workflows/commit-job.yml@main
lint:
uses: zdharma-continuum/.github/.github/workflows/lint-job.yml@main

14
README.md
View file

@ -1,6 +1,7 @@
# Meta-Plugins support for Zsh-Zinit
### **Install groups of plugins via a single, friendly label …**
### **… and also have the curated, optimal ice lists automatically applied !**
![screenshot](https://raw.githubusercontent.com/zdharma-continuum/zinit-annex-meta-plugins/master/images/fuzzy-mplg-ex.png)
@ -8,15 +9,15 @@ ### **… and also have the curated, optimal ice lists automatically applied !**
## Rationale
It can be tiring to:
1. Constantly, over and over collect some new interesting plugins to install/load.
2. Over and over reconstruct the new findings on the new machines.
3. Constantly extend and tweak the ice list of each plugin, so that it's hard on
eyes, especially for an outsider.
1. Over and over reconstruct the new findings on the new machines.
1. Constantly extend and tweak the ice list of each plugin, so that it's hard on eyes, especially for an outsider.
Meta-Plugins annex helps in those problems:
| Problem | Solution |
|:-------------------------:|----------|
| :--------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| (1)<br/> *finding new plugins* | the annex contains a curated, broad list of plugins, e.g.: all the console tools like `fd`, `fzf`, `exa`, `ripgrep`, etc., |
| (2)<br/> *reconstructing the findings in new environments* | it's easy to say and memorize e.g.: `zinit for console-tools` – one label pulls a group of plugins and also the curated, optimal, default ice lists for each of them, |
| (3)<br/> *constant increase of complexity of the commands* | the provided, hopefully best/optimal ices for each plugin are handled transparently and automatically; care is given to each ice list so that the plugin loads without any glitches (e.g.: without "No files for compilation found." message and other, even such slight issues). |
@ -24,7 +25,7 @@ ## Rationale
Other unique benefits of the Meta-Plugins annex:
| Benefit | Description |
|:-------------------------:|-------------|
| :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| plugin dependencies | The meta-plugins implement a dependency mechanism (to some extent), so that e.g.: selecting a from-source built [ogham/exa](https://github.com/ogham/exa) will automatically pull-in also the Rust compiler (available under meta-plugin name: `rust-toolchain`). |
| flexible disabling of chosen sub-plugins in any meta-plugin | A meta-plugin can contain many sub-plugins and it's possible to skip installing some of them by the **skip'plg-1 plg-2…'** ice, e.g.: `zinit skip'ripgrep fd' for console-tools`. This way despite that some of the meta-plugins are broad the user still has control over what's and how much is being installed. |
| common from-source meta-plugins | For the plugins that provide the binary programs it is often the case that a meta-plugin exists that'll build the program from source (e.g.: **fuzzy** meta-plugin and its **fuzzy-src** counterpart). This might be handy e.g.: if there's no binary for our machine. |
@ -32,7 +33,7 @@ ## Rationale
## The list of the meta-plugins
| Meta-Plugin ID | Contained sub-plugins |
|:-----------------:|-----------------------|
| :-----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **annexes** | [zdharma-continuum/zinit-annex-unscope](https://github.com/zdharma-continuum/zinit-annex-unscope), [zdharma-continuum/zinit-annex-as-monitor](https://github.com/zdharma-continuum/zinit-annex-as-monitor), [zdharma-continuum/zinit-annex-patch-dl](https://github.com/zdharma-continuum/zinit-annex-patch-dl), [zdharma-continuum/zinit-annex-rust](https://github.com/zdharma-continuum/zinit-annex-rust), [zdharma-continuum/zinit-annex-submods](https://github.com/zdharma-continuum/zinit-annex-submods), [zdharma-continuum/zinit-annex-bin-gem-node](https://github.com/zdharma-continuum/zinit-annex-bin-gem-node) |
| **annexes+con** | [zdharma-continuum/zinit-console](https://github.com/zdharma-continuum/zinit-console), annexes (**meta-plugin**) |
| | |
@ -65,4 +66,5 @@ ## Example zshrc
# Installs total of 22 plugins
zinit for annexes zsh-users+fast console-tools fuzzy
```
<!-- vim:set ft=markdown tw=81 fo+=a1n autoindent: -->