Streamlining Setup: Introducing a Makefile for Effortless Dependency Management and Installation

[ashish-kus]

Wanted to contribute to this awesome project. I've replaced the install and uninstall scripts with a MAKEFILE to handle dependency checks and installations, ensuring a smoother user experience and for better management. I've made some updates to the README to reflect the changes I've introduced.

Installation: make install
Uninstallation: make uninstall

Please review and share your thoughts. Thanks!

# Define the dependencies
DEPENDENCIES = chafa convert jq curl

# Define the installation directories
INSTALL_DIR = /usr/local

# Installation instructions
install: check_dependencies
	@echo "\033[1;32m Installing... \033[0m"
	sudo mkdir -pv $(INSTALL_DIR)
	sudo cp -rv bin $(INSTALL_DIR)
	sudo cp -rv share $(INSTALL_DIR)
	@echo "Installation complete."
	@echo "updating your $PATH variable"

	@echo -e "\033[1;32m DONE \033[0m pokeshell is now installed"
	@echo -e "\033[1;32m RELOAD YOUR SHELL BEFORE USING POKESHELL \033[0m"

# Uninstallation instructions
uninstall:
	@echo "Uninstalling..."

	@echo "Removing files"	 
	sudo rm -rf $(INSTALL_DIR)/bin/pokeshell
	@echo "Removing Complitions"
	sudo rm -rf $(INSTALL_DIR)/share/bash-completion/completions/pokeshell

	@echo -e "Removing directories "
	sudo rmdir -v $(INSTALL_DIR)/bin
	sudo rmdir -v $(INSTALL_DIR)/share/bash-completion/completions
	sudo rmdir -v $(INSTALL_DIR)/share/bash-completion

	@echo -e "\033[1;31m pokeshell uninstalled \033[1;32m OK \033[0m"

# Target to check dependencies
check_dependencies:
	@echo "Checking dependencies..."
	@for dep in $(DEPENDENCIES); do \
		command -v $$dep >/dev/null 2>&1 || { echo "$$dep is required but not installed. Aborting."; exit 1; }; \
	done


.PHONY: install uninstall check_dependencies

[acxz]

Hello @ashish-kus

First off I apologize for betting back to this an entire year after your PR. I hope you have had a pretty fun year since you last worked on this!

When I was first thinking about how to best provide un/installation for pokeshell (and in general small shell scripts, like it) make is definitely a solution that crossed my mind. I don't have much experience with writing Makefiles directly, and I know Makefiles can get hairy and complex; but this is a simple enough application that having ubiquitous install commands (that can be "easily" implemented) like make install, make uninstall can be valuable. Especially a configurable INSTALL_DIR from the command line.

I eventually decided on just a quick and clean un/install.sh scripts. Less code for me to deal with.

This is great work, however, and I see you are doing this correctly (i.e. using .PHONY). A part of me wants to add this in and another part wants to keep it out. Another idea to keep the flexibility here is to treat the Makefile as a wrapper. In other words, instead of removing install.sh and uninstall.sh, have make call those scripts in its respective install and uninstall targets. This will keep make as a wrapper layer that can be much easier to maintain, instead of having it replace the existing un/install.sh scripts.

What do you think about such a solution?

By the way, I just remembered that just is a thing now that I came across a while back. This seems to be a better solution than make and is right up the ally for this problem, imo.

@ashish-kus update. Added a justfile, still need to incorporate checking for dependencies, and perphaps adding a line in ~/.profile, which appends the install_dir to the $PATH and remove that line in ~/.profile during uninstall. By the way take a look at basher.

[acxz]

This script is not updating the $PATH as far as I can tell, please remove line 14. Since it is not updating the $PATH, reloading will not do anything. pokeshell will work as long as $(INSTALL_DIR)/bin is on path.

[acxz]

Spelling

[acxz]

the -r flag is doing nothing here as these are files
the -f flag is not needed anyway either I think, can you explain where the current invocation will fail (just rm) compared to rm -f?
Also I'd like to keep the -v flag for being transparent with users. Shellscripts shouldn't be trusted willy-nilly from the internet and -v makes what we are removing on their filesystem clear.

[acxz]

spelling

[acxz]

spelling, use backticks around $PATH.

[acxz]

remove the example here, that is what --help is for.

[acxz]

convert should be imagemagick I believe.

[acxz]

Are sudo commands necessary inside the Makefile? I believe these should be left out and if the INSTALL_DIR requires admin privileges then the user can call sudo make install/uninstall, right?