dev.sh

#!/bin/sh

script_dir="$(
	cd "$(dirname "$0")"
	pwd -P
)"
cd "$script_dir"
if [ ! -f shellutil/shellutil.sh ]; then
	git submodule update --init
fi
# shellcheck source=shellutil/mainutil.sh
. shellutil/mainutil.sh
# shellcheck source=shellutil/shellutil.sh
. shellutil/shellutil.sh
# shellcheck source=shellutil/updateutil.sh
. shellutil/updateutil.sh
# set -o xtrace

docker_image=utiljs-dev:0.41.3
npm_dev_globals='eslint@8.39.0
jsdoc@4.0.2
jsdoc-to-markdown@8.0.0
npm-check-updates@16.10.9
prettier@2.8.7
'
npm_global=npm@9.6.5
npm_globals='@babel/cli@7.21.0
@babel/core@7.21.4
lerna@6.6.1
mocha@10.2.0
nyc@15.1.0
'

audit() {
	npm audit
	# We cannot run audit in subpackages without a package-lock.json.
	npx lerna exec "npm install --package-lock-only --save-exact"
	npx @util.js/node-lerna
	# shellcheck disable=SC2046
	rm $(find packages -name package-lock.json)
}

build() {
	clean
	execute_babel
}

clean() {
	git clean -fdx --exclude "node_modules"
}

execute_babel() {
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		printf "\033[1m%s\033[0m ... " "$2"
		babel \
			"packages/$2/lib" \
			--out-dir "packages/$2/dist"
		return $?
	fi

	# shellcheck disable=SC2039
	local packages
	packages='arrays
emails
errors
jquery
numbers
objects
privates
promises
strings
'

	for package in $packages; do
		printf "\033[1m%s\033[0m ... " "utiljs-$package"
		babel \
			"packages/utiljs-$package/lib" \
			--out-dir "packages/utiljs-$package/dist"
	done
}

execute_docker() {
	# https://stackoverflow.com/a/30543453
	if [ "$(docker images -q $docker_image 2>/dev/null)" = "" ]; then
		cp dev.sh docker
		cp -r shellutil docker/shellutil
		cd docker
		if ! docker build --platform linux/arm64/v8 --tag $docker_image .; then
			exit $?
		fi
		if ! docker build --platform linux/amd64 --tag $docker_image-amd64 .; then
			exit $?
		fi
		rm -rf shellutil
		rm -rf dev.sh
	fi

	# We mount /tmp because of the following error:
	# ~/utiljs $ ./scripts/jsdoc2md.sh
	# /home/node/utiljs/node_modules/mkdirp2/index.js:87
	#           throw err0
	#           ^
	#
	# Error: EROFS: read-only file system, mkdir '/tmp/jsdoc-api'
	#     at Object.mkdirSync (fs.js:753:3)
	# ...

	# /home/node/.gnupg cannot be read-only because of the following error:
	# ~/utiljs $ git commit
	# error: gpg failed to sign the data
	# fatal: failed to write commit object

	# IP, DISPLAY, and /tmp/.X11-unix are for gitk. See shellutil/git.sh.
	export IP
	IP="$(ifconfig en0 | grep inet | awk '$1=="inet" {print $2}')"
	xhost + "$IP"

	# shellcheck disable=SC2068
	docker run \
		--cap-drop=ALL \
		--cpu-shares=1024 \
		--env DISPLAY="$IP":0 \
		--interactive \
		--memory 1.5G \
		--name utiljs-dev \
		--pids-limit 100 \
		--read-only \
		--restart=no \
		--rm \
		--security-opt=no-new-privileges:true \
		--tty \
		--volume /home/node \
		--volume /tmp/.X11-unix:/tmp/.X11-unix \
		--volume ~/.gnupg:/home/node/.gnupg \
		--volume ~/.ssh:/home/node/.ssh:ro \
		--volume "$script_dir":/home/node/utiljs \
		--volume /tmp \
		--workdir /home/node/utiljs \
		"$docker_image" "$@"
}

execute_eslint() {
	# shellcheck disable=SC2039
	local path
	path="."
	# shellcheck disable=SC2039
	local prefix
	prefix=""
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		path="./packages/$2"
		prefix="\./packages/$2/"
	fi

	mkdir -p target

	find "$path" -type f |
		grep -E "^$prefix.*\.js$" |
		grep -E -v "^.*/(dist|node_modules|target)/.*$" \
			>target/eslint.txt

	sort target/eslint.txt -o target/eslint.txt

	while read -r in; do
		printf '%s\n' "$in"
		eslint --fix "$in" || true
	done <target/eslint.txt

	rm -rf target/eslint.txt
}

