refactor: Everything

Since I've made up my mind on subcommand naming, this finalizes that.
This also just fixes up a lot of small (and large) things, making the UX
significantly better

Author: hyperupcall

Bakefile.sh

@@ -1,5 +1,9 @@
 # shellcheck shell=bash
 
+task.docs() {
+	shdoc < './pkg/share/lib.sh' > './docs/api.md'
+}
+
 task.test() {
 	bats "$@" ./tests
 }

README.md

@@ -7,15 +7,15 @@ An elegantly minimal solution for Git hooks
 ```sh
 cd some-git-repo-that-uses-hookah
 hookah init
-# And you're done!
+# Boom! You're done
 ```
 
-- To update internal Hookah scripts, simply run `init` again (a message will be printed if anything has been updated)
-
 ## Features
 
+- Simply run `init` again to update the Hookah scripts (a message will be printed if anything has been updated)
 - Has `check` subcommand to test if scripts will work _before_ running Git
 - Has `create` subcommand to list all templates and how they work
+- _No configuration_
 
 ## Installation
 

basalt.toml

@@ -7,7 +7,7 @@ authors = ['Edwin Kofler <[email protected]>']
 description = 'A hook helper for Git'
 
 [run]
-dependencies = ['https://github.com/hyperupcall/[email protected]']
+dependencies = ['https://github.com/hyperupcall/[email protected]', 'https://github.com/hyperupcall/[email protected]']
 binDirs = []
 sourceDirs = ['pkg/src/util', 'pkg/src/commands']
 builtinDirs = []

docs/api.md

