@mservices-tech/scripts 3.2.2

package/get_package_info/get_package_info.sh

@@ -0,0 +1,103 @@
+#!/usr/bin/env bash
+
+# $0 cannot be used when sourcing in the main shell
+source "$(dirname "${BASH_SOURCE[0]}")/../utils.sh"
+
+function usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--path> [--print]
+Where:
+  help  - show usage information and exit
+  path  - path to Yarn workspace with the package
+  print - print the output as executable variable
+          setting script (useful in subshell execution contexts)
+  release_type - release | prerelease; based on that package next version is
+                  generated (with an rc-{version} suffix or without it)
+
+Description:
+  Sets the following environment variables with information
+  from a given workspace path:
+    - PACKAGE_NAME (name of the package, without namespace, after publishing the package)
+    - DEVELOPMENT_PACKAGE_NAME (PACKAGE_NAME name with the -development suffix)
+    - PACKAGE_SCOPE
+    - PACKAGE_VERSION
+    - PACKAGE_NEXT_VERSION (the semantic version of the next release)
+  These variables are filled with information from the
+  respective package.json file read at path given in '--path'.
+END
+}
+
+function get_package_next_version() {
+  local -r package_name="$1"
+  local -r release_type="$2"
+
+  pushd "packages/$package_name" &> /dev/null
+
+  local next_version_output
+
+  if [[ $release_type == "prerelease" ]]; then
+    local -r current_branch_name=$(git rev-parse --abbrev-ref HEAD | sed -E -e 's/[^a-zA-Z0-9]+/-/g' -e 's/^-//' -e 's/-$//' -e 's/\./-/g')
+
+    next_version_output=$(
+      yarn dlx standard-version@9.5.0 \
+        --dry-run \
+        --prerelease "$current_branch_name-rc" \
+        --tag-prefix="$package_name-"
+    )
+  else
+    next_version_output=$(
+      yarn dlx standard-version@9.5.0 \
+        --dry-run \
+        --tag-prefix="$package_name-"
+    )
+  fi
+
+  popd &> /dev/null
+  # Cut version string after first number, i.e.
+  # package-name-1.2.3 → 1.2.3
+  # package-name-0.2.28-rc.2 → 0.2.28-rc.2
+  echo "$next_version_output" | grep "tagging release" | sed 's/^[^0-9]*\([0-9].*\)/\1/'
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    # return is used instead of exit to prevent calling
+    # shell from exiting in sourced execution context
+    return
+  fi
+
+  if ! [ ${PROCESS_ARGUMENTS['--path']} ]; then
+    printf "No path was provided. Run with '--help' for more information.\n"
+    # return is used instead of exit to prevent calling
+    # shell from exiting in sourced execution context
+    return
+  fi
+
+  local -r name=$(jq --raw-output ".name" \
+    "${PROCESS_ARGUMENTS['--path']%/}/package.json")
+  local -r version=$(jq --raw-output ".version" \
+    "${PROCESS_ARGUMENTS['--path']}/package.json")
+
+  DEVELOPMENT_PACKAGE_NAME="${name#@*/}"
+  PACKAGE_NAME="${DEVELOPMENT_PACKAGE_NAME%-development}"
+  PACKAGE_SCOPE="${name%/*}"
+  PACKAGE_VERSION="${version}"
+  PACKAGE_NEXT_VERSION=$(get_package_next_version "$PACKAGE_NAME" ${PROCESS_ARGUMENTS['--release_type']})
+
+  if [ ${PROCESS_ARGUMENTS['--print']} ]; then
+    # the '@A' parameter expansion guarantees the string formatted as variable
+    # assignment so that the output can be reevaluated by the parent shell by 'eval'
+    # more at: https://www.gnu.org/software/bash/manual/bash.html#Brace-Expansion
+    printf "%s\n%s\n%s\n%s\n%s\n" \
+      "${DEVELOPMENT_PACKAGE_NAME@A}" \
+      "${PACKAGE_NAME@A}" \
+      "${PACKAGE_SCOPE@A}" \
+      "${PACKAGE_VERSION@A}" \
+      "${PACKAGE_NEXT_VERSION@A}"
+  fi
+}
+
+main "$@"

package/git_user_stats/git_user_stats.sh

