Merge pull request #102 from zap-zsh/mamaraddio-patch

Massive refactor and a bug fix

.editorconfig

@@ -1,5 +1,5 @@
-[*.*sh]
-shell_variant = bash
+[*.zsh]
+shell_variant = zsh
 indent_style = space
 indent_size = 4
 space_redirects = true

README.md

@@ -1,4 +1,3 @@
-
 <div align="center">
 
 ![zap_logo](https://user-images.githubusercontent.com/29136904/202043505-8fda8d1e-3669-463b-a0c9-38c367ffb753.png)
@@ -7,7 +6,6 @@
 
 ---
 
-
 <div align="center">
 
 <p>
@@ -43,15 +41,17 @@
 ## Install
 
 ```sh
-sh <(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.sh)
+zsh <(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.zsh)
 ```
-    
-To install a specific branch of a plugin, you can pass the `--branch` flag to the install.sh script, followed by the name of the branch you want to install:
+
+To install a specific branch of Zap, you can pass the `--branch` flag to the `install.zsh` script, followed by the name of the branch you want to install:
 
 ```sh
-sh <(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.sh) --branch release-0.1
+zsh <(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.zsh) --branch release-0.1
 ```
 
+**Zap works on Linux, macOS, Windows (within WSL), Android (within Termux)**
+
 ## Example usage
 
 Add the following to your `.zshrc`
@@ -60,7 +60,9 @@ Add the following to your `.zshrc`
 # Example install plugins
 plug "zap-zsh/supercharge"
 plug "zsh-users/zsh-autosuggestions"
-plug "zsh-users/zsh-syntax-highlighting"
+
+#Example plugin pinned to specifc commit or branch, just pass the git reference
+plug "zsh-users/zsh-syntax-highlighting" "122dc46"
 
 # Example theme
 plug "zap-zsh/zap-prompt"
@@ -69,20 +71,32 @@ plug "zap-zsh/zap-prompt"
 plug "esc/conda-zsh-completion"
 ```
 
+You can also use `Zap` to source your custom files, like:
+
+```sh
+plug "${ZDOTDIR:-$HOME}/aliases"
+```
+
+:warning:_In this case the file has to be present in your system and the argument passed to `plug` has to be a file descriptor that points to a regular file. This means you actually need to specify the path to the file (absolute or using environment variables like shown above) and, if the file has an extension you must type it._<br>
+For more information about that, take a look at [this issue](https://github.com/zap-zsh/zap/issues/88)
+
+Is possible to call `plug` in any interactive shell session to source a file or to download and source a plugin for that particular session.<br>
+:warning: If you call `plug` outside your `.zshrc` file, the plugin you sourced will not be sourced at the next shell reload.
+
 ## Commands
 
 Zap provided commands for updating and cleaning up plugins
 
 - To update plugins or Zap:
 
   ```sh
-  zap --update
+  zap update
   ```
 
 - To remove plugins you are no longer using:
 
   ```sh
-  zap --clean
+  zap clean
   ```
 
 ## Uninstall

completion/_zap

@@ -1,7 +1,9 @@
 #compdef zap
 
-_arguments -C -s \
-  "(-)"{-h,--help}"[Show help information]" \
-  "(-)"{-v,--version}"[Show version information]" \
-  "(-)"{-u,--update}"[Update plugins]" \
-  "(-)"{-c,--clean}"[Remove unused plugins]" \
+local -a subcmds=(
+	"clean:Remove unused plugins"
+	"help:Show help informations"
+	"update:Update plugins"
+	"version:Show version information"
+)
+_describe 'zap' subcmds

install.zsh

@@ -0,0 +1,28 @@
+#!/usr/bin/env zsh
+
+main() {
+    local ZAP_DIR="$HOME/.local/share/zap"
+    local ZSHRC="${ZDOTDIR:-$HOME}/.zshrc"
+    [[ $1 == "--branch" || $1 == "-b" && -n $2 ]] && local BRANCH="$2"
+
+    # check if ZAP_DIR already exists
+    [[ -d "$ZAP_DIR" ]] && { echo "Zap is already installed in '$ZAP_DIR'!" && read -q "res?Reinstall Zap? [y/N] "; echo "" }
+    [[ "$res" == "y" ]] && { echo "Reinstalling Zap..." && rm -rf "$ZAP_DIR" } || return 0
+
+    git clone -b "${BRANCH:-master}" https://github.com/zap-zsh/zap.git "$ZAP_DIR" > /dev/null 2>&1 || { echo "❌ Failed to install Zap" && return 2 }
+    mkdir -p "$ZAP_DIR/plugins"
+
+# @formatter:off
+	if ! grep -q '[ -f "$HOME/.local/share/zap/zap.zsh" ] && source "$HOME/.local/share/zap/zap.zsh"' "$ZSHRC"; then
+		sed -i.old '1 i\
+[ -f "$HOME/.local/share/zap/zap.zsh" ] && source "$HOME/.local/share/zap/zap.zsh"' "$ZSHRC"
+	fi
+# @formatter:on
+
+    echo " Zapped"
+    return 0
+}
+
+main $@
+
+# vim: ft=zsh ts=4 et