make-site.sh

#!/bin/bash
# cSpell:ignore autoprefixer docsy postcss themesdir github oneline
set -eo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

DEPS="autoprefixer postcss-cli"
DOCSY_REPO_DEFAULT="google/docsy"
DOCSY_REPO=$DOCSY_REPO_DEFAULT
DOCSY_VERS=""
DOCSY_SRC="NPM"
FORCE_DELETE=false

: "${HUGO:=npx hugo}"

SITE_NAME="test-site"
THEMESDIR="node_modules"
VERBOSE=1
OUTPUT_REDIRECT="" # set to non-empty when -q is used

# Parsed HUGO command (supports: HUGO="npx --yes hugo-extended" etc.)
HUGO_CMD=()

function _usage() {
  cat <<EOS
Usage: $(basename "$0") [options]

  Creates a Docsy-themed site under SITE_NAME using the Hugo new command.
  Docsy is fetched as an NPM package from $DOCSY_REPO in GitHub,
  unless the -l or -s HUGO_MOD flags are used.

  -f            Force delete SITE_NAME if it exists before recreating it
  -h            Output this usage info
  -l PATH       Use local Docsy from PATH. Default: '$THEMESDIR'
  -n SITE_NAME  Name of directory to create for the Hugo generated site.
                Default: '$SITE_NAME'
  -q            Run a bit more quietly.
  -r REPO       GitHub org+repo to fetch Docsy from.
                Format: GITHUB_USER/DOCSY_REPO. Default: $DOCSY_REPO_DEFAULT
  -s MOD_OR_PKG Docsy source: from a Hugo module or NPM package named '$DOCSY_REPO', where
                MOD_OR_PKG is NPM or HUGO_MODULE (HUGO for short). Default: $DOCSY_SRC
  -v VERS       Docsy Hugo module or NPM package version. Default: '$DOCSY_VERS'.
                Examples for Hugo modules: v1.1.1, some-branch-name
                Examples for NPM: semver:1.1.1, some-branch-name
EOS
}

function usage() {
  local status=${1:-0}
  _usage 1>&2
  exit "$status"
}

function init_hugo_cmd() {
  # Split $HUGO safely into an argv array (no eval).
  # Example: HUGO="npx --yes hugo-extended" -> ["npx","--yes","hugo-extended"]
  read -r -a HUGO_CMD <<<"$HUGO"
  if [[ ${#HUGO_CMD[@]} -eq 0 ]]; then
    echo "[ERROR] HUGO command is empty"
    exit 1
  fi
}

function run_hugo() {
  if [[ -n "$OUTPUT_REDIRECT" ]]; then
    "${HUGO_CMD[@]}" "$@" >/dev/null 2>&1
  else
    "${HUGO_CMD[@]}" "$@"
  fi
}

function validate_repo() {
  # Conservative org/repo pattern
  if [[ ! "$DOCSY_REPO" =~ ^[A-Za-z0-9][A-Za-z0-9_.-]*/[A-Za-z0-9][A-Za-z0-9_.-]*$ ]]; then
    echo "[ERROR] Invalid -r / DOCSY_REPO value: '$DOCSY_REPO'"
    echo "[ERROR] Expected format: ORG/REPO using [A-Za-z0-9_.-]"
    exit 1
  fi
}

function validate_vers_hugo() {
  # Allow typical git ref-ish values (tag/branch/commit-ish) but block metacharacters/whitespace.
  # Note: we intentionally disallow '@' because the script injects it as a separator.
  if [[ -z "$DOCSY_VERS" ]]; then
    return 0
  fi

  if [[ "$DOCSY_VERS" == -* ]]; then
    echo "[ERROR] Invalid -v / DOCSY_VERS: must not start with '-'"
    exit 1
  fi

  if [[ ! "$DOCSY_VERS" =~ ^[A-Za-z0-9][A-Za-z0-9._/-]{0,99}$ ]]; then
    echo "[ERROR] Invalid -v / DOCSY_VERS value: '$DOCSY_VERS'"
    echo "[ERROR] Allowed pattern (HUGO mode): ^[A-Za-z0-9][A-Za-z0-9._/-]{0,99}$"
    exit 1
  fi
}

function validate_vers_npm() {
  # NPM example includes "semver:1.1.1" so allow ':' and '+'
  if [[ -z "$DOCSY_VERS" ]]; then
    return 0
  fi

  if [[ "$DOCSY_VERS" == -* ]]; then
    echo "[ERROR] Invalid -v / DOCSY_VERS: must not start with '-'"
    exit 1
  fi

  if [[ ! "$DOCSY_VERS" =~ ^[A-Za-z0-9][A-Za-z0-9._/+:-]{0,99}$ ]]; then
    echo "[ERROR] Invalid -v / DOCSY_VERS value: '$DOCSY_VERS'"
    echo "[ERROR] Allowed pattern (NPM mode): ^[A-Za-z0-9][A-Za-z0-9._/+:-]{0,99}$"
    exit 1
  fi
}

function process_CLI_args() {
  while getopts ":fhl:n:qr:s:v:" opt; do
    case $opt in
      f)
        FORCE_DELETE=true
        ;;
      h)
        usage
        ;;
      l)
        DOCSY_SRC="LOCAL"
        THEMESDIR="$OPTARG"
        ;;
      n)
        SITE_NAME="$OPTARG"
        ;;
      q)
        VERBOSE=""
        OUTPUT_REDIRECT="1"
        ;;
      r)
        DOCSY_REPO="$OPTARG"
        ;;
      s)
        DOCSY_SRC=$(echo "$OPTARG" | tr '[:lower:]' '[:upper:]')
        if [[ "$DOCSY_SRC" != "NPM" && "$DOCSY_SRC" != HUGO* ]]; then
          echo "ERROR: invalid argument to -s flag: $OPTARG"
          usage 1
        fi
        ;;
      v)
        DOCSY_VERS="$OPTARG"
        ;;
      \?)
        echo "ERROR: unrecognized flag: -$OPTARG"
        usage 1
        ;;
    esac
  done

  shift $((OPTIND - 1))
  if [[ "$#" -gt 0 ]]; then
    echo "ERROR: extra argument(s): $*" >&2
    usage 1
  fi
}