execute_jsdoc() {
	if [ -d "target/jsdoc" ]; then
		rm -rf target/jsdoc
	fi

	# shellcheck disable=SC2039
	local path
	path="."
	# shellcheck disable=SC2039
	local prefix
	prefix=""
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		path="./packages/$2"
		prefix="\./packages/$2/"
	fi

	# shellcheck disable=SC2046
	jsdoc \
		--destination target/jsdoc \
		$(find "$path" -type f |
			grep -E "^$prefix.*\.js$" |
			grep -E -v "^.*/(dist|node_modules|target)/.*$")
}

execute_jsdoc2md() {
	if [ -d "target/jsdoc2md" ]; then
		rm -rf target/jsdoc2md
	fi

	mkdir -p target/jsdoc2md

	# shellcheck disable=SC2039
	local path
	path="."
	# shellcheck disable=SC2039
	local prefix
	prefix=""
	# shellcheck disable=SC2039
	local filename
	filename="jsdoc2md.md"
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		path="./packages/$2"
		prefix="\./packages/$2/"
		filename="$2.md"
	fi

	# shellcheck disable=SC2046
	jsdoc2md \
		$(find "$path" -type f |
			grep -E "^$prefix.*\.js$" |
			grep -E -v "^.*/(dist|node_modules|target)/.*$") \
		>"target/jsdoc2md/$filename"
}

execute_mocha() {
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		cd "packages/$2"
		nyc \
			--reporter html \
			--reporter text \
			--report-dir target/coverage \
			mocha
	else
		if [ -n "${1:-}" ]; then
			shift
		fi
		cd packages
		for package in */; do
			cd "$package"
			if [ -d "test" ]; then
				printf '%s\n' "Visting $package"
				nyc \
					--reporter html \
					--reporter text \
					--report-dir target/coverage \
					mocha "$@"
			else
				printf '%s\n' "Skipping $package"
				echo
			fi
			cd ..
		done
	fi
}

execute_prettier() {
	# shellcheck disable=SC2039
	local path
	path="."
	# shellcheck disable=SC2039
	local prefix
	prefix=""
	if [ -n "${2:-}" ] && [ -d "packages/$2" ]; then
		path="./packages/$2"
		prefix="\./packages/$2/"
	fi

	mkdir -p target

	find "$path" -type f |
		grep -E "^(\./\.babelrc|$prefix.*\.(css|js|json|jsx|md|scss))$" |
		grep -E -v "^.*/(.nyc_output|dist|node_modules|target)/.*$" |
		grep -E -v "^.*/package-lock\.json$" |
		grep -E -v "^\./lerna\.json$" \
			>target/prettier.txt

	sort target/prettier.txt -o target/prettier.txt

	while read -r in; do prettier --write "$in"; done <target/prettier.txt

	rm -rf target/prettier.txt
}

install() {
	lerna bootstrap --force-local --hoist -- --save-exact
}

install_dev_globals() {
	# We do not need these global packages to run in GitHub Actions.
	# shellcheck disable=SC2086
	npm install --global $npm_dev_globals
}

install_globals() {
	# Including @babel/core prevents the following warning:
	# npm WARN @babel/cli@ 7.2.3 requires a peer of @babel/core@^7.0.0-0 but
	# none is installed. You must install peer dependencies yourself.

	# shellcheck disable=SC2086
	npm install --global $npm_global
	# shellcheck disable=SC2086
	npm install --global $npm_globals
}

