https://github.com/markuspeitl/custompeitl-zsh-plugin

https://github.com/markuspeitl/custompeitl-zsh-plugin

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/markuspeitl/custompeitl-zsh-plugin
• Owner: markuspeitl
• Created: 2023-10-25T15:52:17.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-23T15:52:54.000Z (9 months ago)
• Last Synced: 2024-04-24T18:52:47.764Z (9 months ago)
• Language: Shell
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Custom autocomplete for zsh functions

requires oh-my-zsh to be installed and plugin to be registered.

holds autocomplete scripts for custom commands in path.

- **conf:** can be used to find and edit the configuration of a program

`_conf` autocompletes the command with all directories in `~/.config`

- **rep:** can be used to open a repository in editor/IDE

`_rep` autocompletes the command with all directories in `~/repos`

Good resources on how to write zsh autocomplete functions are very diffult to find and even these

very simple commands required a lot of research and trial & error,  

particularly to figure out the exact conditions when a command is properly loaded by zsh and when not.  

--------------------

## Installation

clone this repo to `~/.oh-my-zsh/custom/plugins` by: 

```sh

git clone https://github.com/markuspeitl/custompeilt-zsh-plugin ~/.oh-my-zsh/custom/plugins/custompeitl

```

Add the plugin to zsh startup by adding the `custompeitl` plugin   

to the `~/.zshrc` plugins array:  

``plugins=(custompeitl) ``  

For debugging add 

```sh

autoload -Uz compinit

compinit -u

```

to .zshrc as otherwise the completions files and/or functions are not registered

Apparently a `_functionname` file has to be created for the completion function to even register and that  

file needs to be linked on top of file with   

```sh

#compdef functionname

#autoload

```

if then in script.plugin.zsh the _functionname is specified it masks the function of the completions file,  

otherwise it simply does not work as zsh only seems to get for _ files that they contain completion instructions.  

### Correction

Apparently it is possible to provide the completion in the same file as the function by adding the line  

```sh

compdef _functionname functionname

```

(where _functionname is the completion function  

and functionname is the command to be executed)  

to the script (which was registered as a oh-my-zsh plugin or that was added/findable to/by fpath)