Initial Commit

Added code and updated readme.

README.md

@@ -1,5 +1,48 @@
 # ZshPlug
 
-A simple and naive plugin manager for zsh
+A simple and naive plugin manager for zsh
-
+
-Does what I want and that's probably enough
+Does what I want and that's probably enough
+
+## How it works
+
+Basically it takes an array of plugins.
+Then if they are already installed they are loaded.
+Otherwise the plugin is installed to a known location
+It's a simple system and it works for me.
+
+I'm happy to hear about any improvements that people might have.
+
+### Limitations
+
+Currently ZshPlug can only load plugins from github.
+And only accepts the format `GITHUB_USER/GITHUB_REPO`
+Anything else is likely to cause issues.
+
+## Configuration
+
+There are two environment variables you can use to configure how ZshPlug works
+
+Firstly `$ZSH_PLUG_pluginDir` this is the directory you want your plugins
+installed to
+
+Secondly `$ZSH_PLUG_plugins` this is a "bash style" array of the plugins
+you want installed.
+As an example you could have `$ZSH_PLUG_plugins=("zsh-users/zsh-autosuggestions" "zdharma/fast-syntax-highlighting")`
+
+## How to use
+
+Place `ZshPlug.zsh` into a known location.
+
+edit your `zshrc` and add in your configuration for ZshPlug
+then add a line at the end that sources ZshPlug.
+
+The next time you start your shell it should fire up automatically
+
+### Updating Plugins
+
+To update your installed plugins you just need to run
+`ZSH_PLUG_pluginUpdate`
+And ZshPlug will pull the latest versions for you.
+
+You will need to restart your shell for any changes to take effect

ZshPlug.zsh

@@ -0,0 +1,186 @@
+###############################
+#          ZSH Plug           #
+#             By:             #
+#        sherlock5512         #
+#                             #
+# Simple Naive plugin manager #
+#    It does enough for me    #
+###############################
+
+## Complain if the user is not running zsh
+## First test the $SHELL variable
+if [[ "$SHELL" != "/bin/zsh" ]]; then
+	printf "Your $SHELL variable is set to %s\n" $SHELL >&2
+	printf "This is unexpected (Expected values "/bin/zsh")\n" >&2
+	printf "If you are running zsh and your path is different open a GitHub issue\n" >&2
+	printf "and let me know what Distro you're using and the path to zsh\n" >&2
+	exit 1
+fi
+## Confirm running shell is actually zsh
+runningShell="$(ps -p $$ c -o cmd | tail -n1)"
+if [[ "$runningShell" != "zsh" ]]; then
+	printf "Your $SHELL variable is set to %s\n" $SHELL >&2
+	printf "This is correct However your running shell is %s\n" $runningShell >&2
+	printf "This is unexpected (Expected values "zsh")\n" >&2
+	printf "If zsh is named something different on your system open a GitHub issue\n" >&2
+	printf "and let me know what Distro you are using and the name that zsh has\n"
+	exit 1
+fi
+
+
+###########################
+# Load User Configuration #
+###########################
+
+## Load custom Plugin directory
+## Otherwise use default location
+export pluginDir=${ZSH_PLUG_pluginDir:-$HOME/.local/share/zsh}
+export plugins=${ZSH_PLUG_plugins}
+
+########################
+# FUNCTION DEFINITIONS #
+########################
+
+ZSH_PLUG_pluginTest() {
+## Test if a plugin is installed or not
+## RETURNS
+## 0: Plugin is installed
+## 2: Plugin is not installed
+## 4: Too many Arguments sent
+## 5: No Arguments sent
+	[ -z "$1" ] && return 5
+	[ "$#" -gt "1" ] && return 4
+	[ -d "$pluginDir/$1" ] && return 0
+	return 1
+}
+
+ZSH_PLUG_pluginInstall() {
+## Install Plugin to PluginDir
+## Accepts 1 Argument (Plugin)
+## CURRENTLY NO ERROR HANDLING
+## ALSO DOES NOT HIDE OUTPUT
+	[ $# -eq 0 ] && return 1
+	local plugin="$1"
+	local InstallDir="$pluginDir/$plugin"
+	plugin="$githubPrefix$plugin"
+	git clone "$plugin" "$InstallDir"
+	chmod +X $InstallDir/*.zsh
+	return
+}
+
+ZSH_PLUG_pluginLoad() {
+## Source plugin 
+## Accepts 1 Argument (Plugin)
+## CURRENTLY NO ERROR HANDLING
+## DOES NOT HIDE OUTPUT
+## RELIES ON PLUGINS HAVING A DEFINED FORMAT
+	[ $# -eq 0 ] && return 1
+	local plugin="$1"
+	local InstallDir="$pluginDir/$plugin"
+	source $(find "$InstallDir" -name "*.plugin.zsh")
+	return
+}
+
+ZSH_PLUG_pluginUpdate() {
+## Update all Plugins
+## Should really do one at a time
+## Might not work with new config setup
+	for Plugin in $Plugins; do
+		echo "Updating $Plugin"
+		local InstallDir="$pluginDir/$Plugin"
+		pushd $InstallDir
+		git pull 2> /dev/null
+		popd
+	done
+	echo "Plugins Updated. Please restart zsh to use them"
+}
+
+Plug() {
+	#Test for plugin directory and make if needed
+	[ ! -d "$pluginDir" ] && { echo "Plugin directory doesn't exist making it now"; mkdir -p "$pluginDir"; }
+	# test for git as needed to get plugins
+	command -v git > /dev/null || { echo "Git is not installed" >&2 ; return 1; }
+
+	## No need to check if plugins has content since if there are no plugins this does not run anythinh
+
+	for Plugin in $Plugins; do
+		pluginTest "$Plugin"
+		local exitcode="$?"
+		case $exitcode in
+			0)
+				## plugin installed
+				echo "Loading $Plugin"
+				pluginLoad "$Plugin"
+				;;
+			1)
+				## plugin not installed
+				echo "Installing $Plugin"
+				pluginInstall "$Plugin"
+				echo "Loading $Plugin"
+				pluginLoad "$Plugin"
+				;;
+			4)
+				## Too many args to pluginTest
+				echo "Something is wrong here..." >&2
+				echo "Too many args to pluginTest" >&2
+				break
+				;;
+			5)
+				## No args to pluginTest
+				echo "Something is wrong here..." >&2
+				echo "No args to pluginTest" >&2
+				break
+				;;
+			*)
+				echo "Something is really wrong..." >&2
+				echo "Exit Code Was $exitcode" >&2
+				echo "Maybe you should start an issue"
+				break
+				;;
+		esac
+	done
+}
+
+echo "Running ZshPlug"
+Plug
+
+## Clean up non-required variables and functions
+
+unset -f Plug
+unset -f ZSH_PLUG_pluginInstall
+unset -f ZSH_PLUG_pluginTest
+unset -f ZSH_PLUG_pluginLoad
+unset githubPrefix
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+