commit-code-check.sh

Same filename in other branches
  1. 9 core/scripts/dev/commit-code-check.sh
  2. 8.9.x core/scripts/dev/commit-code-check.sh
  3. 11.x core/scripts/dev/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
}

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 " "
      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
      ;;
    *)
      break
      ;;
  esac
done

# 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 when the dictionary 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" ]]; 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 check -s 2>/dev/null
if [ "$?" -ne "0" ]; then
  printf "Drupal's JavaScript development dependencies are not installed or cannot be resolved. Run 'yarn install' inside the core directory, or 'yarn check -s' to list other errors.\n"
  DEPENDENCIES_NEED_INSTALLING=1;
fi

if [ $DEPENDENCIES_NEED_INSTALLING -ne 0 ]; then
  exit 1;
fi

# 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 -s 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 -s 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"
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
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 -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 -s 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 -s 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 -s 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 "$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

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. CACHED=0

  29. DRUPALCI=0

  30. BRANCH=""

  31. while test $# -gt 0; do

  32.   case "$1" in

  33.     -h|--help)

  34.       echo "Drupal code quality checks"

  35.       echo " "

  36.       echo "options:"

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

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

  39.       echo "--cached                  checks staged files"

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

  41.       echo " "

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

  43.       exit 0

  44.       ;;

  45.     --branch)

  46.       BRANCH="$2"

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

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

  49.         exit;

  50.       fi

  51.       shift 2

  52.       ;;

  53.     --cached)

  54.       CACHED=1

  55.       shift

  56.       ;;

  57.     --drupalci)

  58.       DRUPALCI=1

  59.       shift

  60.       ;;

  61.     *)

  62.       break

  63.       ;;

  64.   esac

  65. done

  66. 

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

  68. # DrupalCI because it is breaks reporting.

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

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

  71.   red=""

  72.   green=""

  73.   reset=""

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

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

  76. else

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

  78.   green=$(tput setaf 2)

  79.   reset=$(tput sgr0)

  80.   GIT="git"

  81. fi

  82. 

  83. # Gets list of files to check.

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

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

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

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

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

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

  90. else

  91.   # Check staged files only.

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

  93.   then

  94.     AGAINST=HEAD

  95.   else

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

  97.     AGAINST=4b825dc642cb6eb9a060e54bf8d69288fbee4904

  98.   fi

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

  100. fi

  101. 

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

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

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

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

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

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

  108. fi

  109. 

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

  111. 

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

  113. PHPCS_XML_DIST_FILE_CHANGED=0

  114. 

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

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

  117. PHPSTAN_DIST_FILE_CHANGED=0

  118. 

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

  120. # changed:

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

  122. #  - core/.eslintrc.json

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

  124. ESLINT_CONFIG_PASSING_FILE_CHANGED=0

  125. 

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

  127. # changed:

  128. #  - core/.stylelintignore

  129. #  - core/.stylelintrc.json

  130. STYLELINT_CONFIG_FILE_CHANGED=0

  131. 

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

  133. # changed:

  134. #  - core/package.json

  135. #  - core/yarn.lock

  136. JAVASCRIPT_PACKAGES_CHANGED=0

  137. 

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

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

  140. CKEDITOR5_PLUGINS_CHANGED=0

  141. 

  142. # This variable will be set to when the dictionary has changed.

  143. CSPELL_DICTIONARY_FILE_CHANGED=0

  144. 

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

  146. ABS_FILES=

  147. for FILE in $FILES; do

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

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

  150.   fi

  151. 

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

  153.     PHPCS_XML_DIST_FILE_CHANGED=1;

  154.   fi;

  155. 

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

  157.     PHPSTAN_DIST_FILE_CHANGED=1;

  158.   fi;

  159. 

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

  161.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  162.   fi;

  163. 

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

  165.     STYLELINT_CONFIG_FILE_CHANGED=1;

  166.   fi;

  167. 

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

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

  170.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  171.     STYLELINT_CONFIG_FILE_CHANGED=1;

  172.     JAVASCRIPT_PACKAGES_CHANGED=1;

  173.   fi;

  174. 

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

  176.     CKEDITOR5_PLUGINS_CHANGED=1;

  177.   fi;

  178. 

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

  180.     CSPELL_DICTIONARY_FILE_CHANGED=1;

  181.   fi

  182. done

  183. 

  184. # Exit early if there are no files.

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

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

  187.   exit;

  188. fi;

  189. 

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

  191. # run and all dependencies are updated.

  192. FINAL_STATUS=0

  193. 

  194. DEPENDENCIES_NEED_INSTALLING=0

  195. # Ensure PHP development dependencies are installed.

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

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

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

  199. #  user-facing strings in Composer.

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

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

  202.   DEPENDENCIES_NEED_INSTALLING=1;

  203. fi

  204. 

  205. cd "$TOP_LEVEL/core"

  206. 

  207. # Ensure JavaScript development dependencies are installed.

  208. yarn check -s 2>/dev/null

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

  210.   printf "Drupal's JavaScript development dependencies are not installed or cannot be resolved. Run 'yarn install' inside the core directory, or 'yarn check -s' to list other errors.\n"

  211.   DEPENDENCIES_NEED_INSTALLING=1;

  212. fi

  213. 

  214. if [ $DEPENDENCIES_NEED_INSTALLING -ne 0 ]; then

  215.   exit 1;

  216. fi

  217. 

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

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

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

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

  222. else

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

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

  225.   # core/package.json.

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

  227. fi

  228. 

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

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

  231.   FINAL_STATUS=1

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

  233. else

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

  235. fi

  236. cd "$TOP_LEVEL"

  237. 

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

  239. printf "\n"

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

  241. printf "\n"

  242. 

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

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

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

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

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

  248. else

  249.   # Only run PHPStan on changed files locally.

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

  251.   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

  252. fi

  253. 

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

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

  256.   FINAL_STATUS=1

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

  258. else

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

  260. fi

  261. 

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

  263. printf "\n"

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

  265. printf "\n"

  266. 

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

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

  269.   # Test all files with phpcs rules.

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

  271.   PHPCS=$?

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

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

  274.     FINAL_STATUS=1

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

  276.   else

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

  278.   fi

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

  280.   printf "\n"

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

  282.   printf "\n"

  283. fi

  284. 

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

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

  287.   cd "$TOP_LEVEL/core"

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

  289.   CORRECTJS=$?

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

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

  292.     FINAL_STATUS=1

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

  294.   else

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

  296.   fi

  297.   cd $TOP_LEVEL

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

  299.   printf "\n"

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

  301.   printf "\n"

  302. fi

  303. 

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

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

  306.   cd "$TOP_LEVEL/core"

  307.   yarn run -s lint:css

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

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

  310.     FINAL_STATUS=1

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

  312.   else

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

  314.   fi

  315.   cd $TOP_LEVEL

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

  317.   printf "\n"

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

  319.   printf "\n"

  320. fi

  321. 

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

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

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

  325. # is in sync and conform to expectations.

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

  327.   cd "$TOP_LEVEL/core"

  328.   yarn run -s check:ckeditor5

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

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

  331.     FINAL_STATUS=1

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

  333.   else

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

  335.   fi

  336.   cd $TOP_LEVEL

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

  338.   printf "\n"

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

  340.   printf "\n"

  341. fi

  342. 

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

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

  345.   cd "$TOP_LEVEL/core"

  346.   yarn run build:css --check

  347.   CORRECTCSS=$?

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

  349.     FINAL_STATUS=1

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

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

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

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

  354.   fi

  355.   cd $TOP_LEVEL

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

  357.   printf "\n"

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

  359.   printf "\n"

  360. fi

  361. 

  362. for FILE in $FILES; do

  363.   STATUS=0;

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

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

  366.   printf "\n"

  367. 

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

  369.   if [ -a $FILE ]; then

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

  371.       if [ -x $FILE ]; then

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

  373.         STATUS=1

  374.       fi

  375.     fi

  376.   fi

  377. 

  378.   # Don't commit changes to vendor.

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

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

  381.     STATUS=1

  382.   fi

  383. 

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

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

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

  387.     STATUS=1

  388.   fi

  389. 

  390.   ############################################################################

  391.   ### PHP AND YAML FILES

  392.   ############################################################################

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

  394.     # Test files with phpcs rules.

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

  396.     PHPCS=$?

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

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

  399.       STATUS=1

  400.     else

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

  402.     fi

  403.   fi

  404. 

  405.   ############################################################################

  406.   ### YAML FILES

  407.   ############################################################################

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

  409.     # Test files with ESLint.

  410.     cd "$TOP_LEVEL/core"

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

  412.     YAMLLINT=$?

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

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

  415.       STATUS=1

  416.     else

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

  418.     fi

  419.     cd $TOP_LEVEL

  420.   fi

  421. 

  422.   ############################################################################

  423.   ### JAVASCRIPT FILES

  424.   ############################################################################

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

  426.     cd "$TOP_LEVEL/core"

  427.     # Check the coding standards.

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

  429.     JSLINT=$?

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

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

  432.       STATUS=1

  433.     else

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

  435.     fi

  436.     cd $TOP_LEVEL

  437.   fi

  438. 

  439.   ############################################################################

  440.   ### CSS FILES

  441.   ############################################################################

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

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

  444.     # version has been compiled correctly.

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

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

  447.       COMPILE_CHECK=1

  448.     else

  449.       BASENAME=${FILE%.css}

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

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

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

  453.       # changed.

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

  455.       HASPOSTCSS=$?

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

  457.         COMPILE_CHECK=1

  458.       else

  459.         COMPILE_CHECK=0

  460.       fi

  461.     fi

  462.     # PostCSS

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

  464.       cd "$TOP_LEVEL/core"

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

  466.       CORRECTCSS=$?

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

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

  469.         # than 0.

  470.         STATUS=1

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

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

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

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

  475.       fi

  476.       cd $TOP_LEVEL

  477.     fi

  478.   fi

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

  480.     BASENAME=${FILE%.css}

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

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

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

  484.       cd "$TOP_LEVEL/core"

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

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

  487.         STATUS=1

  488.       else

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

  490.       fi

  491.       cd $TOP_LEVEL

  492.     fi

  493.   fi

  494. 

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

  496.     FINAL_STATUS=1

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

  498.     # already.

  499.   else

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

  501.   fi

  502. 

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

  504.   printf "\n"

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

  506.   printf "\n"

  507. done

  508. 

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

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

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

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

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

  514.   printf "OR:\n"

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

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

  517. fi

  518. exit $FINAL_STATUS

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