@@ -0,0 +1,95 @@
+#!/usr/bin/env bash
+
+# Based on:
+# https://gist.github.com/shitchell/783cc8a892ed1591eca2afeb65e8720a
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--config> [--options]
+Where:
+  help    - print usage information and exit
+  config  - configuration file path
+  options - options to pass to 'git log' as quoted string
+Description:
+  Shows user stats (commits, files modified, insertions, deletions, and total
+  lines modified) for a repository.
+Example configuration:
+  --
+  # !#/usr/bin/env bash
+
+  accounts="\
+    ****@services.com.pl ****@users.noreply.github.com
+    ****@gmail.com ****@users.noreply.github.com"
+  --
+
+  The 'accounts' variable defines different email groups for actual users.
+  You can create a group when a contributor uses multiple git accounts
+  or emails to sum up their contributions. Actual users are separated by a
+  newline, while their aliases (emails) are separated by spaces.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if [ ${PROCESS_ARGUMENTS['--config']} ]; then
+    source ${PROCESS_ARGUMENTS['--config']} || exit 1
+  fi
+
+  # this is needed to generate statistics for large repositories
+  git config diff.renameLimit 10000
+  git log "${PROCESS_ARGUMENTS['--options']}" --format='author: %ae' --numstat \
+    | tr '[A-Z]' '[a-z]' \
+    | grep -v '^$' \
+    | grep -v '^-' \
+    | awk -v account_data="$accounts" '
+      BEGIN {
+        split(account_data, accounts, "\n")
+      }
+      {
+        if ($1 == "author:") {
+          author = $2;
+          for(account in accounts) {
+            split(accounts[account], emails)
+            for(email in emails) {
+              if(author == emails[email]) {
+                author = emails[1]
+              }
+            }
+          }
+          commits[author]++;
+        } else {
+          insertions[author] += $1;
+          deletions[author] += $2;
+          total[author] += $1 + $2;
+          # if this is the first time seeing this file for this
+          # author, increment their file count
+          author_file = author ":" $3;
+          if (!(author_file in seen)) {
+            seen[author_file] = 1;
+            files[author]++;
+          }
+        }
+      }
+      END {
+        printf("email,commits,files,insertions,deletions,lines\n")
+        # Print the stats for each user, sorted by total lines
+        n = asorti(total, sorted_emails, "@val_num_desc");
+        for (i = 1; i <= n; i++) {
+          email = sorted_emails[i];
+          printf("%s,%s,%s,%s,%s,%s\n",
+            email, commits[email], files[email],
+            insertions[email], deletions[email], total[email]);
+        }
+      }
+  '
+}
+
+main "$@"

package/index.js

@@ -0,0 +1 @@
+"use strict";var a=Object.defineProperty;var l=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var p=Object.prototype.hasOwnProperty;var v=(e,n)=>{for(var r in n)a(e,r,{get:n[r],enumerable:!0})},b=(e,n,r,s)=>{if(n&&typeof n=="object"||typeof n=="function")for(let i of f(n))!p.call(e,i)&&i!==r&&a(e,i,{get:()=>n[i],enumerable:!(s=l(n,i))||s.enumerable});return e};var c=e=>b(a({},"__esModule",{value:!0}),e);var y={};v(y,{checkEnvironmentVariables:()=>t,getConfigFromEnvironmentVariables:()=>o});module.exports=c(y);function t(e){let n={};for(let r of e){if(process.env[r]===void 0||!process.env[r])throw new Error(`Missing environment variable: ${r}`);typeof process.env[r]=="string"&&(n[r]=process.env[r])}return n}function o(e){if(typeof e!="object"||e===null||Array.isArray(e))throw new Error(`Invalid config: ${e}`);let n=Object.keys(e);for(let r of n)if(typeof r!="string"&&o(e[r]),(process.env[r]===void 0||!process.env[r])&&e[r]===void 0)throw new Error(`Missing environment variable in configuration: ${r}`);return e}0&&(module.exports={checkEnvironmentVariables,getConfigFromEnvironmentVariables});

package/is_branch_rebased/is_branch_rebased.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help]
+Where:
+  help - print usage information and exit
+Description:
+  Checks if the current branch is rebased to master.
+  If the current branch is not rebased to master, will exit with code 1.
+  Otherwise, will exit with code 0.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  current_branch=$(git rev-parse --abbrev-ref HEAD)
+
+  git fetch origin master:master
+
+  hash_master=$(git show-ref --heads -s origin master)
+  hash_current_branch=$(git merge-base origin/master ${current_branch})
+
+  echo "Current branch hash: ${hash_current_branch}"
+  echo "Master branch hash: ${hash_master}"
+
+  if [ "${hash_master}" = "${hash_current_branch}" ]; then
+    printf "Branch ${current_branch} is rebased to master.\n"
+    exit 0
+  else
+    printf "Branch ${current_branch} is not rebased to master.\n"
+    exit 1
+  fi
+}
+
+main "$@"

