commit-code-check.sh

#!/bin/bash
#
# This script performs code quality checks.
#
# @internal
#   This script is not covered by Drupal core's backwards compatibility promise.
#   It exists only for core development purposes.
#
# The script makes the following checks:
# - Spell checking.
# - File modes.
# - No changes to core/node_modules directory.
# - PHPCS checks PHP and YAML files.
# - PHPStan checks PHP files.
# - ESLint checks JavaScript and YAML files.
# - Stylelint checks CSS files.
# - Checks .pcss.css and .css files are equivalent.

# cSpell:disable

# Searches an array.
contains_element() {
  local e
  for e in ${@:2}; do [[ "$e" == "$1" ]] && return 0; done
  return 1
}

MEMORY_UNLIMITED=0
CACHED=0
DRUPALCI=0
BRANCH=""
while test $# -gt 0; do
  case "$1" in
    -h|--help)
      echo "Drupal code quality checks"
      echo " "
      echo "options:"
      echo "-h, --help                show brief help"
      echo "--branch BRANCH           creates list of files to check by comparing against a branch"
      echo "--cached                  checks staged files"
      echo "--drupalci                a special mode for DrupalCI"
      echo "--memory-unlimited        bypass PHP memory limit for PHPStan and PHPCS"
      echo " "
      echo "Example usage: sh ./core/scripts/dev/commit-code-check.sh --branch 9.2.x"
      exit 0
      ;;
    --branch)
      BRANCH="$2"
      if [[ "$BRANCH" == "" ]]; then
        printf "The --branch option requires a value. For example: --branch 9.2.x\n"
        exit;
      fi
      shift 2
      ;;
    --cached)
      CACHED=1
      shift
      ;;
    --drupalci)
      DRUPALCI=1
      shift
      ;;
    --memory-unlimited)
      MEMORY_UNLIMITED=1
      shift
      ;;
    *)
      break
      ;;
  esac
done

memory_limit=""
phpcs_memory_limit=""

if [[ "$MEMORY_UNLIMITED" == "1" ]]; then
  memory_limit="--memory-limit=-1"
  phpcs_memory_limit="-d memory_limit=-1"
fi

# Set up variables to make colored output simple. Color output is disabled on
# DrupalCI because it is breaks reporting.
# @todo https://www.drupal.org/project/drupalci_testbot/issues/3181869
if [[ "$DRUPALCI" == "1" ]]; then
  red=""
  green=""
  reset=""
  DRUPAL_VERSION=$(php -r "include 'vendor/autoload.php'; print preg_replace('#\.[0-9]+-dev#', '.x', \Drupal::VERSION);")
  GIT="sudo -u www-data git"
else
  red=$(tput setaf 1 && tput bold)
  green=$(tput setaf 2)
  reset=$(tput sgr0)
  GIT="git"
fi

# Gets list of files to check.
if [[ "$BRANCH" != "" ]]; then
  FILES=$($GIT diff --name-only $BRANCH HEAD);
elif [[ "$CACHED" == "0" ]]; then
  # For DrupalCI patch testing or when running without --cached or --branch,
  # list of all changes in the working directory.
  FILES=$($GIT ls-files --other --modified --exclude-standard --exclude=vendor)
else
  # Check staged files only.
  if $GIT rev-parse --verify HEAD >/dev/null 2>&1
  then
    AGAINST=HEAD
  else
    # Initial commit: diff against an empty tree object
    AGAINST=4b825dc642cb6eb9a060e54bf8d69288fbee4904
  fi
  FILES=$($GIT diff --cached --name-only $AGAINST);
fi

if [[ "$FILES" == "" ]] && [[ "$DRUPALCI" == "1" ]]; then
  # If the FILES is empty we might be testing a merge request on DrupalCI. We
  # need to diff against the Drupal branch or tag related to the Drupal version.
  printf "Creating list of files to check by comparing branch to %s\n" "$DRUPAL_VERSION"
  # On DrupalCI there's a merge commit so we can compare to HEAD~1.
  FILES=$($GIT diff --name-only HEAD~1 HEAD);
fi

TOP_LEVEL=$($GIT rev-parse --show-toplevel)

# This variable will be set to one when the file core/phpcs.xml.dist is changed.
PHPCS_XML_DIST_FILE_CHANGED=0

# This variable will be set to one when the files core/.phpstan-baseline.php or
# core/phpstan.neon.dist are changed.
PHPSTAN_DIST_FILE_CHANGED=0

# This variable will be set to one when one of the eslint config file is
# changed:
#  - core/.eslintrc.passing.json
#  - core/.eslintrc.json
#  - core/.eslintrc.jquery.json
ESLINT_CONFIG_PASSING_FILE_CHANGED=0

# This variable will be set to one when the stylelint config file is changed.
# changed:
#  - core/.stylelintignore
#  - core/.stylelintrc.json
STYLELINT_CONFIG_FILE_CHANGED=0

# This variable will be set to one when JavaScript packages files are changed.
# changed:
#  - core/package.json
#  - core/yarn.lock
JAVASCRIPT_PACKAGES_CHANGED=0

# This variable will be set when a Drupal-specific CKEditor 5 plugin has changed
# it is used to make sure the compiled JS is valid.
CKEDITOR5_PLUGINS_CHANGED=0

# This variable will be set to one when either of the core dictionaries or the
# .cspell.json config has changed.
CSPELL_DICTIONARY_FILE_CHANGED=0

