cue.sh

#!/usr/bin/env bash
set -euo pipefail

# cue.sh
#
# SUMMARY
#
#   CUE utilities.

ROOT=$(git rev-parse --show-toplevel)
CUE_SOURCES="${ROOT}/website/cue"
JSON_OUT="${ROOT}/website/data/docs.json"

list-docs-files() {
  find "${CUE_SOURCES}" -name '*.cue'
}

cmd_check() {
  ${VDEV:-cargo vdev} check docs
}

cmd_list() {
  list-docs-files
}

cmd_fmt() {
  # Ignore JSON-style cue files generated from VRL source code
  list-docs-files | grep -v "${CUE_SOURCES}/reference/remap/functions/" | xargs cue fmt "$@"
}

cmd_vet() {
  list-docs-files | xargs cue vet --concrete --all-errors "$@"
}

cmd_eval() {
  list-docs-files | xargs cue eval --concrete --all-errors "$@"
}

cmd_export() {
  list-docs-files | xargs cue export --all-errors "$@"
}

cmd_build() {
  # Display the CUE version for CI debugging purposes
  cue version

  # The docs JSON file needs to be removed or else CUE errors
  rm -f "${JSON_OUT}"

  # Build the docs JSON object out of the CUE sources
  list-docs-files | xargs cue export --all-errors "$@" --outfile "${JSON_OUT}"
}

usage() {
  cat >&2 <<-EOF
Usage: $0 [build|check|fmt|list|vet|eval|export]

Modes:
  build   - build all of the CUE sources and export them into a Hugo-processable
            JSON object
  check   - check for the CUE sources' correctness
  fmt     - format all CUE files using the built-in formatter
  list    - list all the documentation files
  vet     - check the documentation files and print errors
  eval    - print the evaluated documentation,
            optionally pass the expression to evaluate via "-e EXPRESSION"
  export  - export the documentation,
            optionally pass the expression to evaluate via "-e EXPRESSION"

Examples:

  Print the whole documentation in the JSON format:

    $0 export

  Print the "components.sources.kubernetes_logs" subtree in CUE format:

    $0 eval -e components.sources.kubernetes_logs

  Print the "cli" subtree in JSON format:

    $0 export -e cli

  Write all CUE data as JSON to ${JSON_OUT}:
    make cue-build

  Reformat the CUE sources:
    make cue-fmt
EOF
  exit 1
}

MODE="${1:-}"
case "$MODE" in
  build|check|fmt|list|vet|eval|export)
    shift
    "cmd_$MODE" "$@"
    ;;
  *)
    usage
    ;;
esac