psi-jack/zimfw
1
0
Fork 0
mirror of synced 2024-11-22 15:25:34 -05:00
Code Issues Releases Wiki Activity

[completion] Add options to README.md

Browse source 
Prefer `setopt NO_FOO` instead of `unsetopt FOO`, as former is easier to
document in the README.

Stick with the following style for the README:

* Header 1 with the module name is in `lowercase`.
* Other headers are in `Sentence case`. Common header names that should
  be consistently used are `Aliases`, `Contributing`, `Functions`,
  `Settings`, and `Zsh options`.
This commit is contained in:
Eric Nielsen 2018-12-15 16:54:32 -05:00
parent 81a52a5d7d
commit ab41c4484d
2 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
modules/completion/README.md
View file

@ -3,9 +3,19 @@ completion
Enables and configures smart and extensive tab completion. Enables and configures smart and extensive tab completion.
Completions are sourced from [zsh-completions](https://github.com/zsh-users/zsh-completions). Completions are sourced from [zsh-completions][zsh-completions].
Zsh options
-----------
* `ALWAYS_TO_END` moves cursor to end of word if a full completion is inserted.
* `PATH_DIRS` performs path search even on command names with slashes in them.
* `NO_CASE_GLOB` makes globbing case insensitive.
* `NO_LIST_BEEP` doesn't beep on ambiguous completions.
Contributing Contributing
------------ ------------
Command completions should be submitted [upstream to zsh-completions](https://github.com/zsh-users/zsh-completions). Command completions should be submitted [upstream to zsh-completions][zsh-completions].
[zsh-completions]: https://github.com/zsh-users/zsh-completions

8
modules/completion/init.zsh
View file

@ -23,18 +23,18 @@ autoload -Uz compinit && compinit -C -d "${ZDOTDIR:-${HOME}}/${zcompdump_file:-.
# zsh options # zsh options
# #
# If a completion is performed with the cursor within a word, and a full completion is inserted, # If a completion is performed with the cursor within a word, and a full
# the cursor is moved to the end of the word # completion is inserted, the cursor is moved to the end of the word.
setopt ALWAYS_TO_END setopt ALWAYS_TO_END
# Perform a path search even on command names with slashes in them. # Perform a path search even on command names with slashes in them.
setopt PATH_DIRS setopt PATH_DIRS
# Make globbing (filename generation) not sensitive to case. # Make globbing (filename generation) not sensitive to case.
unsetopt CASE_GLOB setopt NO_CASE_GLOB
# Don't beep on an ambiguous completion. # Don't beep on an ambiguous completion.
unsetopt LIST_BEEP setopt NO_LIST_BEEP
# #