File: How-to-make-zsh-plugins.md

package info (click to toggle)
zplug 2.4.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,068 kB
  • sloc: sh: 1,504; awk: 235; makefile: 26
file content (67 lines) | stat: -rw-r--r-- 1,379 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# How to make zsh plugins

## Plugins adaptively-optimized for zplug

### autoload plugins

***Pattern 1***:

```
.
├── autoload
│   └── plugin   <=[main file]
└── doc
    ├── man
    │   └── man1
    │       └── plugin.1
    └── plugin.txt

4 directories, 3 files
```

zplug can manage zsh plugins with lazy loading. When you specify `zplug "package", lazy:1`, zplug search the `autoload` directory within the plugin directory and load it with lazy.

***Pattern 2***:

Of cource, you don't need to make `autoload` directory but in this case, you must specify `of` tag like `zplug "package", lazy:1, of:"plugin/plugin"` to tell a plugin file to zplug.

```
.
├── doc
│   ├── man
│   │   └── man1
│   │       └── plugin.txt
│   └── plugin.txt
├── init.zsh     <=[trigger file]
└── plugin
    └── plugin   <=[main file]

4 directories, 4 files
```

`init.zsh`:

```zsh
local this="${${(%):-%N}:A:h}"

fpath=(
$this/plugin(N-/)
$fpath
)

unset this

autoload -Uz plugin
```

However, if you prepare `init.zsh` that is trigger of loading the plugin, `of` tag doesn't require because zplug scan `*.zsh` file automatically in the top directory and load it.

- [sample plugin](https://github.com/b4b4r07/zsh_plugin)

### normal plugins

...

### commands

...