function create_site_directory() {
  if [[ -e "$SITE_NAME" ]]; then
    if [[ "$FORCE_DELETE" = true ]]; then
      echo "[INFO] Directory '$SITE_NAME' already exists. Deleting it as requested (-f)."
      ([[ $VERBOSE ]] && set -x; rm -rf "$SITE_NAME")
    else
      echo "[ERROR] Directory '$SITE_NAME' already exists. Remove it or use -f to force delete."
      exit 1
    fi
  fi
}

function _npm_install() {
  npm init -y >/dev/null

  if [[ -n "$OUTPUT_REDIRECT" ]]; then
    npm install --omit dev --save $DEPS >/dev/null 2>&1
  else
    npm install --omit dev --save $DEPS
  fi
}

function set_up_and_cd_into_site() {
  run_hugo new site --format yaml --quiet "$SITE_NAME"
  cd "$SITE_NAME"

  _npm_install

  if [[ "$DOCSY_SRC" == HUGO* ]]; then
    _set_up_site_using_hugo_modules
  else
    echo "theme: docsy/theme" >> hugo.yaml
    echo "themesDir: $THEMESDIR" >> hugo.yaml
  fi
}

function _set_up_site_using_hugo_modules() {
  local user_name
  user_name=$(whoami)

  validate_repo
  validate_vers_hugo

  local HUGO_MOD_WITH_VERS

  # Docsy theme lives in the `theme/` subfolder of the Docsy repo.
  HUGO_MOD_WITH_VERS="$DOCSY_REPO/theme"

  if [[ -n "$DOCSY_VERS" ]]; then
    HUGO_MOD_WITH_VERS+="@$DOCSY_VERS"
  fi

  echo "[INFO] Getting Docsy as Hugo module $HUGO_MOD_WITH_VERS"

  run_hugo mod init "github.com/$user_name/$SITE_NAME"

  if [[ "$DOCSY_REPO" == "$DOCSY_REPO_DEFAULT" ]]; then
    run_hugo mod get "github.com/$HUGO_MOD_WITH_VERS"
  else
    echo "[INFO] Fetch Docsy GitHub repo '$DOCSY_REPO' @ '$DOCSY_VERS'"
    mkdir -p tmp

    local DEPTH=10
    local SWITCH_NEEDED=""

    if [[ -n "$DOCSY_VERS" ]]; then
      if ! git clone --depth="$DEPTH" -b "$DOCSY_VERS" "https://github.com/$DOCSY_REPO" tmp/docsy; then
        SWITCH_NEEDED="1"
        git clone --depth="$DEPTH" "https://github.com/$DOCSY_REPO" tmp/docsy
      fi
    else
      git clone --depth="$DEPTH" "https://github.com/$DOCSY_REPO" tmp/docsy
    fi

    (
      cd tmp/docsy
      git log --oneline -"$DEPTH"

      if [[ -n "$SWITCH_NEEDED" && -n "$DOCSY_VERS" ]]; then
        git switch --detach "$DOCSY_VERS"
      fi
    )

    echo "replace github.com/$DOCSY_REPO_DEFAULT/theme => ./tmp/docsy/theme" >> go.mod
    run_hugo mod get "github.com/$DOCSY_REPO_DEFAULT/theme"
  fi

  echo "module: {proxy: direct, hugoVersion: {extended: true}, imports: [{path: github.com/$DOCSY_REPO_DEFAULT/theme, disable: false}]}" >> hugo.yaml
}

function main() {
  process_CLI_args "$@"
  init_hugo_cmd

  if [[ "$DOCSY_SRC" == "NPM" ]]; then
    validate_repo
    validate_vers_npm

    NPM_PKG=$DOCSY_REPO
    if [[ -n "$DOCSY_VERS" ]]; then
      NPM_PKG+="#$DOCSY_VERS"
    fi

    echo "[INFO] Getting Docsy as NPM package '$NPM_PKG'"
    DEPS+=" $NPM_PKG"
  elif [[ "$DOCSY_SRC" == "LOCAL" ]]; then
    echo "[INFO] Getting Docsy through a local directory '$THEMESDIR'"
  else
    validate_repo
    validate_vers_hugo
  fi

  create_site_directory

  [[ $VERBOSE ]] && set -x

  set_up_and_cd_into_site
  run_hugo # Generate site

  [[ $VERBOSE ]] && set +x

  cd ..

  echo "[INFO] '$SITE_NAME' successfully created, set up, and built."

  if [[ $VERBOSE ]]; then
    echo "[INFO] Here are the site files:"
    echo

    set -x
    ls -l "$SITE_NAME"
    echo
    ls -l "$SITE_NAME/public"
  fi
}

main "$@"