commit-code-check.sh

Same filename in other branches
  1. 8.9.x core/scripts/dev/commit-code-check.sh
  2. 10 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.
# - ESLint checks JavaScript and YAML files.
# - Checks .es6.js and .js files are equivalent.
# - 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 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

# Build up a list of absolute file names.
ABS_FILES=
for FILE in $FILES; do
  ABS_FILES="$ABS_FILES $TOP_LEVEL/$FILE"

  if [[ $FILE == "core/phpcs.xml.dist" ]]; then
    PHPCS_XML_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;
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.
yarn run -s spellcheck --no-must-find-files -c $TOP_LEVEL/core/.cspell.json $ABS_FILES
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 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) --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
      # Ensure the file has the correct mode.
      STAT="$(stat -f "%A" $FILE 2>/dev/null)"
      if [ $? -ne 0 ]; then
        STAT="$(stat -c "%a" $FILE 2>/dev/null)"
      fi
      if [ "$STAT" -ne "644" ]; then
        printf "${red}check failed:${reset} file $FILE should be 644 not $STAT\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$ ]] && [[ ! $FILE =~ ^core/tests/Drupal/Nightwatch ]] && [[ ! $FILE =~ /tests/src/Nightwatch/ ]] && [[ ! $FILE =~ ^core/modules/ckeditor5/js/ckeditor5_plugins ]]; then
    # Work out the root name of the JavaScript so we can ensure that the ES6
    # version has been compiled correctly.
    if [[ $FILE =~ \.es6\.js$ ]]; then
      BASENAME=${FILE%.es6.js}
      COMPILE_CHECK=1
    else
      BASENAME=${FILE%.js}
      # We only need to compile check if the .es6.js file is not also
      # changing. This is because the compile check will occur for the
      # .es6.js file. This might occur if the compile scripts have changed.
      contains_element "$BASENAME.es6.js" "${FILES[@]}"
      HASES6=$?
      if [ "$HASES6" -ne "0" ]; then
        COMPILE_CHECK=1
      else
        COMPILE_CHECK=0
      fi
    fi
    if [[ "$COMPILE_CHECK" == "1" ]] && [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]]; then
      cd "$TOP_LEVEL/core"
      yarn run build:js --check --file "$TOP_LEVEL/$BASENAME.es6.js"
      CORRECTJS=$?
      if [ "$CORRECTJS" -ne "0" ]; then
        # No need to write any output the yarn run command will do this for
        # us.
        STATUS=1
      fi
      # Check the coding standards.
      if [[ -f ".eslintrc.passing.json" ]]; then
        node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json "$TOP_LEVEL/$BASENAME.es6.js"
        CORRECTJS=$?
        if [ "$CORRECTJS" -ne "0" ]; then
          # No need to write any output the node command will do this for us.
          STATUS=1
        fi
      fi
      cd $TOP_LEVEL
    else
      # If there is no .es6.js file then there should be unless the .js is
      # not really Drupal's.
      if ! [[ "$FILE" =~ ^core/assets/vendor ]] && ! [[ "$FILE" =~ ^core/modules/ckeditor5/js/build ]] && ! [[ "$FILE" =~ ^core/scripts/js ]] && ! [[ "$FILE" =~ ^core/scripts/css ]] && ! [[ "$FILE" =~ webpack.config.js$ ]] && ! [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]] && ! [[ "$FILE" =~ core/modules/ckeditor5/tests/modules/ckeditor5_test/js/build/layercake.js ]]; then
        printf "${red}FAILURE${reset} $FILE does not have a corresponding $BASENAME.es6.js\n"
        STATUS=1
      fi
    fi
  else
    # Check coding standards of Nightwatch files.
    if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]]; then
      cd "$TOP_LEVEL/core"
      # Check the coding standards.
      if [[ -f ".eslintrc.passing.json" ]]; then
        node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json "$TOP_LEVEL/$FILE"
        CORRECTJS=$?
        if [ "$CORRECTJS" -ne "0" ]; then
          # No need to write any output the node command will do this for us.
          STATUS=1
        fi
      fi
      cd $TOP_LEVEL
    fi
  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. # - ESLint checks JavaScript and YAML files.

  15. # - Checks .es6.js and .js files are equivalent.

  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 one of the eslint config file is

  116. # changed:

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

  118. #  - core/.eslintrc.json

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

  120. ESLINT_CONFIG_PASSING_FILE_CHANGED=0

  121. 

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

  123. # changed:

  124. #  - core/.stylelintignore

  125. #  - core/.stylelintrc.json

  126. STYLELINT_CONFIG_FILE_CHANGED=0

  127. 

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

  129. # changed:

  130. #  - core/package.json

  131. #  - core/yarn.lock

  132. JAVASCRIPT_PACKAGES_CHANGED=0

  133. 

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

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

  136. CKEDITOR5_PLUGINS_CHANGED=0

  137. 

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

  139. ABS_FILES=

  140. for FILE in $FILES; do

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

  142. 

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

  144.     PHPCS_XML_DIST_FILE_CHANGED=1;

  145.   fi;

  146. 

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

  148.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  149.   fi;

  150. 

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

  152.     STYLELINT_CONFIG_FILE_CHANGED=1;

  153.   fi;

  154. 

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

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

  157.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  158.     STYLELINT_CONFIG_FILE_CHANGED=1;

  159.     JAVASCRIPT_PACKAGES_CHANGED=1;

  160.   fi;

  161. 

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

  163.     CKEDITOR5_PLUGINS_CHANGED=1;

  164.   fi;

  165. done

  166. 

  167. # Exit early if there are no files.

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

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

  170.   exit;

  171. fi;

  172. 

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

  174. # run and all dependencies are updated.

  175. FINAL_STATUS=0

  176. 

  177. DEPENDENCIES_NEED_INSTALLING=0

  178. # Ensure PHP development dependencies are installed.

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

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

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

  182. #  user-facing strings in Composer.

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

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

  185.   DEPENDENCIES_NEED_INSTALLING=1;

  186. fi

  187. 

  188. cd "$TOP_LEVEL/core"

  189. 

  190. # Ensure JavaScript development dependencies are installed.

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

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

  193.   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"

  194.   DEPENDENCIES_NEED_INSTALLING=1;

  195. fi

  196. 

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

  198.   exit 1;

  199. fi

  200. 

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

  202. yarn run -s spellcheck --no-must-find-files -c $TOP_LEVEL/core/.cspell.json $ABS_FILES

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

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

  205.   FINAL_STATUS=1

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

  207. else

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

  209. fi

  210. cd "$TOP_LEVEL"

  211. 

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

  213. printf "\n"

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

  215. printf "\n"

  216. 

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

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

  219.   # Test all files with phpcs rules.

  220.   vendor/bin/phpcs -ps --parallel=$(nproc) --standard="$TOP_LEVEL/core/phpcs.xml.dist"

  221.   PHPCS=$?

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

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

  224.     FINAL_STATUS=1

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

  226.   else

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

  228.   fi

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

  230.   printf "\n"

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

  232.   printf "\n"

  233. fi

  234. 

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

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

  237.   cd "$TOP_LEVEL/core"

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

  239.   CORRECTJS=$?

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

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

  242.     FINAL_STATUS=1

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

  244.   else

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

  246.   fi

  247.   cd $TOP_LEVEL

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

  249.   printf "\n"

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

  251.   printf "\n"

  252. fi

  253. 

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

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

  256.   cd "$TOP_LEVEL/core"

  257.   yarn run -s lint:css

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

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

  260.     FINAL_STATUS=1

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

  262.   else

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

  264.   fi

  265.   cd $TOP_LEVEL

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

  267.   printf "\n"

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

  269.   printf "\n"

  270. fi

  271. 

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

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

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

  275. # is in sync and conform to expectations.

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

  277.   cd "$TOP_LEVEL/core"

  278.   yarn run -s check:ckeditor5

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

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

  281.     FINAL_STATUS=1

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

  283.   else

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

  285.   fi

  286.   cd $TOP_LEVEL

  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 JavaScript packages change, then rerun all JavaScript style checks.

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

  295.   cd "$TOP_LEVEL/core"

  296.   yarn run build:css --check

  297.   CORRECTCSS=$?

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

  299.     FINAL_STATUS=1

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

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

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

  303.     printf "\n       Recompile the CSS with: yarn run build:css${reset}\n\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. for FILE in $FILES; do

  313.   STATUS=0;

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

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

  316.   printf "\n"

  317. 

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

  319.   if [ -a $FILE ]; then

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

  321.       # Ensure the file has the correct mode.

  322.       STAT="$(stat -f "%A" $FILE 2>/dev/null)"

  323.       if [ $? -ne 0 ]; then

  324.         STAT="$(stat -c "%a" $FILE 2>/dev/null)"

  325.       fi

  326.       if [ "$STAT" -ne "644" ]; then

  327.         printf "${red}check failed:${reset} file $FILE should be 644 not $STAT\n"

  328.         STATUS=1

  329.       fi

  330.     fi

  331.   fi

  332. 

  333.   # Don't commit changes to vendor.

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

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

  336.     STATUS=1

  337.   fi

  338. 

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

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

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

  342.     STATUS=1

  343.   fi

  344. 

  345.   ############################################################################

  346.   ### PHP AND YAML FILES

  347.   ############################################################################

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

  349.     # Test files with phpcs rules.

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

  351.     PHPCS=$?

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

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

  354.       STATUS=1

  355.     else

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

  357.     fi

  358.   fi

  359. 

  360.   ############################################################################

  361.   ### YAML FILES

  362.   ############################################################################

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

  364.     # Test files with ESLint.

  365.     cd "$TOP_LEVEL/core"

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

  367.     YAMLLINT=$?

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

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

  370.       STATUS=1

  371.     else

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

  373.     fi

  374.     cd $TOP_LEVEL

  375.   fi

  376. 

  377.   ############################################################################

  378.   ### JAVASCRIPT FILES

  379.   ############################################################################

  380.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ ! $FILE =~ ^core/tests/Drupal/Nightwatch ]] && [[ ! $FILE =~ /tests/src/Nightwatch/ ]] && [[ ! $FILE =~ ^core/modules/ckeditor5/js/ckeditor5_plugins ]]; then

  381.     # Work out the root name of the JavaScript so we can ensure that the ES6

  382.     # version has been compiled correctly.

  383.     if [[ $FILE =~ \.es6\.js$ ]]; then

  384.       BASENAME=${FILE%.es6.js}

  385.       COMPILE_CHECK=1

  386.     else

  387.       BASENAME=${FILE%.js}

  388.       # We only need to compile check if the .es6.js file is not also

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

  390.       # .es6.js file. This might occur if the compile scripts have changed.

  391.       contains_element "$BASENAME.es6.js" "${FILES[@]}"

  392.       HASES6=$?

  393.       if [ "$HASES6" -ne "0" ]; then

  394.         COMPILE_CHECK=1

  395.       else

  396.         COMPILE_CHECK=0

  397.       fi

  398.     fi

  399.     if [[ "$COMPILE_CHECK" == "1" ]] && [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]]; then

  400.       cd "$TOP_LEVEL/core"

  401.       yarn run build:js --check --file "$TOP_LEVEL/$BASENAME.es6.js"

  402.       CORRECTJS=$?

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

  404.         # No need to write any output the yarn run command will do this for

  405.         # us.

  406.         STATUS=1

  407.       fi

  408.       # Check the coding standards.

  409.       if [[ -f ".eslintrc.passing.json" ]]; then

  410.         node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json "$TOP_LEVEL/$BASENAME.es6.js"

  411.         CORRECTJS=$?

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

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

  414.           STATUS=1

  415.         fi

  416.       fi

  417.       cd $TOP_LEVEL

  418.     else

  419.       # If there is no .es6.js file then there should be unless the .js is

  420.       # not really Drupal's.

  421.       if ! [[ "$FILE" =~ ^core/assets/vendor ]] && ! [[ "$FILE" =~ ^core/modules/ckeditor5/js/build ]] && ! [[ "$FILE" =~ ^core/scripts/js ]] && ! [[ "$FILE" =~ ^core/scripts/css ]] && ! [[ "$FILE" =~ webpack.config.js$ ]] && ! [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]] && ! [[ "$FILE" =~ core/modules/ckeditor5/tests/modules/ckeditor5_test/js/build/layercake.js ]]; then

  422.         printf "${red}FAILURE${reset} $FILE does not have a corresponding $BASENAME.es6.js\n"

  423.         STATUS=1

  424.       fi

  425.     fi

  426.   else

  427.     # Check coding standards of Nightwatch files.

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

  429.       cd "$TOP_LEVEL/core"

  430.       # Check the coding standards.

  431.       if [[ -f ".eslintrc.passing.json" ]]; then

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

  433.         CORRECTJS=$?

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

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

  436.           STATUS=1

  437.         fi

  438.       fi

  439.       cd $TOP_LEVEL

  440.     fi

  441.   fi

  442. 

  443.   ############################################################################

  444.   ### CSS FILES

  445.   ############################################################################

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

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

  448.     # version has been compiled correctly.

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

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

  451.       COMPILE_CHECK=1

  452.     else

  453.       BASENAME=${FILE%.css}

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

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

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

  457.       # changed.

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

  459.       HASPOSTCSS=$?

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

  461.         COMPILE_CHECK=1

  462.       else

  463.         COMPILE_CHECK=0

  464.       fi

  465.     fi

  466.     # PostCSS

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

  468.       cd "$TOP_LEVEL/core"

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

  470.       CORRECTCSS=$?

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

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

  473.         # than 0.

  474.         STATUS=1

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

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

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

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

  479.       fi

  480.       cd $TOP_LEVEL

  481.     fi

  482.   fi

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

  484.     BASENAME=${FILE%.css}

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

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

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

  488.       cd "$TOP_LEVEL/core"

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

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

  491.         STATUS=1

  492.       else

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

  494.       fi

  495.       cd $TOP_LEVEL

  496.     fi

  497.   fi

  498. 

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

  500.     FINAL_STATUS=1

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

  502.     # already.

  503.   else

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

  505.   fi

  506. 

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

  508.   printf "\n"

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

  510.   printf "\n"

  511. done

  512. 

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

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

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

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

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

  518.   printf "OR:\n"

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

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

  521. fi

  522. exit $FINAL_STATUS

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