@mservices-tech/scripts 3.2.2

package/enrich_changelog_with_dependency_changes/enrich_changelog_with_dependency_changes.sh

@@ -0,0 +1,289 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+source "$(dirname "$0")/../utils.sh" || exit 1
+
+readonly PACKAGE_JSON="package.json"
+readonly CHANGELOG_FILE="CHANGELOG.md"
+readonly VERSION_TAG_PATTERN="[0-9]+\.[0-9]+\.[0-9]+"
+readonly TEMP_CHANGES_FILE=".dependency-changes.md"
+VERBOSE=false
+
+function error_exit() {
+  logger_error "$1" >&2
+  exit "${2:-1}"
+}
+
+function debug_log() {
+  if [ "$VERBOSE" = true ]; then
+    logger_debug "$1" >&2
+  fi
+}
+
+function usage() {
+  cat << END
+Usage:
+  ./enrich_changelog_with_dependency_changes.sh [--help] [--verbose] [--include-dev-dependencies]
+Where:
+    help - whether to print usage information and exit
+    verbose - enable verbose logging for debugging
+    include-dev-dependencies - include dev dependencies in changelog (optional)
+Description:
+  This script enriches CHANGELOG.md with dependency changes by comparing
+  the current package.json with the one from the previous release.
+END
+}
+
+function validate_environment() {
+  debug_log "Validating environment..."
+  [ -f "$PACKAGE_JSON" ] || error_exit "package.json not found in current directory"
+  [ -f "$CHANGELOG_FILE" ] || error_exit "CHANGELOG.md not found in current directory"
+  command -v jq > /dev/null 2>&1 || error_exit "jq is required but not installed"
+  command -v git > /dev/null 2>&1 || error_exit "git is required but not installed"
+  debug_log "Environment validation complete"
+}
+
+function get_package_name() {
+  local full_name
+  full_name=$(jq -r '.name' package.json | cut -d'/' -f2)
+  echo "${full_name/-development/}"
+}
+
+function get_last_tag() {
+  local package_name="$1"
+  git tag --list --sort=-v:refname | grep -E "^${package_name}-${VERSION_TAG_PATTERN}$" | grep -v "\-rc" | head -n 1
+}
+
+function extract_dependencies() {
+  local package_json="$1"
+  local dependencies_type="$2"
+  jq -r ".$dependencies_type // {}" "$package_json"
+}
+
+function extract_version() {
+  local package_json="$1"
+  jq -r '.version' "$package_json"
+}
+
+function generate_dependency_diff() {
+  local old_dependencies="$1"
+  local new_dependencies="$2"
+  local dependency_type="$3"
+
+  # Create temporary files for JSON processing
+  local temp_dir
+  temp_dir=$(mktemp -d)
+
+  local old_json="${temp_dir}/old.json"
+  local new_json="${temp_dir}/new.json"
+  local old_pairs="${temp_dir}/old_pairs.txt"
+  local new_pairs="${temp_dir}/new_pairs.txt"
+
+  echo "$old_dependencies" > "$old_json"
+  echo "$new_dependencies" > "$new_json"
+
+  jq -r 'to_entries[] | "\(.key)|\(.value)"' "$old_json" > "$old_pairs"
+  jq -r 'to_entries[] | "\(.key)|\(.value)"' "$new_json" > "$new_pairs"
+
+  local changes=""
+  local -i updated_count=0
+  local -i removed_count=0
+  local -i added_count=0
+
+  # Compare versions and detect changes
+  while IFS='|' read -r key old_version; do
+    if [ -n "$key" ]; then
+      local new_version
+      new_version=$(grep "^${key}|" "$new_pairs" | cut -d'|' -f2)
+
+      if [ -z "$new_version" ]; then
+        changes="${changes}- **${key}**: ${old_version} → Removed\n"
+        ((removed_count++))
+      elif [ "$old_version" != "$new_version" ]; then
+        changes="${changes}- **${key}**: ${old_version} → ${new_version}\n"
+        ((updated_count++))
+      fi
+    fi
+  done < "$old_pairs"
+
+  # Check for newly added dependencies
+  while IFS='|' read -r key new_version; do
+    if [ -n "$key" ]; then
+      if ! grep -q "^${key}|" "$old_pairs"; then
+        changes="${changes}- **${key}**: Not Present → ${new_version}\n"
+        ((added_count++))
+      fi
+    fi
+  done < "$new_pairs"
+
+  # Cleanup temp files
+  rm -rf "$temp_dir"
+
+  if [ "$VERBOSE" = true ]; then
+    debug_log "=== $dependency_type Dependencies Summary ==="
+    debug_log "Updated: $updated_count"
+    debug_log "Added: $added_count"
+    debug_log "Removed: $removed_count"
+    debug_log "Total Changes: $((updated_count + added_count + removed_count))"
+    debug_log "=================================="
+  fi
+
+  if [ -n "$changes" ]; then
+    printf "%b" "$changes"
+  fi
+}
+
+function get_package_path() {
+  local package_dir
+  package_dir=$(dirname "$(readlink -f "./package.json")")
+  local git_root
+  git_root=$(git rev-parse --show-toplevel)
+  echo "${package_dir#"$git_root"/}"
+}
+
+function is_rc_version() {
+  local version="$1"
+  [[ "$version" == *"-rc"* ]]
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ "${PROCESS_ARGUMENTS['--help']}" ]; then
+    usage
+    exit 0
+  fi
+
+  if [ "${PROCESS_ARGUMENTS['--verbose']}" ]; then
+    VERBOSE=true
+    debug_log "Verbose mode enabled"
+  fi
+
+  local INCLUDE_DEV_DEPENDENCIES=false
+  if [ "${PROCESS_ARGUMENTS['--include-dev-dependencies']}" ]; then
+    INCLUDE_DEV_DEPENDENCIES=true
+    debug_log "Including dev dependencies"
+  fi
+
+  validate_environment
+
+  logger_info "Starting changelog enrichment process..."
+
+  local current_version
+  current_version=$(jq -r '.version' package.json)
+
+  if is_rc_version "$current_version"; then
+    logger_info "Current version ${current_version} is a release candidate. Skipping dependency diff."
+    exit 0
+  fi
+
+  local package_name
+  package_name=$(get_package_name)
+  logger_info "Processing package: $package_name"
+
+  local package_path
+  package_path=$(get_package_path)
+  debug_log "Package path: $package_path"
+
+  local last_tag
+  last_tag=$(get_last_tag "$package_name")
+
+  if [ -z "$last_tag" ]; then
+    logger_warn "No previous non-RC release found. Skipping dependency diff."
+    exit 0
+  fi
+
+  logger_info "Found last tag: $last_tag"
+
+  local temp_dir
+  temp_dir=$(mktemp -d)
+  trap 'rm -rf "${temp_dir}"' EXIT
+  debug_log "Created temporary directory: $temp_dir"
+
+  git show "${last_tag}:${package_path}/${PACKAGE_JSON}" > "${temp_dir}/${PACKAGE_JSON}"
+  debug_log "Extracted old package.json from tag ${last_tag}"
+
+  logger_info "Starting dependency comparison..."
+
+  local old_dependencies new_dependencies old_version new_version
+  old_dependencies=$(extract_dependencies "${temp_dir}/${PACKAGE_JSON}" "dependencies")
+  new_dependencies=$(extract_dependencies "./${PACKAGE_JSON}" "dependencies")
+
+  old_version=$(extract_version "${temp_dir}/${PACKAGE_JSON}")
+  new_version=$(extract_version "./${PACKAGE_JSON}")
+  logger_info "Comparing versions: $old_version → $new_version"
+
+  debug_log "Processing regular dependencies..."
+  dependency_changes=$(generate_dependency_diff "$old_dependencies" "$new_dependencies" "Regular")
+
+  local dev_dependency_changes=""
+  if [ "$INCLUDE_DEV_DEPENDENCIES" = true ]; then
+    local old_dev_dependencies new_dev_dependencies
+    old_dev_dependencies=$(extract_dependencies "${temp_dir}/${PACKAGE_JSON}" "devDependencies")
+    new_dev_dependencies=$(extract_dependencies "./${PACKAGE_JSON}" "devDependencies")
+    debug_log "Processing dev dependencies..."
+    dev_dependency_changes=$(generate_dependency_diff "$old_dev_dependencies" "$new_dev_dependencies" "Dev")
+  fi
+
+  if [ -n "$dependency_changes" ] || [ -n "$dev_dependency_changes" ]; then
+    logger_info "Found dependency changes, generating markdown..." >&2
+    {
+      if [ -n "$dependency_changes" ] && [ -n "$dev_dependency_changes" ]; then
+        echo -e "### Dependency Updates"
+        echo -e "\n#### Dependencies\n$dependency_changes"
+        echo -e "\n#### Dev Dependencies\n$dev_dependency_changes"
+      elif [ -n "$dependency_changes" ]; then
+        echo -e "### Dependency Updates\n"
+        echo -e "$dependency_changes"
+      elif [ -n "$dev_dependency_changes" ]; then
+        echo -e "### Dependency Updates"
+        echo -e "\n#### Dev Dependencies\n$dev_dependency_changes"
+      fi
+      echo "" # Add empty line at the end
+    } > "$TEMP_CHANGES_FILE"
+
+    local temp_changelog
+    temp_changelog=$(mktemp)
+
+    # Process the changelog file and insert dependency changes after the first version header
+    awk -v changes_file="$TEMP_CHANGES_FILE" '
+      BEGIN { found_first = 0; printed_changes = 0 }
+      {
+        if ($0 ~ /^#{1,3} [0-9]+\.[0-9]+\.[0-9]+/) {
+          if (!found_first) {
+            print $0
+            found_first = 1
+          } else {
+            if (!printed_changes) {
+              system("cat " changes_file)
+              printed_changes = 1
+            }
+            print $0
+          }
+        } else {
+          print $0
+        }
+      }
+      END {
+        if (!printed_changes) {
+          system("cat " changes_file)
+        }
+      }
+    ' "$CHANGELOG_FILE" > "$temp_changelog"
+
+    if [ -s "$temp_changelog" ]; then
+      mv "$temp_changelog" "$CHANGELOG_FILE"
+      logger_info "Successfully inserted dependency changes in changelog" >&2
+    else
+      logger_error "Temporary changelog is empty, keeping original file" >&2
+      rm -f "$temp_changelog"
+      exit 1
+    fi
+
+    rm -f "$TEMP_CHANGES_FILE"
+  else
+    logger_info "No dependency changes detected" >&2
+  fi
+}
+
+main "$@"