@@ -0,0 +1,42 @@
+# lib.sh
+
+## Overview
+
+Function library for Git hooks configured with Hookah
+
+## Index
+
+* [hookah.init()](#hookahinit)
+* [hookah.run()](#hookahrun)
+* [hookah.run_allow_fail()](#hookahrun_allow_fail)
+* [hookah.is_ci()](#hookahis_ci)
+
+### hookah.init()
+
+initiates the environment, sets up stacktrace printing on 'ERR' trap,
+and sets the directory to the root of the Git repository
+
+_Function has no arguments._
+
+### hookah.run()
+
+Prints a command before running it
+
+### hookah.run_allow_fail()
+
+Prints a command before running it. If the command fails, print a message,
+but do not abort execution
+
+### hookah.is_ci()
+
+Tests if currently in CI
+
+#### Variables set
+
+* **REPLY** (Current): provider for CI
+
+#### Exit codes
+
+* **0**: If in CI
+* **1**: If not in CI
+

pkg/share/lib.sh

@@ -30,6 +30,15 @@ hookah.init() {
 		return 1
 	fi
 
+	# Prevent bugs like:
+	# - https://github.com/typicode/husky/issues/627
+	# - https://github.com/yarnpkg/yarn/issues/743
+	# - https://github.com/typicode/husky/issues/850
+	# - https://github.com/yarnpkg/yarn/issues/2998
+	if command -v &>/dev/null 'winpty' && [ -t 1 ]; then
+		exec </dev/tty
+	fi
+
 	# TODO print large
 	printf '%s\n' "Hookah: Running ${BASH_SOURCE[1]##*/}"
 }
@@ -48,6 +57,95 @@ hookah.run_allow_fail() {
 	fi
 }
 
+# @description Tests if currently in CI
+# @exitcode 0 If in CI
+# @exitcode 1 If not in CI
+# @set REPLY Current provider for CI
+hookah.is_ci() {
+	unset -v REPLY; REPLY=
+
+	# See https://github.com/watson/ci-info/blob/master/vendors.json
+	# node -e $'for (const ci of JSON.parse(require("fs").readFileSync("vendors.json"))) { console.info(`\\telif [[ -v \047${ci.env}\047 ]]; then\\n\\t\\tREPLY=\047${ci.name}\047`) }'
+
+	if [[ -v 'APPVEYOR' ]]; then
+		REPLY='AppVeyor'
+	elif [[ -v 'SYSTEM_TEAMFOUNDATIONCOLLECTIONURI' ]]; then
+		REPLY='Azure Pipelines'
+	elif [[ -v 'AC_APPCIRCLE' ]]; then
+		REPLY='Appcircle'
+	elif [[ -v 'bamboo_planKey' ]]; then
+		REPLY='Bamboo'
+	elif [[ -v 'BITBUCKET_COMMIT' ]]; then
+		REPLY='Bitbucket Pipelines'
+	elif [[ -v 'BITRISE_IO' ]]; then
+		REPLY='Bitrise'
+	elif [[ -v 'BUDDY_WORKSPACE_ID' ]]; then
+		REPLY='Buddy'
+	elif [[ -v 'BUILDKITE' ]]; then
+		REPLY='Buildkite'
+	elif [[ -v 'CIRCLECI' ]]; then
+		REPLY='CircleCI'
+	elif [[ -v 'CIRRUS_CI' ]]; then
+		REPLY='Cirrus CI'
+	elif [[ -v 'CODEBUILD_BUILD_ARN' ]]; then
+		REPLY='AWS CodeBuild'
+	elif [[ -v 'CF_BUILD_ID' ]]; then
+		REPLY='Codefresh'
+	elif [[ -v '[object Object]' ]]; then
+		REPLY='Codeship'
+	elif [[ -v 'DRONE' ]]; then
+		REPLY='Drone'
+	elif [[ -v 'DSARI' ]]; then
+		REPLY='dsari'
+	elif [[ -v 'EAS_BUILD' ]]; then
+		REPLY='Expo Application Services'
+	elif [[ -v 'GITHUB_ACTIONS' ]]; then
+		REPLY='GitHub Actions'
+	elif [[ -v 'GITLAB_CI' ]]; then
+		REPLY='GitLab CI'
+	elif [[ -v 'GO_PIPELINE_LABEL' ]]; then
+		REPLY='GoCD'
+	elif [[ -v 'LAYERCI' ]]; then
+		REPLY='LayerCI'
+	elif [[ -v 'HUDSON_URL' ]]; then
+		REPLY='Hudson'
+	elif [[ -v 'JENKINS_URL,BUILD_ID' ]]; then
+		REPLY='Jenkins'
+	elif [[ -v 'MAGNUM' ]]; then
+		REPLY='Magnum CI'
+	elif [[ -v 'NETLIFY' ]]; then
+		REPLY='Netlify CI'
+	elif [[ -v 'NEVERCODE' ]]; then
+		REPLY='Nevercode'
+	elif [[ -v 'RENDER' ]]; then
+		REPLY='Render'
+	elif [[ -v 'SAILCI' ]]; then
+		REPLY='Sail CI'
+	elif [[ -v 'SEMAPHORE' ]]; then
+		REPLY='Semaphore'
+	elif [[ -v 'SCREWDRIVER' ]]; then
+		REPLY='Screwdriver'
+	elif [[ -v 'SHIPPABLE' ]]; then
+		REPLY='Shippable'
+	elif [[ -v 'TDDIUM' ]]; then
+		REPLY='Solano CI'
+	elif [[ -v 'STRIDER' ]]; then
+		REPLY='Strider CD'
+	elif [[ -v 'TASK_ID,RUN_ID' ]]; then
+		REPLY='TaskCluster'
+	elif [[ -v 'TEAMCITY_VERSION' ]]; then
+		REPLY='TeamCity'
+	elif [[ -v 'TRAVIS' ]]; then
+		REPLY='Travis CI'
+	elif [[ -v 'NOW_BUILDER' ]]; then
+		REPLY='Vercel'
+	elif [[ -v 'APPCENTER_BUILD_ID' ]]; then
+		REPLY='Visual Studio App Center'
+	else
+		return 1
+	fi
+}
+
 # @description Test whether color should be outputed
 # @exitcode 0 if should print color
 # @exitcode 1 if should not print color

pkg/src/bin/hookah.sh

@@ -1,7 +1,14 @@
 # shellcheck shell=bash
 
+global_trap_exit() {
+	local exit_code=$?
+	core.stacktrace_print
+	exit $exit_code
+}
+
 main.hookah() {
-	local subcommand="$1"
+	core.init
+	core.trap_add 'global_trap_exit' ERR
 
 	local arg=
 	for arg; do case $arg in
@@ -11,14 +18,15 @@ main.hookah() {
 		;;
 	esac done; unset -v arg
 
+	local subcommand="$1"
 	case $subcommand in
 	init)
 		if ! shift; then print.die 'Failed shift'; fi
 		hookah-init "$@"
 		;;
-	create)
+	new)
 		if ! shift; then print.die 'Failed shift'; fi
-		hookah-create "$@"
+		hookah-new "$@"
 		;;
 	check)
 		if ! shift; then print.die 'Failed shift'; fi

pkg/src/commands/hookah-check.sh

@@ -21,6 +21,8 @@ hookah-check() {
 			print.hint "You may need to \`chmod +x '$hookFile'\`"
 		fi
 
+		# TODO: Instead of disallow-list type fltering, create an allow-list of
+		# valid script/hook names
 		if [[ $line == *.* ]]; then
 			print.warn "File should not have an excention"
 			print.hint "For example, the hook 'pre-commit' should be at './hooks/pre-commit'"
@@ -51,4 +53,6 @@ hookah-check() {
 		# Do not place anything under here unless 'continue's are placed in the
 		# previous if-elif branches
 	done; unset -v hookFile
+
+	printf '%s\n' 'Done.'
 }

pkg/src/commands/hookah-create.sh renamed to pkg/src/commands/hookah-new.sh

@@ -1,12 +1,19 @@
 # shellcheck shell=bash
 
-hookah-create() {
+hookah-new() {
+	local hook_name="$1"
+
 	local -r hooks_dir='./.hooks'
+	local -r hookah_dir="$hooks_dir/.hookah"
 
 	if ! util.cd_to_closest_git_repo; then
 		print.die "Failed to 'cd' to closest Git repository"
 	fi
 
+	if [ ! -d "$hookah_dir" ]; then
+		print.die "Hookah directory does not exist. Did you forget to run 'hookah init'?"
+	fi
+
 	# post-update undocumented?
 	# TODO: figure out where these hooks come from: https://github.com/rycus86/githooks#supported-hooks
 	local -Ar hooks=(
@@ -35,32 +42,37 @@ hookah-create() {
 		[post-receive]=
 	)
 
-	printf '%s\n' "Hooks: "
-	local hook=
-	for hook in "${!hooks[@]}"; do
-		printf '%s\n' "   $hook: ${hooks[$hook]}"
-	done; unset -v hook
-
-	printf '%s' 'Choose: '
-	read -re
+	if [ -z "$hook_name" ]; then
+		printf '%s\n' "Hooks: "
+		local hook=
+		for hook in "${!hooks[@]}"; do
+			printf '%s\n' "   $hook: ${hooks[$hook]}"
+		done; unset -v hook
 
-	local user_hook="$REPLY"
-	# TODO
-	if [[ ${!hooks[*]} != *"$user_hook"* ]]; then
-		print.die "Did not enter valid commit hook"
+		printf '%s' 'Choose: '
+		read -re hook_name
 	fi
 
-	if [ -z "$user_hook" ]; then
+	if [ -z "$hook_name" ]; then
 		print.die "Cannot be empty"
 	fi
 
-	# TODO: hardcoded lib.sh
-	cat > "$hooks_dir/$user_hook.sh" <<-"EOF"
+	local is_valid_hook='no' valid_hook_name=
+	for valid_hook_name in "${!hooks[@]}"; do
+		if [ "$valid_hook_name" = "$hook_name" ]; then
+			is_valid_hook='yes'
+		fi
+	done
+	if [ "$is_valid_hook" != 'yes' ]; then
+		print.die "Did not enter valid commit hook"
+	fi
+
+	cat > "$hooks_dir/$hook_name" <<-"EOF"
 	#!/usr/bin/env bash
 
 	source "${0%/*}/.hookah/lib.sh"
 	hookah.init
 
 	EOF
-	chmod +x "$hooks_dir/$user_hook.sh"
+	chmod +x "$hooks_dir/$hook_name"
 }

pkg/src/util/util.sh

@@ -39,13 +39,18 @@ util.run() {
 util.show_help() {
 	cat <<"EOF"
 Usage:
-   hookah [--help] <subcommand> [args...]
+  hookah [--help] <subcommand> [args...]
+
 Subcommands:
-   setup
-      Setup the hooks directory if it doesn't exist and execute sanity checks against the hooks (is readable, executable, shebangs, etc.)
-   check
-      Checks to ensure that the hooks directory is setup correctly
-   create
-      Menu to create one of the various Git hooks
+  init
+    Initializes the hooks directory or updates it if it already exists
+
+  new
+    Opens a menu for creating a new Git hook. Once chosen, a corresponding
+    minimal hook template will be created in the hooks directory
+
+  check
+    Run sanity checks in the hooks directory. It ensures the scripts are
+    readable, executable, has the proper shabangs, and other things
 EOF
 }

tests/hookah-check.bats

@@ -0,0 +1,3 @@
+#!/usr/bin/env bats
+
+load './util/init.sh'