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:
# - File modes.
# - No changes to core/node_modules directory.
# - PHPCS checks PHP and YAML files.
# - Eslint checks JavaScript files.
# - Checks .es6.js and .js files are equivalent.
# - Stylelint checks CSS files.
# - Checks .pcss.css and .css files are equivalent.

# 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);")
else
  red=$(tput setaf 1 && tput bold)
  green=$(tput setaf 2)
  reset=$(tput sgr0)
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)

# Build up a list of absolute file names.
ABS_FILES=
for FILE in $FILES; do
  ABS_FILES="$ABS_FILES $TOP_LEVEL/$FILE"
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

cd "$TOP_LEVEL"

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

for FILE in $FILES; do
  STATUS=0;
  # Print a line to separate 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)$ ]]; then
    # Test files with phpcs rules.
    vendor/bin/phpcs "$TOP_LEVEL/$FILE" --runtime-set installed_paths "$TOP_LEVEL/vendor/drupal/coder/coder_sniffer" --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

  ############################################################################
  ### JAVASCRIPT FILES
  ############################################################################
  if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ ! $FILE =~ ^core/tests/Drupal/Nightwatch ]] && [[ ! $FILE =~ ^core/assets/vendor/jquery.ui/ui ]]; 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/scripts/js ]] && ! [[ "$FILE" =~ ^core/scripts/css ]] && ! [[ "$FILE" =~ core/postcss.config.js ]] && ! [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]]; then
        printf "${red}FAILURE${reset} $FILE does not have a corresponding $BASENAME.es6.js\n"
        STATUS=1
      fi
    fi
  elif [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ $FILE =~ ^core/assets/vendor/jquery.ui/ui ]]; then
    ## Check for minified file changes.
    if [[ $FILE =~ -min\.js$ ]]; then
      BASENAME=${FILE%-min.js}
      contains_element "$BASENAME.js" "${FILES[@]}"
      HASSRC=$?
      if [ "$HASSRC" -ne "0" ]; then
        COMPILE_CHECK=1
      else
        ## Source was also changed and will be checked.
        COMPILE_CHECK=0
      fi
    else
      ## Check for source changes.
      BASENAME=${FILE%.js}
      COMPILE_CHECK=1
    fi
    if [[ "$COMPILE_CHECK" == "1" ]] && [[ -f "$TOP_LEVEL/$BASENAME.js" ]]; then
      cd "$TOP_LEVEL/core"
      yarn run build:jqueryui --check --file "$TOP_LEVEL/$BASENAME.js"
      CORRECTJS=$?
      if [ "$CORRECTJS" -ne "0" ]; then
        # The yarn run command will write any error output.
        STATUS=1
      fi
      cd $TOP_LEVEL
    else
      # If there is no .js source file
      if ! [[ -f "$TOP_LEVEL/$BASENAME.js" ]]; then
        printf "${red}FAILURE${reset} $FILE does not have a corresponding $BASENAME.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
        # No need to write any output the yarn run command will do this for
        # us.
        STATUS=1
      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 "$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. # - File modes.

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

  12. # - PHPCS checks PHP and YAML files.

  13. # - Eslint checks JavaScript files.

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

  15. # - Stylelint checks CSS files.

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

  17. 

  18. # Searches an array.

  19. contains_element() {

  20.   local e

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

  22.   return 1

  23. }

  24. 

  25. CACHED=0

  26. DRUPALCI=0

  27. BRANCH=""

  28. while test $# -gt 0; do

  29.   case "$1" in

  30.     -h|--help)

  31.       echo "Drupal code quality checks"

  32.       echo " "

  33.       echo "options:"

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

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

  36.       echo "--cached                  checks staged files"

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

  38.       echo " "

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

  40.       exit 0

  41.       ;;

  42.     --branch)

  43.       BRANCH="$2"

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

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

  46.         exit;

  47.       fi

  48.       shift 2

  49.       ;;

  50.     --cached)

  51.       CACHED=1

  52.       shift

  53.       ;;

  54.     --drupalci)

  55.       DRUPALCI=1

  56.       shift

  57.       ;;

  58.     *)

  59.       break

  60.       ;;

  61.   esac

  62. done

  63. 

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

  65. # DrupalCI because it is breaks reporting.

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

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

  68.   red=""

  69.   green=""

  70.   reset=""

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

  72. else

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

  74.   green=$(tput setaf 2)

  75.   reset=$(tput sgr0)

  76. fi

  77. 

  78. # Gets list of files to check.

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

  80.   FILES=$(git diff --name-only $BRANCH HEAD);

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

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

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

  84.   FILES=$(git ls-files --other --modified --exclude-standard --exclude=vendor)

  85. else

  86.   # Check staged files only.

  87.   if git rev-parse --verify HEAD >/dev/null 2>&1

  88.   then

  89.     AGAINST=HEAD

  90.   else

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

  92.     AGAINST=4b825dc642cb6eb9a060e54bf8d69288fbee4904

  93.   fi

  94.   FILES=$(git diff --cached --name-only $AGAINST);

  95. fi

  96. 

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

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

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

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

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

  102.   FILES=$(git diff --name-only HEAD~1 HEAD);

  103. fi

  104. 

  105. TOP_LEVEL=$(git rev-parse --show-toplevel)

  106. 

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

  108. ABS_FILES=

  109. for FILE in $FILES; do

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

  111. done

  112. 

  113. # Exit early if there are no files.

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

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

  116.   exit;

  117. fi;

  118. 

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

  120. # run and all dependencies are updated.

  121. FINAL_STATUS=0

  122. 

  123. cd "$TOP_LEVEL"

  124. 

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

  126. printf "\n"

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

  128. printf "\n"

  129. 

  130. for FILE in $FILES; do

  131.   STATUS=0;

  132.   # Print a line to separate output.

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

  134.   printf "\n"

  135. 

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

  137.   if [ -a $FILE ]; then

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

  139.       # Ensure the file has the correct mode.

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

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

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

  143.       fi

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

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

  146.         STATUS=1

  147.       fi

  148.     fi

  149.   fi

  150. 

  151.   # Don't commit changes to vendor.

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

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

  154.     STATUS=1

  155.   fi

  156. 

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

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

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

  160.     STATUS=1

  161.   fi

  162. 

  163.   ############################################################################

  164.   ### PHP AND YAML FILES

  165.   ############################################################################

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

  167.     # Test files with phpcs rules.

  168.     vendor/bin/phpcs "$TOP_LEVEL/$FILE" --runtime-set installed_paths "$TOP_LEVEL/vendor/drupal/coder/coder_sniffer" --standard="$TOP_LEVEL/core/phpcs.xml.dist"

  169.     PHPCS=$?

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

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

  172.       STATUS=1

  173.     else

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

  175.     fi

  176.   fi

  177. 

  178.   ############################################################################

  179.   ### JAVASCRIPT FILES

  180.   ############################################################################

  181.   if [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ ! $FILE =~ ^core/tests/Drupal/Nightwatch ]] && [[ ! $FILE =~ ^core/assets/vendor/jquery.ui/ui ]]; then

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

  183.     # version has been compiled correctly.

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

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

  186.       COMPILE_CHECK=1

  187.     else

  188.       BASENAME=${FILE%.js}

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

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

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

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

  193.       HASES6=$?

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

  195.         COMPILE_CHECK=1

  196.       else

  197.         COMPILE_CHECK=0

  198.       fi

  199.     fi

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

  201.       cd "$TOP_LEVEL/core"

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

  203.       CORRECTJS=$?

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

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

  206.         # us.

  207.         STATUS=1

  208.       fi

  209.       # Check the coding standards.

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

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

  212.         CORRECTJS=$?

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

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

  215.           STATUS=1

  216.         fi

  217.       fi

  218.       cd $TOP_LEVEL

  219.     else

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

  221.       # not really Drupal's.

  222.       if ! [[ "$FILE" =~ ^core/assets/vendor ]] && ! [[ "$FILE" =~ ^core/scripts/js ]] && ! [[ "$FILE" =~ ^core/scripts/css ]] && ! [[ "$FILE" =~ core/postcss.config.js ]] && ! [[ -f "$TOP_LEVEL/$BASENAME.es6.js" ]]; then

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

  224.         STATUS=1

  225.       fi

  226.     fi

  227.   elif [[ -f "$TOP_LEVEL/$FILE" ]] && [[ $FILE =~ \.js$ ]] && [[ $FILE =~ ^core/assets/vendor/jquery.ui/ui ]]; then

  228.     ## Check for minified file changes.

  229.     if [[ $FILE =~ -min\.js$ ]]; then

  230.       BASENAME=${FILE%-min.js}

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

  232.       HASSRC=$?

  233.       if [ "$HASSRC" -ne "0" ]; then

  234.         COMPILE_CHECK=1

  235.       else

  236.         ## Source was also changed and will be checked.

  237.         COMPILE_CHECK=0

  238.       fi

  239.     else

  240.       ## Check for source changes.

  241.       BASENAME=${FILE%.js}

  242.       COMPILE_CHECK=1

  243.     fi

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

  245.       cd "$TOP_LEVEL/core"

  246.       yarn run build:jqueryui --check --file "$TOP_LEVEL/$BASENAME.js"

  247.       CORRECTJS=$?

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

  249.         # The yarn run command will write any error output.

  250.         STATUS=1

  251.       fi

  252.       cd $TOP_LEVEL

  253.     else

  254.       # If there is no .js source file

  255.       if ! [[ -f "$TOP_LEVEL/$BASENAME.js" ]]; then

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

  257.         STATUS=1

  258.       fi

  259.     fi

  260.   else

  261.     # Check coding standards of Nightwatch files.

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

  263.       cd "$TOP_LEVEL/core"

  264.       # Check the coding standards.

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

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

  267.         CORRECTJS=$?

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

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

  270.           STATUS=1

  271.         fi

  272.       fi

  273.       cd $TOP_LEVEL

  274.     fi

  275.   fi

  276. 

  277.   ############################################################################

  278.   ### CSS FILES

  279.   ############################################################################

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

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

  282.     # version has been compiled correctly.

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

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

  285.       COMPILE_CHECK=1

  286.     else

  287.       BASENAME=${FILE%.css}

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

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

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

  291.       # changed.

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

  293.       HASPOSTCSS=$?

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

  295.         COMPILE_CHECK=1

  296.       else

  297.         COMPILE_CHECK=0

  298.       fi

  299.     fi

  300.     # PostCSS

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

  302.       cd "$TOP_LEVEL/core"

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

  304.       CORRECTCSS=$?

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

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

  307.         # us.

  308.         STATUS=1

  309.       fi

  310.       cd $TOP_LEVEL

  311.     fi

  312.   fi

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

  314.     BASENAME=${FILE%.css}

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

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

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

  318.       cd "$TOP_LEVEL/core"

  319.       node_modules/.bin/stylelint "$TOP_LEVEL/$FILE"

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

  321.         STATUS=1

  322.       else

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

  324.       fi

  325.       cd $TOP_LEVEL

  326.     fi

  327.   fi

  328. 

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

  330.     FINAL_STATUS=1

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

  332.     # already.

  333.   else

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

  335.   fi

  336. 

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

  338.   printf "\n"

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

  340.   printf "\n"

  341. done

  342. 

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

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

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

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

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

  348.   printf "OR:\n"

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

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

  351. fi

  352. exit $FINAL_STATUS

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