@mservices-tech/scripts 3.2.2

package/utils.sh

@@ -0,0 +1,337 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2001
+
+# Usage (assuming the script is located in 'scripts' subdirectory
+# of the project, where package is installed):
+#
+# source "$(dirname "$0")/../node_modules/@mservicestech/scripts/utils.sh" || exit 1
+# by default the script will look for esbuild in './node_modules/.bin/esbuild'
+# you can change it by setting ESBUILD_BINARY variable
+# export ESBUILD_BINARY='./node_modules/.bin/esbuild'
+#
+# transpile --input="your-script.ts"
+#
+# if you want to use 'tsc' instead of 'esbuild':
+#
+# transpile --compiler="tsc" --input="your-script.ts"
+# if you want to change compiler globally for all runs of transpile function,
+# set the DESIGN_SYSTEM_GLOBAL_COMPILER variable, for example:
+# export DESIGN_SYSTEM_GLOBAL_COMPILER=tsc # or export DESIGN_SYSTEM_GLOBAL_COMPILER=esbuild
+ESBUILD_BINARY="${ESBUILD_BINARY:-./node_modules/.bin/esbuild}"
+
+ESBUILD_BASIC_OPTIONS="--log-level=error"
+
+# Should be set to Node's current LTS version
+TARGET_NODE_VERSION="node24.0"
+
+GREEN='\033[0;32m'
+RED='\033[0;31m'
+YELLOW='\033[0;33m'
+NO_COLOR='\033[0m'
+
+function should_skip() {
+  local input_file=$1
+  local output_file=$2
+
+  if [ -f "$output_file" ] && [ "$input_file" -ot "$output_file" ]; then
+    return 0
+  fi
+
+  return 1
+}
+
+# Exits a script cleanly, killing the whole process tree
+# it is able to skip killing child processes if needed (for example when running type checking)
+function clean_exit() {
+  local should_not_kill_child_processes_and_exit=${DESIGN_SYSTEM_PREVENT_CHILD_PROCESS_KILL_AND_EXIT_ON_FAILURE:-false}
+  trap "exit" INT TERM
+  if [ "$should_not_kill_child_processes_and_exit" != "true" ]; then
+    trap "kill 0" EXIT
+    exit ${1:-0}
+  fi
+}
+
+# Runs a JavaScript (CommonJS) script
+function run_script() {
+  local -r script_path="$1"
+  local runtime=${DESIGN_SYSTEM_JAVASCRIPT_RUNTIME:-node}
+
+  shift
+
+  ${runtime} "$script_path" "$@" || clean_exit 1
+}
+
+# Compiles TypeScript file to CommonJS JavaScript file (file.ts → file.js)
+#
+# Usage:
+# transpile path with one of two copilers (tsc || esbuild)
+# to pick the correct commpiler use flag --compiler [--compiler="tsc"]
+#
+# Note:
+# - esbuild is a default compiler for this function
+# - esbuild will bundle all files into one
+# - tsc will not bundle files and will generate one .js file per each .ts file
+#   used in the transpilation
+# - both compilers will always transpile to CommonJS format
+function transpile() {
+  # Defaults to 'esbuild' if no global compiler is set
+  local compiler=${DESIGN_SYSTEM_GLOBAL_COMPILER:-esbuild}
+
+  # Compiler-specific arguments
+  local tsc_arguments=""
+  local esbuild_arguments=""
+
+  # Flag to force transpile, defaults to 'false'
+  local global_force_transpile=${DESIGN_SYSTEM_GLOBAL_FORCE_TRANSPILE:false}
+  local force_transpile=false
+
+  # Script input file, defaults to empty
+  local input=""
+
+  # Parse command line arguments
+  while test $# -gt 0; do
+    case "$1" in
+      --tsc-compiler-arguments*)
+        # Extracts 'tsc' specific arguments
+        tsc_arguments=$(echo "$1" | sed -e 's/^[^=]*=//g')
+        shift
+        ;;
+      --esbuild-compiler-arguments*)
+        # Extracts 'esbuild' specific arguments
+        esbuild_arguments=$(echo "$1" | sed -e 's/^[^=]*=//g')
+        shift
+        ;;
+      --compiler*)
+        # Sets the compiler
+        compiler=$(echo "$1" | sed -e 's/^[^=]*=//g')
+        shift
+        ;;
+      --input*)
+        # Sets the input script name
+        input=$(echo "$1" | sed -e 's/^[^=]*=//g')
+        shift
+        ;;
+      --force-transpile)
+        # Forces transpiling
+        force_transpile=true
+        shift
+        ;;
+      *)
+        break
+        ;;
+    esac
+  done
+
+  if [ -z "$input" ]; then
+    echo "Error: No input provided."
+    echo "Usage: transpile --input=<input file> [other_arguments]"
+    exit 1
+  fi
+
+  # Sets the script_name from --input or first positional argument
+  local script_name=$input
+
+  local pad_dots='...............................................................'
+  local pad_spaces='       '
+  printf "Transpiling %s %s" "$script_name" "${pad_dots:${#script_name}}"
+  printf " (%s) %s" "$compiler" "${pad_spaces:${#compiler}}"
+
+  local output_file="${script_name%.*}.js"
+
+  if [ "$force_transpile" != true ] && [ "$global_force_transpile" != true ] && should_skip "$script_name" "$output_file"; then
+    printf " SKIPPED\n"
+    return
+  fi
+
+  case "$compiler" in
+    tsc*)
+      # 'lib' should be set to the highest value from all the values in
+      # the tsconfig.json used in the design system's build process
+      # in design system's tsconfig.json
+      #
+      # 'target' should be set to the same value as 'target' field value
+      # in design system's tsconfig.json
+      # Warning: when using the 'tsc' compiler (not a default one), a .js
+      # file will be generated for each .ts module. You might need to clean it up
+      tsc -skipLibCheck -esModuleInterop \
+        --module "commonjs" \
+        --moduleResolution "node" \
+        --resolveJsonModule \
+        --lib "es2021" \
+        --target "es2017" \
+        --jsx "react" $tsc_arguments "$script_name" || clean_exit 1
+      ;;
+    esbuild*)
+      # Note: 'prettier' is always an external dependency when transpiling
+      # using esbuild. Prettier API is used in writeFileFormatted
+      # and writeFileSyncFormatted functions from @mservicestech/utils package.
+      # Without defining Prettier as external dependency, esbuild cannot
+      # properly bundle scripts using Prettier API to CommonJS format.
+      #
+      # remove file suffix
+      ${ESBUILD_BINARY} ${ESBUILD_BASIC_OPTIONS} "$script_name" \
+        --bundle \
+        --loader:.js=js \
+        --loader:.jsx=jsx \
+        --loader:.ts=ts \
+        --loader:.tsx=tsx \
+        --loader:.mjs=js \
+        --resolve-extensions=.mjs,.js,.ts,.tsx \
+        --platform=node \
+        --target="$TARGET_NODE_VERSION" \
+        --outfile="$output_file" \
+        --external:prettier \
+        --format=cjs $esbuild_arguments || clean_exit 1
+      ;;
+    *)
+      echo "Unknown compiler: $compiler"
+      clean_exit 1
+      ;;
+  esac
+
+  printf " %bDONE%b\n" "${GREEN}" "${NO_COLOR}"
+}
+
+# inspired by: https://stackoverflow.com/a/55556407/963881
+#
+# usage:
+#     source ./node_modules/@mservicestech/scripts/utils.sh && token_set <name> <keys> - <values>
+#
+#     iterating over values: '${<name>[@]}'
+#     iterating over keys:   '${!<name>[@]}'
+#
+# where:
+#     name   - a name for associative array environment variable to be created
+#     keys   - a list of key names sepearated by spaces
+#     values - values for the respective keys, sepearated by spaces
+#
+# example:
+#     token_set MY_TOKEN firstKey secondKey thirdKey - firstValue secondValue thridValue
+function token_set() {
+  local token_name="$1"
+  declare -g -A "$token_name"
+  shift
+
+  # read the object from arguments
+  local token_keys=()
+  while [[ "$1" != "-" ]]; do
+    token_keys+=("$1")
+    shift
+  done
+  shift
+  local token_values=("$@")
+
+  for ((index = 0; index < ${#token_keys[@]}; index++)); do
+    eval "$token_name[${token_keys[$index]}]=${token_values[$index]}"
+  done
+}
+
+function run_build_scripts_typecheck() {
+  start_time=$(date +%s)
+  TEMPORARY_LOG_FILE_PATH="scripts_typecheck.log"
+
+  # Build scripts with tsc to get results of type checking
+  export DESIGN_SYSTEM_GLOBAL_COMPILER="tsc --noEmit"
+  export DESIGN_SYSTEM_GLOBAL_FORCE_TRANSPILE="true"
+  export DESIGN_SYSTEM_PREVENT_CHILD_PROCESS_KILL_AND_EXIT_ON_FAILURE="true"
+
+  yarn build:scripts | tee -a "$TEMPORARY_LOG_FILE_PATH" || true
+
+  # Count the number of compile errors and remove leading spaces from the count
+  compile_errors_count=$(grep "error TS" "$TEMPORARY_LOG_FILE_PATH" | wc -l | tr -d ' ')
+
+  # Delete log file
+  rm -f "$TEMPORARY_LOG_FILE_PATH"
+  end_time=$(date +%s)
+  elapsed_time=$((end_time - start_time))
+  elapsed="[$((elapsed_time / 60))m:$((elapsed_time % 60))s]"
+
+  # Exit with error if there are any compile errors
+  if [ "$compile_errors_count" -gt 0 ]; then
+    if [ "$compile_errors_count" -eq 1 ]; then
+      echo "There is 1 compile error $elapsed"
+    else
+      echo "There are $compile_errors_count compile errors $elapsed"
+    fi
+    exit 1
+  else
+    echo "No compile errors $elapsed"
+  fi
+}
+
+# description:
+#   parses process arguments into an associative array
+# usage:
+#   parse_arguments <variable arguments>
+# where:
+#   variable arguments - all the arguments passed to the script
+function parse_arguments() {
+  unset PROCESS_ARGUMENTS
+  declare -g -A "PROCESS_ARGUMENTS"
+  while [ $# -gt 0 ]; do
+    local argument_name=$(cut -d '=' -f 1 <<< "$1")
+    local argument_value=$(cut -d '=' -f 2- <<< "$1")
+
+    if [ "$argument_name" = "$argument_value" ]; then
+      unset argument_value
+    fi
+
+    PROCESS_ARGUMENTS[$argument_name]="${argument_value:-true}"
+    shift
+  done
+}
+
+# description:
+#   Adds an override of default esbuild's behaviour of exporting a class with getters
+#   instead of plain object.
+# usage:
+#   fix_exports --object=<object name> --file=<file name>
+# where:
+#   object name - a default export class object name in cjs file
+#   file name   - a cjs file path to fix exports in
+function fix_exports() {
+  parse_arguments "$@"
+
+  printf "module.exports = %s;\n" "${PROCESS_ARGUMENTS['--object']}" >> "\
+${PROCESS_ARGUMENTS['--file']}"
+}
+
+# description:
+#   A family of logging functions for different scenarios
+# usage:
+#   logger_[raw|debug|info|warn|error] "<message>"
+# where:
+#   message - a message to be logged according to selected severity
+alias logger_raw=echo
+
+function logger_log() {
+  printf "%s %s\n" "$(date +"%Y-%m-%d %T")" "$1"
+}
+
+function logger_debug() {
+  logger_log "debug: $1"
+}
+
+function logger_info() {
+  local color=$GREEN
+  if [[ $CI == "true" ]]; then
+    color=$NO_COLOR
+  fi
+  printf "$color%s$NO_COLOR\n" "$(logger_log "info: $1")"
+}
+
+function logger_warn() {
+  local color=$YELLOW
+  if [[ $CI == "true" ]]; then
+    color=$NO_COLOR
+  fi
+  printf "$color%s$NO_COLOR\n" "$(logger_log "warn: $1")"
+}
+
+function logger_error() {
+  local color=$RED
+  if [[ $CI == "true" ]]; then
+    color=$NO_COLOR
+  fi
+  printf "$color%s$NO_COLOR\n" "$(logger_log "error: $1")"
+}