#!/usr/bin/env bash # Make sure the current directory is the location of this script to simplify matters cd "$(dirname $(readlink -f $0))"; ################ ### Settings ### ################ # The name of this project project_name="powahroot"; # The path to the lantern build engine git submodule lantern_path="./lantern-build-engine"; ### # Custom Settings ### # Put any custom settings here. docs_output_folder="./docs"; ############################################################################### # Check out the lantern git submodule if needed if [ ! -f "${lantern_path}/lantern.sh" ]; then git submodule update --init "${lantern_path}"; fi source "${lantern_path}/lantern.sh"; if [[ "$#" -lt 1 ]]; then echo -e "${FBLE}${project_name}${RS} build script"; echo -e " by Starbeamrainbowlabs"; echo -e "${LC}Powered by the lantern build engine, v${version}${RS}"; echo -e ""; echo -e "${CSECTION}Usage${RS}"; echo -e " ./build ${CTOKEN}{action}${RS} ${CTOKEN}{action}${RS} ${CTOKEN}{action}${RS} ..."; echo -e ""; echo -e "${CSECTION}Available actions${RS}"; echo -e " ${CACTION}setup${RS} - Perform initial setup"; echo -e " ${CACTION}docs${RS} - Render the API docs to HTML"; echo -e " ${CACTION}docs-watch${RS} - Auto-update the docs on source file modification"; echo -e " ${CACTION}archive${RS} - Create an archive of CI artifacts"; echo -e " ${CACTION}ci${RS} - Do CI tasks"; echo -e ""; exit 1; fi ############################################################################### task_setup() { task_begin "Checking environment"; check_command git true; check_command node true; check_command npm true; check_command jq true; task_end $?; task_begin "Initialising submodules"; git submodule update --init; task_end $? "Failed to initialise submodules"; task_begin "Installing dependencies"; npm install; task_end $? "Failed to install dependencies"; } task_docs() { task_begin "Rendering API docs"; subtask_begin "Calling 'documentation'"; node_modules/.bin/documentation build --github --output "${docs_output_folder}" --format html --favicon "logo.png" "$(jq --raw-output .main >"$(find "${docs_output_folder}" -iname "*.css" -print -quit)"; subtask_end $? "Failed to apply additional CSS"; task_end $? "Failed to render API docs"; } task_docs-watch() { check_command inotifywait; set_title "Docs Watcher"; echo -e "Watching for changes."; while :; do # : = infinite loop # Wait for an update # inotifywait's non-0 exit code forces an exit for some reason :-/ inotifywait -qr --event modify --format '%:e %f' $(find . -iname "*.mjs" -not -path "./node_modules/*") ./docs.css; # Rebuild the docs # This exits on error because of stage_end - we need add a way to make the exit on non-zero optional to lantern stage_begin "Rebuilding docs"; tasks_run docs; stage_end $?; done } task_archive() { task_end 1 "Error: Not implemented"; } task_deploy() { task_end 1 "Error: Not implemented" } task_ci() { tasks_run setup docs archive deploy; } ############################################################################### tasks_run $@;