# Build up a list of absolute file names.
ABS_FILES=
for FILE in $FILES; do
  if [ -f "$TOP_LEVEL/$FILE" ]; then
    ABS_FILES="$ABS_FILES $TOP_LEVEL/$FILE"
  fi

  if [[ $FILE == "core/phpcs.xml.dist" ]]; then
    PHPCS_XML_DIST_FILE_CHANGED=1;
  fi;

  if [[ $FILE == "core/.phpstan-baseline.php" || $FILE == "core/phpstan.neon.dist" ]]; then
    PHPSTAN_DIST_FILE_CHANGED=1;
  fi;

  if [[ $FILE == "core/.eslintrc.json" || $FILE == "core/.eslintrc.passing.json" || $FILE == "core/.eslintrc.jquery.json" ]]; then
    ESLINT_CONFIG_PASSING_FILE_CHANGED=1;
  fi;

  if [[ $FILE == "core/.stylelintignore" || $FILE == "core/.stylelintrc.json" ]]; then
    STYLELINT_CONFIG_FILE_CHANGED=1;
  fi;

  # If JavaScript packages change, then rerun all JavaScript style checks.
  if [[ $FILE == "core/package.json" || $FILE == "core/yarn.lock" ]]; then
    ESLINT_CONFIG_PASSING_FILE_CHANGED=1;
    STYLELINT_CONFIG_FILE_CHANGED=1;
    JAVASCRIPT_PACKAGES_CHANGED=1;
  fi;

  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ $FILE =~ ^core/modules/ckeditor5/js/build || $FILE =~ ^core/modules/ckeditor5/js/ckeditor5_plugins ]]; then
    CKEDITOR5_PLUGINS_CHANGED=1;
  fi;

  if [[ $FILE == "core/misc/cspell/dictionary.txt" || $FILE == "core/misc/cspell/drupal-dictionary.txt" || $FILE == "core/.cspell.json" ]]; then
    CSPELL_DICTIONARY_FILE_CHANGED=1;
  fi
done

# Exit early if there are no files.
if [[ "$ABS_FILES" == "" ]]; then
  printf "There are no files to check. If you have staged a commit use the --cached option.\n"
  exit;
fi;

# This script assumes that composer install and yarn install have already been
# run and all dependencies are updated.
FINAL_STATUS=0

DEPENDENCIES_NEED_INSTALLING=0
# Ensure PHP development dependencies are installed.
# @todo https://github.com/composer/composer/issues/4497 Improve this to
#  determine if dependencies in the lock file match the installed versions.
#  Using composer install --dry-run is not valid because it would depend on
#  user-facing strings in Composer.
if ! [[ -f 'vendor/bin/phpcs' ]]; then
  printf "Drupal's PHP development dependencies are not installed. Run 'composer install' from the root directory.\n"
  DEPENDENCIES_NEED_INSTALLING=1;
fi

cd "$TOP_LEVEL/core"

# Ensure JavaScript development dependencies are installed.
yarn --version
yarn >/dev/null

# Check all files for spelling in one go for better performance.
if [[ $CSPELL_DICTIONARY_FILE_CHANGED == "1" ]] ; then
  printf "\nRunning spellcheck on *all* files.\n"
  yarn run spellcheck:core --no-must-find-files --no-progress
else
  # Check all files for spelling in one go for better performance. We pipe the
  # list files in so we obey the globs set on the spellcheck:core command in
  # core/package.json.
  echo "${ABS_FILES}" | tr ' ' '\n' | yarn run spellcheck:core --no-must-find-files --file-list stdin
fi

if [ "$?" -ne "0" ]; then
  # If there are failures set the status to a number other than 0.
  FINAL_STATUS=1
  printf "\nCSpell: ${red}failed${reset}\n"
else
  printf "\nCSpell: ${green}passed${reset}\n"
fi
cd "$TOP_LEVEL"

# Add a separator line to make the output easier to read.
printf "\n"
printf -- '-%.0s' {1..100}
printf "\n"

# Run PHPStan on all files on DrupalCI or when phpstan files are changed.
# APCu is disabled to ensure that the composer classmap is not corrupted.
if [[ $PHPSTAN_DIST_FILE_CHANGED == "1" ]] || [[ "$DRUPALCI" == "1" ]]; then
  printf "\nRunning PHPStan on *all* files.\n"
  php -d apc.enabled=0 -d apc.enable_cli=0 vendor/bin/phpstan analyze --no-progress --configuration="$TOP_LEVEL/core/phpstan.neon.dist" $memory_limit
else
  # Only run PHPStan on changed files locally.
  printf "\nRunning PHPStan on changed files.\n"
  php -d apc.enabled=0 -d apc.enable_cli=0 vendor/bin/phpstan analyze --no-progress --configuration="$TOP_LEVEL/core/phpstan-partial.neon" $ABS_FILES $memory_limit
fi

if [ "$?" -ne "0" ]; then
  # If there are failures set the status to a number other than 0.
  FINAL_STATUS=1
  printf "\nPHPStan: ${red}failed${reset}\n"
else
  printf "\nPHPStan: ${green}passed${reset}\n"
fi

# Add a separator line to make the output easier to read.
printf "\n"
printf -- '-%.0s' {1..100}
printf "\n"

# Run PHPCS on all files on DrupalCI or when phpcs files are changed.
if [[ $PHPCS_XML_DIST_FILE_CHANGED == "1" ]] || [[ "$DRUPALCI" == "1" ]]; then
  # Test all files with phpcs rules.
  vendor/bin/phpcs $phpcs_memory_limit -ps --parallel="$( (nproc || sysctl -n hw.logicalcpu || echo 4) 2>/dev/null)" --standard="$TOP_LEVEL/core/phpcs.xml.dist"
  PHPCS=$?
  if [ "$PHPCS" -ne "0" ]; then
    # If there are failures set the status to a number other than 0.
    FINAL_STATUS=1
    printf "\nPHPCS: ${red}failed${reset}\n"
  else
    printf "\nPHPCS: ${green}passed${reset}\n"
  fi
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