package/find_all_javascript_files/find_all_javascript_files.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--mode> [--extension]
+Where:
+  help      - print usage information and exit
+  mode      - what to do with the files, pass 'find' or 'delete'
+  extension - extension to search for, default 'js'
+Description:
+  Runs a search for all the JavaScript files inside the
+  current location, excluding certain patterns such as
+  'node_modules' and 'build' directories.
+END
+}
+
+function print_file() {
+  local extension="$1"
+  local file_name="$2"
+  printf "Found JavaScript file with .$extension extension: %s\n" "$file_name"
+}
+export -f print_file
+
+function delete_file() {
+  local extension="$1"
+  local file_name="$2"
+  printf "Deleting JavaScript file with .$extension extension: %s\n" "$file_name"
+  rm "$file_name"
+}
+export -f delete_file
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if [ ${PROCESS_ARGUMENTS['--mode']} == "find" ]; then
+    local -r search_results_handler_function=print_file
+  elif [ ${PROCESS_ARGUMENTS['--mode']} == "delete" ]; then
+    local -r search_results_handler_function=delete_file
+  else
+    printf "Mode not provided. Run with '--help' for more information.\n"
+    exit 1
+  fi
+
+  local -r JAVASCRIPT_FILES_EXTENSION="${PROCESS_ARGUMENTS['--extension']:-js}"
+
+  find . -name "*.""$JAVASCRIPT_FILES_EXTENSION" \
+    -not -path "*/node_modules/*" \
+    -not -path "./.yarn/*" \
+    -not -path "./.git/*" \
+    -not -path "./packages/design-system/build/*" \
+    -not -path "./packages/design-system/src/bin/*" \
+    -not -path "./packages/design-system/src/web-components/*" \
+    -not -path "./packages/design-system/src/libs/*" \
+    -not -path "./packages/design-system/plugins/*" \
+    -not -path "./packages/eslint-config-node/build/*" \
+    -not -path "./packages/eslint-config/build/*" \
+    -not -path "./packages/styleguide-api/build/*" \
+    -not -path "./packages/styleguide-api/public/*" \
+    -not -path "./packages/templates/build/*" \
+    -not -path "./packages/templates/.next/*" \
+    -not -path "./packages/styleguide/.next/*" \
+    -not -path "./packages/styleguide/.netlify/*" \
+    -not -path "./packages/styleguide/build/*" \
+    -not -path "./packages/styleguide/public/*" \
+    -not -path "./packages/styleguide/src/mocks/mkanon/*" \
+    -exec bash -c "$search_results_handler_function $JAVASCRIPT_FILES_EXTENSION \$0" {} \;
+}
+
+main "$@"