main() {
	# shellcheck disable=SC2039
	local command_help
	command_help='audit - Run audit in all packages.
babel - Run babel on certain (mostly non-node) packages.
build - Run clean and babel.
clean - git clean -fdx --exclude "node_modules"
docker - Develop inside a Docker container.
docker-update - Run update using the latest creemama/shellutil-dev:lts-alpine Docker image.
docker-update-dockerfile - Run Docker to update the shellutil-dev image used in docker/Dockerfile.
eslint - Run eslint in all packages.
git - Run git setting GPG_TTY if not already set for signing commits.
gitk - Run gitk.
install - Run install in all packages.
install-dev-globals - Install Node.js globals not needed by CI.
install-globals - Install Node.js globals needed by CI.
jsdoc - Run jsdoc in all packages.
jsdoc2md - Run jsdoc2md in all packages.
mocha - Run mocha/nyc in all packages.
prettier - Run prettier in all packages.
publish - Bump the version number and publish all packages to npm.
shell-format - Format shell scripts and run shellcheck.
test - Run build and mocha for CI.
update - Check and update project dependencies.
update-dockerfile - Update the shellutil-dev image used in docker/Dockerfile.'
	# shellcheck disable=SC2039
	local commands
	commands="$(main_extract_commands "$command_help")"
	# shellcheck disable=SC2086
	if [ -z "${1:-}" ]; then
		main_exit_with_no_command_error "$command_help"
	elif [ "$1" = "$(arg 0 $commands)" ]; then
		audit
	elif [ "$1" = "$(arg 1 $commands)" ]; then
		execute_babel "$@"
	elif [ "$1" = "$(arg 2 $commands)" ]; then
		build
	elif [ "$1" = "$(arg 3 $commands)" ]; then
		clean
	elif [ "$1" = "$(arg 4 $commands)" ]; then
		shift
		execute_docker "$@"
	elif [ "$1" = "$(arg 5 $commands)" ]; then
		run_docker_update
	elif [ "$1" = "$(arg 6 $commands)" ]; then
		run_docker_update_dockerfile
	elif [ "$1" = "$(arg 7 $commands)" ]; then
		execute_eslint "$@"
	elif [ "$1" = "$(arg 8 $commands)" ]; then
		shift
		shellutil/git.sh git "$@"
	elif [ "$1" = "$(arg 9 $commands)" ]; then
		shift
		shellutil/git.sh gitk "$@"
	elif [ "$1" = "$(arg 10 $commands)" ]; then
		install
	elif [ "$1" = "$(arg 11 $commands)" ]; then
		install_dev_globals
	elif [ "$1" = "$(arg 12 $commands)" ]; then
		install_globals
	elif [ "$1" = "$(arg 13 $commands)" ]; then
		execute_jsdoc "$@"
	elif [ "$1" = "$(arg 14 $commands)" ]; then
		execute_jsdoc2md "$@"
	elif [ "$1" = "$(arg 15 $commands)" ]; then
		execute_mocha "$@"
	elif [ "$1" = "$(arg 16 $commands)" ]; then
		execute_prettier "$@"
	elif [ "$1" = "$(arg 17 $commands)" ]; then
		publish
	elif [ "$1" = "$(arg 18 $commands)" ]; then
		shellutil/format.sh shell-format
	elif [ "$1" = "$(arg 19 $commands)" ]; then
		run_test
	elif [ "$1" = "$(arg 20 $commands)" ]; then
		update
	elif [ "$1" = "$(arg 21 $commands)" ]; then
		update_dockerfile
	else
		main_exit_with_invalid_command_error "$1" "$command_help"
	fi
}

publish() {
	# Log into https://www.npmjs.com .

	# To create scoped packages, create an organization at https://www.npmjs.com.

	git clean -f
	clean
	build
	npm login --scope=@util.js
	lerna publish --exact # This command bumps the version number.
}

run_docker_update() {
	execute_docker sh -c './dev.sh update'
}

run_docker_update_dockerfile() {
	docker pull --quiet node:lts-alpine >/dev/null 2>&1
	docker run -it --rm --volume "$(pwd)":/tmp node:lts-alpine /tmp/dev.sh update-dockerfile
}

run_test() {
	execute_mocha
}

update() {
	for package in $npm_dev_globals $npm_global $npm_globals; do
		npm_update_package_version "$(printf %s "$package" | sed -E 's/(.+)@.*/\1/')"
	done
	update_npm_deps
	printf '\n%sDelete the utiljs-dev Docker image or update docker_image= if dev.sh dependencies change.\n\n%s' "$(tbold)" "$(treset)"
}

update_dockerfile() {
	apk_update_node_image_version docker/Dockerfile 's#(FROM creemama/shellutil-dev:).*#\\1%s-alpine%s#'
	printf '\n%sDelete the utiljs-dev Docker image or update docker_image= if docker/Dockerfile changes.\n\n%s' "$(tbold)" "$(treset)"
}

update_npm_deps() {
	npx ncu -u
	cd packages
	for package in */; do
		(
			cd "$package"
			printf '%s\n' "Visting $package"
			npx ncu -u
		)
	done
}

main "$@"