# When the eslint config has been changed, then eslint must check all files.
if [[ $ESLINT_CONFIG_PASSING_FILE_CHANGED == "1" ]]; then
  cd "$TOP_LEVEL/core"
  yarn run lint:core-js-passing "$TOP_LEVEL/core"
  CORRECTJS=$?
  if [ "$CORRECTJS" -ne "0" ]; then
    # If there are failures set the status to a number other than 0.
    FINAL_STATUS=1
    printf "\neslint: ${red}failed${reset}\n"
  else
    printf "\neslint: ${green}passed${reset}\n"
  fi
  cd $TOP_LEVEL
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

# When the stylelint config has been changed, then stylelint must check all files.
if [[ $STYLELINT_CONFIG_FILE_CHANGED == "1" ]]; then
  cd "$TOP_LEVEL/core"
  yarn run lint:css
  if [ "$?" -ne "0" ]; then
    # If there are failures set the status to a number other than 0.
    FINAL_STATUS=1
    printf "\nstylelint: ${red}failed${reset}\n"
  else
    printf "\nstylelint: ${green}passed${reset}\n"
  fi
  cd $TOP_LEVEL
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

# When a Drupal-specific CKEditor 5 plugin changed ensure that it is compiled
# properly. Only check on DrupalCI, since we're concerned about the build being
# run with the expected package versions and making sure the result of the build
# is in sync and conform to expectations.
if [[ "$DRUPALCI" == "1" ]] && [[ $CKEDITOR5_PLUGINS_CHANGED == "1" ]]; then
  cd "$TOP_LEVEL/core"
  yarn run check:ckeditor5
  if [ "$?" -ne "0" ]; then
    # If there are failures set the status to a number other than 0.
    FINAL_STATUS=1
    printf "\nDrupal-specific CKEditor 5 plugins: ${red}failed${reset}\n"
  else
    printf "\nDrupal-specific CKEditor 5 plugins: ${green}passed${reset}\n"
  fi
  cd $TOP_LEVEL
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

# When JavaScript packages change, then rerun all JavaScript style checks.
if [[ "$JAVASCRIPT_PACKAGES_CHANGED" == "1" ]]; then
  cd "$TOP_LEVEL/core"
  yarn run build:css --check
  CORRECTCSS=$?
  if [ "$CORRECTCSS" -ne "0" ]; then
    FINAL_STATUS=1
    printf "\n${red}ERROR: The compiled CSS from the PCSS files"
    printf "\n       does not match the current CSS files. Some added"
    printf "\n       or updated JavaScript package made changes."
    printf "\n       Recompile the CSS with: yarn run build:css${reset}\n\n"
  fi
  cd $TOP_LEVEL
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

for FILE in $FILES; do
  STATUS=0;
  # Print a line to separate spellcheck output from per file output.
  printf "Checking %s\n" "$FILE"
  printf "\n"

  # Ensure the file still exists (i.e. is not being deleted).
  if [ -a $FILE ]; then
    if [ ${FILE: -3} != ".sh" ]; then
      if [ -x $FILE ]; then
        printf "${red}check failed:${reset} file $FILE should not be executable\n"
        STATUS=1
      fi
    fi
  fi

  # Don't commit changes to vendor.
  if [[ "$FILE" =~ ^vendor/ ]]; then
    printf "${red}check failed:${reset} file in vendor directory being committed ($FILE)\n"
    STATUS=1
  fi

  # Don't commit changes to core/node_modules.
  if [[ "$FILE" =~ ^core/node_modules/ ]]; then
    printf "${red}check failed:${reset} file in core/node_modules directory being committed ($FILE)\n"
    STATUS=1
  fi

  ############################################################################
  ### PHP AND YAML FILES
  ############################################################################
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.(inc|install|module|php|profile|test|theme|yml)$ ]] && [[ $PHPCS_XML_DIST_FILE_CHANGED == "0" ]] && [[ "$DRUPALCI" == "0" ]]; then
    # Test files with phpcs rules.
    vendor/bin/phpcs $phpcs_memory_limit "$TOP_LEVEL/$FILE" --standard="$TOP_LEVEL/core/phpcs.xml.dist"
    PHPCS=$?
    if [ "$PHPCS" -ne "0" ]; then
      # If there are failures set the status to a number other than 0.
      STATUS=1
    else
      printf "PHPCS: $FILE ${green}passed${reset}\n"
    fi
  fi

  ############################################################################
  ### YAML FILES
  ############################################################################
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.yml$ ]]; then
    # Test files with ESLint.
    cd "$TOP_LEVEL/core"
    node ./node_modules/eslint/bin/eslint.js --quiet --resolve-plugins-relative-to . "$TOP_LEVEL/$FILE"
    YAMLLINT=$?
    if [ "$YAMLLINT" -ne "0" ]; then
      # If there are failures set the status to a number other than 0.
      STATUS=1
    else
      printf "ESLint: $FILE ${green}passed${reset}\n"
    fi
    cd $TOP_LEVEL
  fi

  ############################################################################
  ### JAVASCRIPT FILES
  ############################################################################
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]]; then
    cd "$TOP_LEVEL/core"
    # Check the coding standards.
    node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json "$TOP_LEVEL/$FILE"
    JSLINT=$?
    if [ "$JSLINT" -ne "0" ]; then
      # No need to write any output the node command will do this for us.
      STATUS=1
    else
      printf "ESLint: $FILE ${green}passed${reset}\n"
    fi
    cd $TOP_LEVEL
  fi

  ############################################################################
  ### CSS FILES
  ############################################################################
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.css$ ]]; then
    # Work out the root name of the CSS so we can ensure that the PostCSS
    # version has been compiled correctly.
    if [[ $FILE =~ \.pcss\.css$ ]]; then
      BASENAME=${FILE%.pcss.css}
      COMPILE_CHECK=1
    else
      BASENAME=${FILE%.css}
      # We only need to compile check if the .pcss.css file is not also
      # changing. This is because the compile check will occur for the
      # .pcss.css file. This might occur if the compiled stylesheets have
      # changed.
      contains_element "$BASENAME.pcss.css" "${FILES[@]}"
      HASPOSTCSS=$?
      if [ "$HASPOSTCSS" -ne "0" ]; then
        COMPILE_CHECK=1
      else
        COMPILE_CHECK=0
      fi
    fi
    # PostCSS
    if [[ "$COMPILE_CHECK" == "1" ]] && [[ -f "$TOP_LEVEL/$BASENAME.pcss.css" ]]; then
      cd "$TOP_LEVEL/core"
      yarn run build:css --check --file "$TOP_LEVEL/$BASENAME.pcss.css"
      CORRECTCSS=$?
      if [ "$CORRECTCSS" -ne "0" ]; then
        # If the CSS does not match the PCSS, set the status to a number other
        # than 0.
        STATUS=1
        printf "\n${red}ERROR: The compiled CSS from"
        printf "\n       ${BASENAME}.pcss.css"
        printf "\n       does not match its CSS file. Recompile the CSS with:"
        printf "\n       yarn run build:css${reset}\n\n"
      fi
      cd $TOP_LEVEL
    fi
  fi
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.css$ ]] && [[ -f "core/node_modules/.bin/stylelint" ]]; then
    BASENAME=${FILE%.css}
    # We only need to use stylelint on the .pcss.css file. So if this CSS file
    # has a corresponding .pcss don't do stylelint.
    if [[ $FILE =~ \.pcss\.css$ ]] || [[ ! -f "$TOP_LEVEL/$BASENAME.pcss.css" ]]; then
      cd "$TOP_LEVEL/core"
      node_modules/.bin/stylelint --allow-empty-input "$TOP_LEVEL/$FILE"
      if [ "$?" -ne "0" ]; then
        STATUS=1
      else
        printf "STYLELINT: $FILE ${green}passed${reset}\n"
      fi
      cd $TOP_LEVEL
    fi
  fi

  if [[ "$STATUS" == "1" ]]; then
    FINAL_STATUS=1
    # There is no need to print a failure message. The fail will be described
    # already.
  else
    printf "%s ${green}passed${reset}\n" "$FILE"
  fi

  # Print a line to separate each file's checks.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