package/find_and_parse_environmental_variable_files/find_and_parse_environmental_variable_files.sh

@@ -0,0 +1,180 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--validate] [--help]
+Where:
+  help - display this help
+  validate - validate .env files having example files to ensure that they are in sync
+Description:
+   Script for linting .env* files and validating .env files having example files to ensure that they are in sync.
+END
+}
+
+function find_env_files() {
+  declare -g ALL_ENV_FILES=$(find . -type f -name ".env*" -not -path "*node_modules/*" -not -path "*build/*" -not -path "*.next/*" -not -path "*.git/*")
+}
+
+function evaluate_description() {
+  local description="$1"
+  local current_line_number="$2"
+  local logger_message="$3"
+  local validity=$(echo $description | grep -E '.*## @type [{].{3,}[}] @description .{3,}')
+
+  if [[ $validity == "" ]]; then
+    echo -e "\e[31mError in line $ENV_FILE:$current_line_number: $logger_message\e[0m"
+    echo $line
+    DESIGN_SYSTEM_LINTER_EXIT_CODE=1
+  fi
+}
+
+function evaluate_comment() {
+
+  local comment="$1"
+  local current_line_number="$2"
+  local validity=$(echo $comment | grep -E '^# .*|^## .*')
+
+  if [[ $validity == "" ]]; then
+    echo -e "\e[33mWarining in line $ENV_FILE:$current_line_number: comment should be in format # <comment body>\e[0m"
+    echo $line
+    DESIGN_SYSTEM_LINTER_EXIT_CODE=1
+  fi
+
+}
+
+function lint_env_file() {
+
+  declare -g ENV_FILE="$1"
+  shopt -s extglob
+
+  local previous_IFS=$IFS
+  local current_line_number=0
+  local previous_line=""
+
+  while IFS= read -r line; do
+    ((current_line_number++))
+
+    if [[ $line == *"## "* ]]; then
+      evaluate_description "$line" "$current_line_number" "comment should be in format ## @type {<type>} @description <description>, remember to include description as well as type in the convention of your project programming language"
+    fi
+
+    if [[ $line == !(#)"#"!(#)* ]]; then
+      evaluate_comment "$line" "$current_line_number"
+      previous_line=$line
+      continue
+    fi
+
+    if [[ $line == *"="* ]]; then
+
+      local variable_name_regex="*([alnum]|_)*"
+      local before_equal_sign=${line%=*}
+
+      if [[ $before_equal_sign != $variable_name_regex ]]; then
+        echo -e "\e[33mError in line $ENV_FILE:$current_line_number: variable name should be in uppercase and underscore format\n\e[0m"
+        echo $line
+      fi
+
+      evaluate_description "$previous_line" "$current_line_number" "each variable should have a description in format ## @type {<type>} @description <description>, remember to include description as well as type in the convention of your project programming language"
+    fi
+
+    previous_line=$line
+  done < "$ENV_FILE"
+
+  IFS=$previous_IFS
+  shopt -u extglob
+}
+
+function extract_variables_from_file() {
+
+  local env_file="$1"
+  local previous_IFS=$IFS
+  local collect_variables=""
+
+  while IFS= read -r line; do
+
+    if [[ $line == !(#)"#"!(#)* ]]; then
+      continue
+    fi
+
+    if [[ $line == *"="* ]]; then
+      local before_equal_sign=${line%=\"*}
+      before_equal_sign=${before_equal_sign%=*}
+      collect_variables+=" $before_equal_sign"
+    fi
+  done < "$env_file"
+
+  IFS=$previous_IFS
+
+  echo $collect_variables
+}
+
+function validate_env_file() {
+  local example_env_file="$1"
+  local env_file=${example_env_file%.example*}
+
+  variables_in_example_file=$(extract_variables_from_file "$example_env_file")
+  variables_in_env_file=$(extract_variables_from_file "$env_file")
+
+  files_diffrences=$(echo ${variables_in_example_file[@]} ${variables_in_env_file[@]} | tr ' ' '\n' | sort | uniq --unique)
+
+  if [ -z "$files_diffrences" ]; then
+    echo -e "\e[32mFiles are in sync\e[0m"
+  else
+    DESIGN_SYSTEM_LINTER_EXIT_CODE=1
+    echo -e "\e[31mError: $env_file is not in sync with $example_env_file, missing variables: $files_diffrences\e[0m"
+  fi
+}
+
+function main() {
+
+  declare -g DESIGN_SYSTEM_LINTER_EXIT_CODE=0
+  local should_validate=false
+
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if [ ${PROCESS_ARGUMENTS['--validate']} ]; then
+    should_validate=true
+  fi
+
+  find_env_files
+
+  local example_env_files_array
+
+  for file in $ALL_ENV_FILES; do
+
+    if [[ $file == *".example" ]]; then
+      example_env_files_array+=" $file"
+    fi
+
+    echo "Linting $file"
+    lint_env_file "$file"
+
+  done
+
+  if [[ $should_validate == true ]]; then
+    for file in $example_env_files_array; do
+
+      local example_env_file=$file
+      local env_file=${example_env_file%.example*}
+
+      if [ ! -f "$env_file" ]; then
+        continue
+      fi
+
+      echo "Validatting $file"
+      validate_env_file "$file"
+
+    done
+  fi
+
+  exit $DESIGN_SYSTEM_LINTER_EXIT_CODE
+}
+
+main "$@"

package/find_references/find_references.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--query>
+Where:
+  help  - print usage information and exit
+  query - the string to find, case insensitive
+Description:
+  Finds all instances of a word and its variations
+  inside current directory. Excludes certain patterns such
+  as 'node_modules' and 'build' directiories.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if ! [ ${PROCESS_ARGUMENTS['--query']} ]; then
+    printf "No query provided. Run with '--help' for more information."
+    exit 1
+  fi
+
+  grep ${PROCESS_ARGUMENTS['--query']} \
+    --recursive \
+    --line-number \
+    --ignore-case \
+    --only-matching \
+    --exclude-dir=node_modules \
+    --exclude-dir=build \
+    --exclude-dir=.next \
+    --exclude-dir=.git \
+    --include=*.ts \
+    --include=*.tsx \
+    --include=*.md \
+    --include=*.mdx \
+    --include=*.json \
+    --include=*.yml \
+    --include=.env* \
+    --include=*.sh
+}
+
+main "$@"