package/last_release_commits/last_release_commits.sh

@@ -0,0 +1,101 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--package-name=package_name> [--package-directory=directory]
+Where:
+  help              - print usage information and exit
+  package-name      - name of the package, for which we want to get the list of
+                      release commits (it has to be aligned with version tag names,
+                      for example: if a package version is tagged
+                      'some-package-name-1.2.3', 'some-package-name' has to be
+                      passed in the package-name argument)
+  package-directory - directory where to look for changelogs commits
+                      of the given package (optional)
+
+Description:
+  Returns all commits between two most recent (SemVer) tags
+  for a given list of directories.
+
+  Example:
+    ./scripts/last_release_commits.sh \
+      --package-name="design-system-automator"
+END
+}
+
+# Returns all commits between two most recent (SemVer) tags
+# without 'chore' commits
+#
+# Usage:
+# get_commits_for_version_tags version_tag_end version_tag_start directory
+function get_commits_for_version_tags() {
+  local last_version="$1"
+  local version_before_last="$2"
+  local package_directory="$3"
+
+  local version_compare_string="$last_version...$version_before_last"
+
+  # Initial version, return just commits for that version, from the directory
+  # of the package
+  if [[ "$last_version" == "$version_before_last" ]]; then
+    version_compare_string="$last_version"
+  fi
+
+  git log "$version_compare_string" --pretty='format:%s' "$package_directory" \
+    | grep --invert-match --extended-regexp 'chore(\(|:)'
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if [ -z ${PROCESS_ARGUMENTS['--package-name']} ]; then
+    printf "No package name provided. Run with '--help' for more information\n"
+    exit 1
+  fi
+
+  package_name=${PROCESS_ARGUMENTS['--package-name']}
+
+  package_directory=${PROCESS_ARGUMENTS['--package-directory']:-"./packages/$package_name"}
+
+  all_tagged_versions="$(git --no-pager tag --list "$package_name-[0-9]*" \
+    | grep --invert-match '\-rc' \
+    |
+    # filter-out prereleases
+    sort --version-sort)"
+  version_count=$(echo "$all_tagged_versions" | wc --lines)
+
+  local -r last_version=$(echo "$all_tagged_versions" | tail -1)
+  local -r version_before_last=$(echo "$all_tagged_versions" | tail -2 | head -1)
+
+  if [[ "$last_version" == "$version_before_last" && "$version_count" > 1 ]]; then
+    printf "Found only one version tag (not searching through rc versions). Make sure you have two versions already published\n" 1>&2
+    exit 1
+  fi
+
+  local combined_git_log_output=""
+
+  git_log_output_for_package=$(get_commits_for_version_tags \
+    "$last_version" "$version_before_last" "$package_directory")
+
+  combined_git_log_output=$(echo -e "$combined_git_log_output\n$git_log_output_for_package")
+
+  if [ -z "${combined_git_log_output}" ]; then
+    printf "Returning empty list of commits between versions %s and %s\n" \
+      "$last_version" \
+      "$version_before_last" 1>&2
+
+    exit 0
+  fi
+
+  echo -e "$combined_git_log_output" \
+    | sed '/^$/d' # remove empty lines
+}
+
+main "$@"

package/list_all_installed_dependencies/list_all_installed_dependencies.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help]
+Where:
+  help - print usage information and exit
+Description:
+  Lists all dependencies installed in the monorepo
+  as well as in the packages. Run at the root level.
+END
+}
+
+function list_dependencies() {
+  FORCE_COLOR=0 yarn info --recursive --dependents
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  # Top-level directory node_modules
+  list_dependencies
+
+  # Workspaces (packages/workspace_name)
+  for workspace in $(ls -1 packages/); do
+    pushd "packages/""$workspace" > /dev/null || exit
+    printf "packages/""$workspace"
+    list_dependencies
+    popd > /dev/null || exit
+  done
+}
+
+main "$@"

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@mservices-tech/scripts",
+  "version": "3.2.2",
+  "license": "MIT",
+  "packageManager": "yarn@4.4.1",
+  "bin": {
+    "scripts": "runShellScript/runShellScript.js"
+  },
+  "dependencies": {
+    "esbuild": "0.24.0",
+    "prettier": "3.2.5",
+    "standard-version": "9.5.0"
+  }
+}