done

if [[ "$FINAL_STATUS" == "1" ]] && [[ "$DRUPALCI" == "1" ]]; then
  printf "${red}Drupal code quality checks failed.${reset}\n"
  printf "To reproduce this output locally:\n"
  printf "* Apply the change as a patch\n"
  printf "* Run this command locally: sh ./core/scripts/dev/commit-code-check.sh\n"
  printf "OR:\n"
  printf "* From the merge request branch\n"
  printf "* Run this command locally: sh ./core/scripts/dev/commit-code-check.sh --branch %s\n" "$DRUPAL_VERSION"
fi
exit $FINAL_STATUS

File

View on git.drupalcode.org

core/scripts/dev/commit-code-check.sh

View source 
  1. #!/bin/bash

  2. #

  3. # This script performs code quality checks.

  4. #

  5. # @internal

  6. #   This script is not covered by Drupal core's backwards compatibility promise.

  7. #   It exists only for core development purposes.

  8. #

  9. # The script makes the following checks:

  10. # - Spell checking.

  11. # - File modes.

  12. # - No changes to core/node_modules directory.

  13. # - PHPCS checks PHP and YAML files.

  14. # - PHPStan checks PHP files.

  15. # - ESLint checks JavaScript and YAML files.

  16. # - Stylelint checks CSS files.

  17. # - Checks .pcss.css and .css files are equivalent.

  18. 

  19. # cSpell:disable

  20. 

  21. # Searches an array.

  22. contains_element() {

  23.   local e

  24.   for e in ${@:2}; do [[ "$e" == "$1" ]] && return 0; done

  25.   return 1

  26. }

  27. 

  28. MEMORY_UNLIMITED=0

  29. CACHED=0

  30. DRUPALCI=0

  31. BRANCH=""

  32. while test $# -gt 0; do

  33.   case "$1" in

  34.     -h|--help)

  35.       echo "Drupal code quality checks"

  36.       echo " "

  37.       echo "options:"

  38.       echo "-h, --help                show brief help"

  39.       echo "--branch BRANCH           creates list of files to check by comparing against a branch"

  40.       echo "--cached                  checks staged files"

  41.       echo "--drupalci                a special mode for DrupalCI"

  42.       echo "--memory-unlimited        bypass PHP memory limit for PHPStan and PHPCS"

  43.       echo " "

  44.       echo "Example usage: sh ./core/scripts/dev/commit-code-check.sh --branch 9.2.x"

  45.       exit 0

  46.       ;;

  47.     --branch)

  48.       BRANCH="$2"

  49.       if [[ "$BRANCH" == "" ]]; then

  50.         printf "The --branch option requires a value. For example: --branch 9.2.x\n"

  51.         exit;

  52.       fi

  53.       shift 2

  54.       ;;

  55.     --cached)

  56.       CACHED=1

  57.       shift

  58.       ;;

  59.     --drupalci)

  60.       DRUPALCI=1

  61.       shift

  62.       ;;

  63.     --memory-unlimited)

  64.       MEMORY_UNLIMITED=1

  65.       shift

  66.       ;;

  67.     *)

  68.       break

  69.       ;;

  70.   esac

  71. done

  72. 

  73. memory_limit=""

  74. phpcs_memory_limit=""

  75. 

  76. if [[ "$MEMORY_UNLIMITED" == "1" ]]; then

  77.   memory_limit="--memory-limit=-1"

  78.   phpcs_memory_limit="-d memory_limit=-1"

  79. fi

  80. 

  81. # Set up variables to make colored output simple. Color output is disabled on

  82. # DrupalCI because it is breaks reporting.

  83. # @todo https://www.drupal.org/project/drupalci_testbot/issues/3181869

  84. if [[ "$DRUPALCI" == "1" ]]; then

  85.   red=""

  86.   green=""

  87.   reset=""

  88.   DRUPAL_VERSION=$(php -r "include 'vendor/autoload.php'; print preg_replace('#\.[0-9]+-dev#', '.x', \Drupal::VERSION);")

  89.   GIT="sudo -u www-data git"

  90. else

  91.   red=$(tput setaf 1 && tput bold)

  92.   green=$(tput setaf 2)

  93.   reset=$(tput sgr0)

  94.   GIT="git"

  95. fi

  96. 

  97. # Gets list of files to check.

  98. if [[ "$BRANCH" != "" ]]; then

  99.   FILES=$($GIT diff --name-only $BRANCH HEAD);

  100. elif [[ "$CACHED" == "0" ]]; then

  101.   # For DrupalCI patch testing or when running without --cached or --branch,

  102.   # list of all changes in the working directory.

  103.   FILES=$($GIT ls-files --other --modified --exclude-standard --exclude=vendor)

  104. else

  105.   # Check staged files only.

  106.   if $GIT rev-parse --verify HEAD >/dev/null 2>&1

  107.   then

  108.     AGAINST=HEAD

  109.   else

  110.     # Initial commit: diff against an empty tree object

  111.     AGAINST=4b825dc642cb6eb9a060e54bf8d69288fbee4904

  112.   fi

  113.   FILES=$($GIT diff --cached --name-only $AGAINST);

  114. fi

  115. 

  116. if [[ "$FILES" == "" ]] && [[ "$DRUPALCI" == "1" ]]; then

  117.   # If the FILES is empty we might be testing a merge request on DrupalCI. We

  118.   # need to diff against the Drupal branch or tag related to the Drupal version.

  119.   printf "Creating list of files to check by comparing branch to %s\n" "$DRUPAL_VERSION"

  120.   # On DrupalCI there's a merge commit so we can compare to HEAD~1.

  121.   FILES=$($GIT diff --name-only HEAD~1 HEAD);

  122. fi

  123. 

  124. TOP_LEVEL=$($GIT rev-parse --show-toplevel)

  125. 

  126. # This variable will be set to one when the file core/phpcs.xml.dist is changed.

  127. PHPCS_XML_DIST_FILE_CHANGED=0

  128. 

  129. # This variable will be set to one when the files core/.phpstan-baseline.php or

  130. # core/phpstan.neon.dist are changed.

  131. PHPSTAN_DIST_FILE_CHANGED=0

  132. 

  133. # This variable will be set to one when one of the eslint config file is

  134. # changed:

  135. #  - core/.eslintrc.passing.json

  136. #  - core/.eslintrc.json

  137. #  - core/.eslintrc.jquery.json

  138. ESLINT_CONFIG_PASSING_FILE_CHANGED=0

  139. 

  140. # This variable will be set to one when the stylelint config file is changed.

  141. # changed:

  142. #  - core/.stylelintignore

  143. #  - core/.stylelintrc.json

  144. STYLELINT_CONFIG_FILE_CHANGED=0

  145. 

  146. # This variable will be set to one when JavaScript packages files are changed.

  147. # changed:

  148. #  - core/package.json

  149. #  - core/yarn.lock

  150. JAVASCRIPT_PACKAGES_CHANGED=0

  151. 

  152. # This variable will be set when a Drupal-specific CKEditor 5 plugin has changed

  153. # it is used to make sure the compiled JS is valid.

  154. CKEDITOR5_PLUGINS_CHANGED=0

  155. 

  156. # This variable will be set to one when either of the core dictionaries or the

  157. # .cspell.json config has changed.

  158. CSPELL_DICTIONARY_FILE_CHANGED=0

  159. 

  160. # Build up a list of absolute file names.

  161. ABS_FILES=

  162. for FILE in $FILES; do

  163.   if [ -f "$TOP_LEVEL/$FILE" ]; then

  164.     ABS_FILES="$ABS_FILES $TOP_LEVEL/$FILE"

  165.   fi

  166. 

  167.   if [[ $FILE == "core/phpcs.xml.dist" ]]; then

  168.     PHPCS_XML_DIST_FILE_CHANGED=1;

  169.   fi;

  170. 

  171.   if [[ $FILE == "core/.phpstan-baseline.php" || $FILE == "core/phpstan.neon.dist" ]]; then

  172.     PHPSTAN_DIST_FILE_CHANGED=1;

  173.   fi;

  174. 

  175.   if [[ $FILE == "core/.eslintrc.json" || $FILE == "core/.eslintrc.passing.json" || $FILE == "core/.eslintrc.jquery.json" ]]; then

  176.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  177.   fi;

  178. 

  179.   if [[ $FILE == "core/.stylelintignore" || $FILE == "core/.stylelintrc.json" ]]; then

  180.     STYLELINT_CONFIG_FILE_CHANGED=1;

  181.   fi;

  182. 

  183.   # If JavaScript packages change, then rerun all JavaScript style checks.

  184.   if [[ $FILE == "core/package.json" || $FILE == "core/yarn.lock" ]]; then

  185.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  186.     STYLELINT_CONFIG_FILE_CHANGED=1;

  187.     JAVASCRIPT_PACKAGES_CHANGED=1;

  188.   fi;

  189. 

  190.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ $FILE =~ ^core/modules/ckeditor5/js/build || $FILE =~ ^core/modules/ckeditor5/js/ckeditor5_plugins ]]; then

  191.     CKEDITOR5_PLUGINS_CHANGED=1;

  192.   fi;

  193. 

  194.   if [[ $FILE == "core/misc/cspell/dictionary.txt" || $FILE == "core/misc/cspell/drupal-dictionary.txt" || $FILE == "core/.cspell.json" ]]; then

  195.     CSPELL_DICTIONARY_FILE_CHANGED=1;

  196.   fi

  197. done

  198. 

  199. # Exit early if there are no files.

  200. if [[ "$ABS_FILES" == "" ]]; then

  201.   printf "There are no files to check. If you have staged a commit use the --cached option.\n"

  202.   exit;

  203. fi;

  204. 

  205. # This script assumes that composer install and yarn install have already been

  206. # run and all dependencies are updated.

  207. FINAL_STATUS=0

  208. 

  209. DEPENDENCIES_NEED_INSTALLING=0

  210. # Ensure PHP development dependencies are installed.

  211. # @todo https://github.com/composer/composer/issues/4497 Improve this to

  212. #  determine if dependencies in the lock file match the installed versions.

  213. #  Using composer install --dry-run is not valid because it would depend on

  214. #  user-facing strings in Composer.

  215. if ! [[ -f 'vendor/bin/phpcs' ]]; then

  216.   printf "Drupal's PHP development dependencies are not installed. Run 'composer install' from the root directory.\n"

  217.   DEPENDENCIES_NEED_INSTALLING=1;

  218. fi

  219. 

  220. cd "$TOP_LEVEL/core"

  221. 

  222. # Ensure JavaScript development dependencies are installed.

  223. yarn --version

  224. yarn >/dev/null

  225. 

  226. # Check all files for spelling in one go for better performance.

  227. if [[ $CSPELL_DICTIONARY_FILE_CHANGED == "1" ]] ; then

  228.   printf "\nRunning spellcheck on *all* files.\n"

  229.   yarn run spellcheck:core --no-must-find-files --no-progress

  230. else

  231.   # Check all files for spelling in one go for better performance. We pipe the

  232.   # list files in so we obey the globs set on the spellcheck:core command in

  233.   # core/package.json.

  234.   echo "${ABS_FILES}" | tr ' ' '\n' | yarn run spellcheck:core --no-must-find-files --file-list stdin

  235. fi

  236. 

  237. if [ "$?" -ne "0" ]; then

  238.   # If there are failures set the status to a number other than 0.

  239.   FINAL_STATUS=1

  240.   printf "\nCSpell: ${red}failed${reset}\n"

  241. else

  242.   printf "\nCSpell: ${green}passed${reset}\n"

  243. fi

  244. cd "$TOP_LEVEL"

  245. 

  246. # Add a separator line to make the output easier to read.

  247. printf "\n"

  248. printf -- '-%.0s' {1..100}

  249. printf "\n"

  250. 

  251. # Run PHPStan on all files on DrupalCI or when phpstan files are changed.

  252. # APCu is disabled to ensure that the composer classmap is not corrupted.

  253. if [[ $PHPSTAN_DIST_FILE_CHANGED == "1" ]] || [[ "$DRUPALCI" == "1" ]]; then

  254.   printf "\nRunning PHPStan on *all* files.\n"

  255.   php -d apc.enabled=0 -d apc.enable_cli=0 vendor/bin/phpstan analyze --no-progress --configuration="$TOP_LEVEL/core/phpstan.neon.dist" $memory_limit

  256. else

  257.   # Only run PHPStan on changed files locally.

  258.   printf "\nRunning PHPStan on changed files.\n"

  259.   php -d apc.enabled=0 -d apc.enable_cli=0 vendor/bin/phpstan analyze --no-progress --configuration="$TOP_LEVEL/core/phpstan-partial.neon" $ABS_FILES $memory_limit

  260. fi

  261. 

  262. if [ "$?" -ne "0" ]; then

  263.   # If there are failures set the status to a number other than 0.

  264.   FINAL_STATUS=1

  265.   printf "\nPHPStan: ${red}failed${reset}\n"

  266. else

  267.   printf "\nPHPStan: ${green}passed${reset}\n"

  268. fi

  269. 

  270. # Add a separator line to make the output easier to read.

  271. printf "\n"

  272. printf -- '-%.0s' {1..100}

  273. printf "\n"

  274. 

  275. # Run PHPCS on all files on DrupalCI or when phpcs files are changed.

  276. if [[ $PHPCS_XML_DIST_FILE_CHANGED == "1" ]] || [[ "$DRUPALCI" == "1" ]]; then

  277.   # Test all files with phpcs rules.

  278.   vendor/bin/phpcs $phpcs_memory_limit -ps --parallel="$( (nproc || sysctl -n hw.logicalcpu || echo 4) 2>/dev/null)" --standard="$TOP_LEVEL/core/phpcs.xml.dist"

  279.   PHPCS=$?

  280.   if [ "$PHPCS" -ne "0" ]; then

  281.     # If there are failures set the status to a number other than 0.

  282.     FINAL_STATUS=1

  283.     printf "\nPHPCS: ${red}failed${reset}\n"

  284.   else

  285.     printf "\nPHPCS: ${green}passed${reset}\n"

  286.   fi

  287.   # Add a separator line to make the output easier to read.

  288.   printf "\n"

  289.   printf -- '-%.0s' {1..100}

  290.   printf "\n"

  291. fi

  292. 

  293. # When the eslint config has been changed, then eslint must check all files.

  294. if [[ $ESLINT_CONFIG_PASSING_FILE_CHANGED == "1" ]]; then

  295.   cd "$TOP_LEVEL/core"

  296.   yarn run lint:core-js-passing "$TOP_LEVEL/core"

  297.   CORRECTJS=$?

  298.   if [ "$CORRECTJS" -ne "0" ]; then

  299.     # If there are failures set the status to a number other than 0.

  300.     FINAL_STATUS=1

  301.     printf "\neslint: ${red}failed${reset}\n"

  302.   else

  303.     printf "\neslint: ${green}passed${reset}\n"

  304.   fi

  305.   cd $TOP_LEVEL

  306.   # Add a separator line to make the output easier to read.

  307.   printf "\n"

  308.   printf -- '-%.0s' {1..100}

  309.   printf "\n"

  310. fi

  311. 

  312. # When the stylelint config has been changed, then stylelint must check all files.

  313. if [[ $STYLELINT_CONFIG_FILE_CHANGED == "1" ]]; then

  314.   cd "$TOP_LEVEL/core"

  315.   yarn run lint:css

  316.   if [ "$?" -ne "0" ]; then

  317.     # If there are failures set the status to a number other than 0.

  318.     FINAL_STATUS=1

  319.     printf "\nstylelint: ${red}failed${reset}\n"

  320.   else

  321.     printf "\nstylelint: ${green}passed${reset}\n"

  322.   fi

  323.   cd $TOP_LEVEL

  324.   # Add a separator line to make the output easier to read.

  325.   printf "\n"

  326.   printf -- '-%.0s' {1..100}

  327.   printf "\n"

  328. fi

  329. 

  330. # When a Drupal-specific CKEditor 5 plugin changed ensure that it is compiled

  331. # properly. Only check on DrupalCI, since we're concerned about the build being

  332. # run with the expected package versions and making sure the result of the build

  333. # is in sync and conform to expectations.

  334. if [[ "$DRUPALCI" == "1" ]] && [[ $CKEDITOR5_PLUGINS_CHANGED == "1" ]]; then

  335.   cd "$TOP_LEVEL/core"

  336.   yarn run check:ckeditor5

  337.   if [ "$?" -ne "0" ]; then

  338.     # If there are failures set the status to a number other than 0.

  339.     FINAL_STATUS=1

  340.     printf "\nDrupal-specific CKEditor 5 plugins: ${red}failed${reset}\n"

  341.   else

  342.     printf "\nDrupal-specific CKEditor 5 plugins: ${green}passed${reset}\n"

  343.   fi

  344.   cd $TOP_LEVEL

  345.   # Add a separator line to make the output easier to read.

  346.   printf "\n"

  347.   printf -- '-%.0s' {1..100}

  348.   printf "\n"

  349. fi

  350. 

  351. # When JavaScript packages change, then rerun all JavaScript style checks.

  352. if [[ "$JAVASCRIPT_PACKAGES_CHANGED" == "1" ]]; then

  353.   cd "$TOP_LEVEL/core"

  354.   yarn run build:css --check

  355.   CORRECTCSS=$?

  356.   if [ "$CORRECTCSS" -ne "0" ]; then

  357.     FINAL_STATUS=1

  358.     printf "\n${red}ERROR: The compiled CSS from the PCSS files"

  359.     printf "\n       does not match the current CSS files. Some added"

  360.     printf "\n       or updated JavaScript package made changes."

  361.     printf "\n       Recompile the CSS with: yarn run build:css${reset}\n\n"

  362.   fi

  363.   cd $TOP_LEVEL

  364.   # Add a separator line to make the output easier to read.

  365.   printf "\n"

  366.   printf -- '-%.0s' {1..100}

  367.   printf "\n"

  368. fi

  369. 

  370. for FILE in $FILES; do

  371.   STATUS=0;

  372.   # Print a line to separate spellcheck output from per file output.

  373.   printf "Checking %s\n" "$FILE"

  374.   printf "\n"

  375. 

  376.   # Ensure the file still exists (i.e. is not being deleted).

  377.   if [ -a $FILE ]; then

  378.     if [ ${FILE: -3} != ".sh" ]; then

  379.       if [ -x $FILE ]; then

  380.         printf "${red}check failed:${reset} file $FILE should not be executable\n"

  381.         STATUS=1

  382.       fi

  383.     fi

  384.   fi

  385. 

  386.   # Don't commit changes to vendor.

  387.   if [[ "$FILE" =~ ^vendor/ ]]; then

  388.     printf "${red}check failed:${reset} file in vendor directory being committed ($FILE)\n"

  389.     STATUS=1

  390.   fi

  391. 

  392.   # Don't commit changes to core/node_modules.

  393.   if [[ "$FILE" =~ ^core/node_modules/ ]]; then

  394.     printf "${red}check failed:${reset} file in core/node_modules directory being committed ($FILE)\n"

  395.     STATUS=1

  396.   fi

  397. 

  398.   ############################################################################

  399.   ### PHP AND YAML FILES

  400.   ############################################################################

  401.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.(inc|install|module|php|profile|test|theme|yml)$ ]] && [[ $PHPCS_XML_DIST_FILE_CHANGED == "0" ]] && [[ "$DRUPALCI" == "0" ]]; then

  402.     # Test files with phpcs rules.

  403.     vendor/bin/phpcs $phpcs_memory_limit "$TOP_LEVEL/$FILE" --standard="$TOP_LEVEL/core/phpcs.xml.dist"

  404.     PHPCS=$?

  405.     if [ "$PHPCS" -ne "0" ]; then

  406.       # If there are failures set the status to a number other than 0.

  407.       STATUS=1

  408.     else

  409.       printf "PHPCS: $FILE ${green}passed${reset}\n"

  410.     fi

  411.   fi

  412. 

  413.   ############################################################################

  414.   ### YAML FILES

  415.   ############################################################################

  416.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.yml$ ]]; then

  417.     # Test files with ESLint.

  418.     cd "$TOP_LEVEL/core"

  419.     node ./node_modules/eslint/bin/eslint.js --quiet --resolve-plugins-relative-to . "$TOP_LEVEL/$FILE"

  420.     YAMLLINT=$?

  421.     if [ "$YAMLLINT" -ne "0" ]; then

  422.       # If there are failures set the status to a number other than 0.

  423.       STATUS=1

  424.     else

  425.       printf "ESLint: $FILE ${green}passed${reset}\n"

  426.     fi

  427.     cd $TOP_LEVEL

  428.   fi

  429. 

  430.   ############################################################################

  431.   ### JAVASCRIPT FILES

  432.   ############################################################################

  433.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]]; then

  434.     cd "$TOP_LEVEL/core"

  435.     # Check the coding standards.

  436.     node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json "$TOP_LEVEL/$FILE"

  437.     JSLINT=$?

  438.     if [ "$JSLINT" -ne "0" ]; then

  439.       # No need to write any output the node command will do this for us.

  440.       STATUS=1

  441.     else

  442.       printf "ESLint: $FILE ${green}passed${reset}\n"

  443.     fi

  444.     cd $TOP_LEVEL

  445.   fi

  446. 

  447.   ############################################################################

  448.   ### CSS FILES

  449.   ############################################################################

  450.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.css$ ]]; then

  451.     # Work out the root name of the CSS so we can ensure that the PostCSS

  452.     # version has been compiled correctly.

  453.     if [[ $FILE =~ \.pcss\.css$ ]]; then

  454.       BASENAME=${FILE%.pcss.css}

  455.       COMPILE_CHECK=1

  456.     else

  457.       BASENAME=${FILE%.css}

  458.       # We only need to compile check if the .pcss.css file is not also

  459.       # changing. This is because the compile check will occur for the

  460.       # .pcss.css file. This might occur if the compiled stylesheets have

  461.       # changed.

  462.       contains_element "$BASENAME.pcss.css" "${FILES[@]}"

  463.       HASPOSTCSS=$?

  464.       if [ "$HASPOSTCSS" -ne "0" ]; then

  465.         COMPILE_CHECK=1

  466.       else

  467.         COMPILE_CHECK=0

  468.       fi

  469.     fi

  470.     # PostCSS

  471.     if [[ "$COMPILE_CHECK" == "1" ]] && [[ -f "$TOP_LEVEL/$BASENAME.pcss.css" ]]; then

  472.       cd "$TOP_LEVEL/core"

  473.       yarn run build:css --check --file "$TOP_LEVEL/$BASENAME.pcss.css"

  474.       CORRECTCSS=$?

  475.       if [ "$CORRECTCSS" -ne "0" ]; then

  476.         # If the CSS does not match the PCSS, set the status to a number other

  477.         # than 0.

  478.         STATUS=1

  479.         printf "\n${red}ERROR: The compiled CSS from"

  480.         printf "\n       ${BASENAME}.pcss.css"

  481.         printf "\n       does not match its CSS file. Recompile the CSS with:"

  482.         printf "\n       yarn run build:css${reset}\n\n"

  483.       fi

  484.       cd $TOP_LEVEL

  485.     fi

  486.   fi

  487.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.css$ ]] && [[ -f "core/node_modules/.bin/stylelint" ]]; then

  488.     BASENAME=${FILE%.css}

  489.     # We only need to use stylelint on the .pcss.css file. So if this CSS file

  490.     # has a corresponding .pcss don't do stylelint.

  491.     if [[ $FILE =~ \.pcss\.css$ ]] || [[ ! -f "$TOP_LEVEL/$BASENAME.pcss.css" ]]; then

  492.       cd "$TOP_LEVEL/core"

  493.       node_modules/.bin/stylelint --allow-empty-input "$TOP_LEVEL/$FILE"

  494.       if [ "$?" -ne "0" ]; then

  495.         STATUS=1

  496.       else

  497.         printf "STYLELINT: $FILE ${green}passed${reset}\n"

  498.       fi

  499.       cd $TOP_LEVEL

  500.     fi

  501.   fi

  502. 

  503.   if [[ "$STATUS" == "1" ]]; then

  504.     FINAL_STATUS=1

  505.     # There is no need to print a failure message. The fail will be described

  506.     # already.

  507.   else

  508.     printf "%s ${green}passed${reset}\n" "$FILE"

  509.   fi

  510. 

  511.   # Print a line to separate each file's checks.

  512.   printf "\n"

  513.   printf -- '-%.0s' {1..100}

  514.   printf "\n"

  515. done

  516. 

  517. if [[ "$FINAL_STATUS" == "1" ]] && [[ "$DRUPALCI" == "1" ]]; then

  518.   printf "${red}Drupal code quality checks failed.${reset}\n"

  519.   printf "To reproduce this output locally:\n"

  520.   printf "* Apply the change as a patch\n"

  521.   printf "* Run this command locally: sh ./core/scripts/dev/commit-code-check.sh\n"

  522.   printf "OR:\n"

  523.   printf "* From the merge request branch\n"

  524.   printf "* Run this command locally: sh ./core/scripts/dev/commit-code-check.sh --branch %s\n" "$DRUPAL_VERSION"

  525. fi

  526. exit $FINAL_STATUS

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.