package/prepare_obligatory_package_files/prepare_obligatory_package_files.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ./prepare_obligatory_package_files.sh [--help]
+Where:
+  help - print usage information and exit
+Description:
+  Creates obligatory package files in the 'build' directory:
+  1. Modifies build/package.json for release by removing fields not needed
+     in the release package, and adjusting the public page name.
+  2. Copies CHANGELOG.md to that directory
+  3. Copies LICENSE to that directory
+     (if there is LICENSE provided for that package)
+END
+}
+
+function modify_package_json_for_release() {
+  printf "Modifying build/package.json for release...\n"
+
+  # yarn resolves the package name into a link to the monorepo - changing the package
+  # name is required in order to avoid this problem, and to be able to use the copy
+  # from the public npm registry
+  jq --raw-output \
+    'del( .devDependencies, .eslintConfig, .prettier, .publishConfig, .repository, .scripts ) | .name = (.name | sub("-development$" ; ""))' \
+    package.json > build/package.json
+}
+
+function copy_changelog_to_build() {
+  if [ ! -f CHANGELOG.md ]; then
+    printf "No CHANGELOG.md found. You need to create a changelog in order to release a package. Exiting\n"
+    exit 1
+  fi
+
+  cp CHANGELOG.md build/
+}
+
+function copy_license_to_build() {
+  if [ ! -f LICENSE ]; then
+    printf "No LICENSE found, moving to the next step\n"
+  else
+    cp LICENSE build/
+  fi
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  modify_package_json_for_release
+  copy_license_to_build
+  copy_changelog_to_build
+}
+
+main "$@"

package/publish/publish.sh

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+
+source "$(dirname "$0")/../utils.sh" || exit 1
+
+PUBLIC_NPMRC=".npmrc.public"
+PRIVATE_NPMRC=".npmrc.private"
+
+function usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] [--public] [--second-private-scope="scope_name_starting_with_at_sign"]
+Where:
+  help                  - show usage information and exit
+  public                - publish the package into the public
+                          NPM registry
+  second-private-scope  - name of a second private scope that we want to
+                          publish in, e.g.
+                          --second-private-scope="@mservicestech"
+                          Useful when private package needs to be published
+                          with same version and same contents with more than
+                          one package scope
+
+Description:
+  Publishes the package into a selected package registry.
+  By default, the script published as a private package.
+  Requires two '.npmrc' configurations to be present:
+    - .npmrc.public
+    - .npmrc.private
+  These files must point to publicly available registry,
+  and a private package registry (e.g. GitHub) respectively.
+END
+}
+
+function use_npmrc() {
+  if ! [ -f "$1" ]; then
+    printf "Could not find '%s'. Run with '--help' for more information.\n" "$1"
+    exit 1
+  fi
+
+  \cp "$1" build/.npmrc
+}
+
+function failure_handler() {
+  printf "Publishing failed. See the logs.\n"
+  exit 1
+}
+
+function get_npm_tag() {
+  local version=$(jq -r '.version' build/package.json)
+  if [[ "$version" == *"-rc."* ]]; then
+    echo "rc"
+  else
+    echo "latest"
+  fi
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  # Get the appropriate npm tag based on version
+  local npm_tag=$(get_npm_tag)
+
+  # Scripts decides to which registry package should be pushed based
+  # on namespace from build/package.json 'name' field and based on used
+  # .npmrc file
+  if [ ${PROCESS_ARGUMENTS['--public']} ]; then
+    use_npmrc "$PUBLIC_NPMRC"
+    pushd build
+    npm publish --access public --tag "$npm_tag" || failure_handler
+  elif [ ${PROCESS_ARGUMENTS['--second-private-scope']} ]; then
+    # We assume second private scope has already been changed in
+    # build/package.json and package is ready to be published with that scope
+    use_npmrc "$PRIVATE_NPMRC"
+    pushd build
+    npm publish --tag "$npm_tag" || failure_handler
+  else
+    use_npmrc "$PRIVATE_NPMRC"
+    pushd build
+    npm publish --tag "$npm_tag" || failure_handler
+  fi
+
+  popd
+}
+
+main "$@"