commit-code-check.sh

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

MEMORY_UNLIMITED=0
CACHED=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 "--memory-unlimited        bypass PHP memory limit for PHPStan and PHPCS"
      echo " "
      echo "Example usage: sh ./core/scripts/dev/commit-code-check.sh --branch 9.2.x"
      exit 0
      ;;
    --branch)
      BRANCH="$2"
      if [[ "$BRANCH" == "" ]]; then
        printf "The --branch option requires a value. For example: --branch 9.2.x\n"
        exit;
      fi
      shift 2
      ;;
    --cached)
      CACHED=1
      shift
      ;;
    --memory-unlimited)
      MEMORY_UNLIMITED=1
      shift
      ;;
    *)
      break
      ;;
  esac
done

memory_limit=""
phpcs_memory_limit=""

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

# Set up variables to make colored output simple.
red=$(tput setaf 1 && tput bold)
blue=$(tput setaf 4 && tput bold)
green=$(tput setaf 2)
reset=$(tput sgr0)
GIT="git"

# Gets list of files to check.
if [[ "$BRANCH" != "" ]]; then
  FILES=$($GIT diff --name-only $BRANCH HEAD);
elif [[ "$CACHED" == "0" ]]; then
  # 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

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/eslint.passing.config.mjs
#  - core/eslint.config.mjs
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 the twig-cs-fixer config file is
# changed:
#  - core/.twig-cs-fixer.php
TWIGCSFIXER_CONFIG_FILE_CHANGED=0

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

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

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

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

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

  if [[ $FILE == "core/.twig-cs-fixer.php" ]]; then
    TWIGCSFIXER_CONFIG_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/eslint.config.mjs" || $FILE == "core/eslint.passing.config.mjs" ]]; then
    ESLINT_CONFIG_PASSING_FILE_CHANGED=1;
  fi;

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

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

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

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

  if [[ $FILE == "core/MAINTAINERS.txt" ]]; then
    MAINTAINERS_TXT_CHANGED=1;
  fi

done

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

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

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

cd "$TOP_LEVEL/core"

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

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

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

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

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

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

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

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

# Run Twig CS Fixer on all files when twig cs fixer files are changed.
if [[ $TWIGCSFIXER_CONFIG_FILE_CHANGED == "1" ]]; then
  # Test all files with twig-cs-fixer rules.
  vendor/bin/twig-cs-fixer lint -c "$TOP_LEVEL/core/.twig-cs-fixer.php"
  TWIGCS=$?
  if [ "$TWIGCS" -ne "0" ]; then
    # If there are failures set the status to a number other than 0.
    FINAL_STATUS=1
    printf "\TWIGCS: ${red}failed${reset}\n"
  else
    printf "\TWIGCS: ${green}passed${reset}\n"
  fi
  # Add a separator line to make the output easier to read.
  printf "\n"
  printf -- '-%.0s' {1..100}
  printf "\n"
fi

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

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

# When 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

# Build file type lists for batch checks.
PHP_FILES=""
JS_FILES=""
CSS_FILES=""
TWIG_FILES=""
for FILE in $FILES; do
  if [[ -f "$TOP_LEVEL/$FILE" ]]; then
    if [[ $FILE =~ \.(inc|install|module|php|profile|test|theme|yml)$ ]]; then
      PHP_FILES="$PHP_FILES $TOP_LEVEL/$FILE"
    fi
    if [[ $FILE =~ \.(yml|js)$ ]]; then
      JS_FILES="$JS_FILES $TOP_LEVEL/$FILE"
    fi
    if [[ $FILE =~ \.css$ ]]; then
      BASENAME=${FILE%.css}
      if [[ $FILE =~ \.pcss\.css$ ]] || [[ ! -f "$TOP_LEVEL/$BASENAME.pcss.css" ]]; then
        CSS_FILES="$CSS_FILES $TOP_LEVEL/$FILE"
      fi
    fi
    if [[ $FILE =~ \.twig$ ]]; then
      TWIG_FILES="$TWIG_FILES $TOP_LEVEL/$FILE"
    fi
  fi
done

# Run PHPCS on changed PHP and YAML files.
if [[ "$PHP_FILES" != "" ]] && [[ $PHPCS_XML_DIST_FILE_CHANGED == "0" ]]; then
  vendor/bin/phpcs $phpcs_memory_limit --standard="$TOP_LEVEL/core/phpcs.xml.dist" $PHP_FILES
  if [ "$?" -ne "0" ]; then
    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

# Run Twig CS Fixer on changed Twig files.
if [[ "$TWIG_FILES" != "" ]] && [[ $TWIGCSFIXER_CONFIG_FILE_CHANGED == "0" ]]; then
  vendor/bin/twig-cs-fixer lint $TWIG_FILES -c "$TOP_LEVEL/core/.twig-cs-fixer.php"
  if [ "$?" -ne "0" ]; then
    FINAL_STATUS=1
    printf "\TWIGCS: ${red}failed${reset}\n"
  else
    printf "\TWIGCS: ${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

# Run ESLint on changed YAML and JavaScript files.
if [[ "$JS_FILES" != "" ]] && [[ $ESLINT_CONFIG_PASSING_FILE_CHANGED == "0" ]]; then
  cd "$TOP_LEVEL/core"
  node ./node_modules/eslint/bin/eslint.js --quiet --config=eslint.passing.config.mjs $JS_FILES
  if [ "$?" -ne "0" ]; then
    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

# Run Stylelint on changed CSS files.
if [[ "$CSS_FILES" != "" ]] && [[ $STYLELINT_CONFIG_FILE_CHANGED == "0" ]] && [[ -f "core/node_modules/.bin/stylelint" ]]; then
  cd "$TOP_LEVEL/core"
  node_modules/.bin/stylelint --allow-empty-input $CSS_FILES
  if [ "$?" -ne "0" ]; then
    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

for FILE in $FILES; do
  # Ensure the file still exists (i.e. is not being deleted).
  if [ -a $FILE ]; then
    if [ ${FILE: -3} != ".sh" ] && [ "$FILE" != "core/scripts/dr" ]; then
      if [ -x $FILE ]; then
        printf "${red}check failed:${reset} file $FILE should not be executable\n"
        FINAL_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"
    FINAL_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"
    FINAL_STATUS=1
  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.
        FINAL_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
done

if [[ "$MAINTAINERS_TXT_CHANGED" == "1" ]]; then
  printf "\n${blue}INFO: MAINTAINERS.TXT changed"
  printf "\n      Make sure follow up changes are made to documentation, Slack channel, email group etc."
  printf "\n      See https://www.drupal.org/about/core/policies/maintainers/add-or-remove-a-subsystem-or-topic-maintainer.${reset}\n\n"

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

exit $FINAL_STATUS

File

View on git.drupalcode.org

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

View source 
  1. #!/bin/bash

  2. #

  3. # This script performs code quality checks.

  4. #

  5. # @internal

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

  7. #   It exists only for core development purposes.

  8. #

  9. # The script makes the following checks:

  10. # - Spell checking.

  11. # - File modes.

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

  13. # - PHPCS checks PHP and YAML files.

  14. # - PHPStan checks PHP files.

  15. # - ESLint checks JavaScript and YAML files.

  16. # - Stylelint checks CSS files.

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

  18. 

  19. # cSpell:disable

  20. 

  21. # Searches an array.

  22. contains_element() {

  23.   local e

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

  25.   return 1

  26. }

  27. 

  28. MEMORY_UNLIMITED=0

  29. CACHED=0

  30. 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 "--memory-unlimited        bypass PHP memory limit for PHPStan and PHPCS"

  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.     --memory-unlimited)

  58.       MEMORY_UNLIMITED=1

  59.       shift

  60.       ;;

  61.     *)

  62.       break

  63.       ;;

  64.   esac

  65. done

  66. 

  67. memory_limit=""

  68. phpcs_memory_limit=""

  69. 

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

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

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

  73. fi

  74. 

  75. # Set up variables to make colored output simple.

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

  77. blue=$(tput setaf 4 && tput bold)

  78. green=$(tput setaf 2)

  79. reset=$(tput sgr0)

  80. GIT="git"

  81. 

  82. # Gets list of files to check.

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

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

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

  86.   # List of all changes in the working directory.

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

  88. else

  89.   # Check staged files only.

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

  91.   then

  92.     AGAINST=HEAD

  93.   else

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

  95.     AGAINST=4b825dc642cb6eb9a060e54bf8d69288fbee4904

  96.   fi

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

  98. fi

  99. 

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

  101. 

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

  103. PHPCS_XML_DIST_FILE_CHANGED=0

  104. 

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

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

  107. PHPSTAN_DIST_FILE_CHANGED=0

  108. 

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

  110. # changed:

  111. #  - core/eslint.passing.config.mjs

  112. #  - core/eslint.config.mjs

  113. ESLINT_CONFIG_PASSING_FILE_CHANGED=0

  114. 

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

  116. # changed:

  117. #  - core/.stylelintignore

  118. #  - core/.stylelintrc.json

  119. STYLELINT_CONFIG_FILE_CHANGED=0

  120. 

  121. # This variable will be set to one when the twig-cs-fixer config file is

  122. # changed:

  123. #  - core/.twig-cs-fixer.php

  124. TWIGCSFIXER_CONFIG_FILE_CHANGED=0

  125. 

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

  127. # changed:

  128. #  - core/package.json

  129. #  - core/yarn.lock

  130. JAVASCRIPT_PACKAGES_CHANGED=0

  131. 

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

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

  134. CKEDITOR5_PLUGINS_CHANGED=0

  135. 

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

  137. # .cspell.json config has changed.

  138. CSPELL_DICTIONARY_FILE_CHANGED=0

  139. 

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

  141. ABS_FILES=

  142. for FILE in $FILES; do

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

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

  145.   fi

  146. 

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

  148.     PHPCS_XML_DIST_FILE_CHANGED=1;

  149.   fi;

  150. 

  151.   if [[ $FILE == "core/.twig-cs-fixer.php" ]]; then

  152.     TWIGCSFIXER_CONFIG_FILE_CHANGED=1;

  153.   fi;

  154. 

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

  156.     PHPSTAN_DIST_FILE_CHANGED=1;

  157.   fi;

  158. 

  159.   if [[ $FILE == "core/eslint.config.mjs" || $FILE == "core/eslint.passing.config.mjs" ]]; then

  160.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  161.   fi;

  162. 

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

  164.     STYLELINT_CONFIG_FILE_CHANGED=1;

  165.   fi;

  166. 

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

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

  169.     ESLINT_CONFIG_PASSING_FILE_CHANGED=1;

  170.     STYLELINT_CONFIG_FILE_CHANGED=1;

  171.     JAVASCRIPT_PACKAGES_CHANGED=1;

  172.   fi;

  173. 

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

  175.     CKEDITOR5_PLUGINS_CHANGED=1;

  176.   fi;

  177. 

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

  179.     CSPELL_DICTIONARY_FILE_CHANGED=1;

  180.   fi

  181. 

  182.   if [[ $FILE == "core/MAINTAINERS.txt" ]]; then

  183.     MAINTAINERS_TXT_CHANGED=1;

  184.   fi

  185. 

  186. done

  187. 

  188. # Exit early if there are no files.

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

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

  191.   exit;

  192. fi;

  193. 

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

  195. # run and all dependencies are updated.

  196. FINAL_STATUS=0

  197. 

  198. DEPENDENCIES_NEED_INSTALLING=0

  199. # Ensure PHP development dependencies are installed.

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

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

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

  203. #  user-facing strings in Composer.

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

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

  206.   DEPENDENCIES_NEED_INSTALLING=1;

  207. fi

  208. 

  209. cd "$TOP_LEVEL/core"

  210. 

  211. # Ensure JavaScript development dependencies are installed.

  212. yarn --version

  213. yarn >/dev/null

  214. 

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

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

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

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

  219. else

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

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

  222.   # core/package.json.

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

  224. fi

  225. 

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

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

  228.   FINAL_STATUS=1

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

  230. else

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

  232. fi

  233. cd "$TOP_LEVEL"

  234. 

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

  236. printf "\n"

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

  238. printf "\n"

  239. 

  240. # Run PHPStan on all files when phpstan files are changed.

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

  242. if [[ $PHPSTAN_DIST_FILE_CHANGED == "1" ]]; then

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

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

  245. else

  246.   # Only run PHPStan on changed files locally.

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

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

  249. fi

  250. 

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

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

  253.   FINAL_STATUS=1

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

  255. else

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

  257. fi

  258. 

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

  260. printf "\n"

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

  262. printf "\n"

  263. 

  264. # Run PHPCS on all files when phpcs files are changed.

  265. if [[ $PHPCS_XML_DIST_FILE_CHANGED == "1" ]]; then

  266.   # Test all files with phpcs rules.

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

  268.   PHPCS=$?

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

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

  271.     FINAL_STATUS=1

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

  273.   else

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

  275.   fi

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

  277.   printf "\n"

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

  279.   printf "\n"

  280. fi

  281. 

  282. # Run Twig CS Fixer on all files when twig cs fixer files are changed.

  283. if [[ $TWIGCSFIXER_CONFIG_FILE_CHANGED == "1" ]]; then

  284.   # Test all files with twig-cs-fixer rules.

  285.   vendor/bin/twig-cs-fixer lint -c "$TOP_LEVEL/core/.twig-cs-fixer.php"

  286.   TWIGCS=$?

  287.   if [ "$TWIGCS" -ne "0" ]; then

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

  289.     FINAL_STATUS=1

  290.     printf "\TWIGCS: ${red}failed${reset}\n"

  291.   else

  292.     printf "\TWIGCS: ${green}passed${reset}\n"

  293.   fi

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

  295.   printf "\n"

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

  297.   printf "\n"

  298. fi

  299. 

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

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

  302.   cd "$TOP_LEVEL/core"

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

  304.   CORRECTJS=$?

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

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

  307.     FINAL_STATUS=1

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

  309.   else

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

  311.   fi

  312.   cd $TOP_LEVEL

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

  314.   printf "\n"

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

  316.   printf "\n"

  317. fi

  318. 

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

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

  321.   cd "$TOP_LEVEL/core"

  322.   yarn run lint:css

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

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

  325.     FINAL_STATUS=1

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

  327.   else

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

  329.   fi

  330.   cd $TOP_LEVEL

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

  332.   printf "\n"

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

  334.   printf "\n"

  335. fi

  336. 

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

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

  339.   cd "$TOP_LEVEL/core"

  340.   yarn run build:css --check

  341.   CORRECTCSS=$?

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

  343.     FINAL_STATUS=1

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

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

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

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

  348.   fi

  349.   cd $TOP_LEVEL

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

  351.   printf "\n"

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

  353.   printf "\n"

  354. fi

  355. 

  356. # Build file type lists for batch checks.

  357. PHP_FILES=""

  358. JS_FILES=""

  359. CSS_FILES=""

  360. TWIG_FILES=""

  361. for FILE in $FILES; do

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

  363.     if [[ $FILE =~ \.(inc|install|module|php|profile|test|theme|yml)$ ]]; then

  364.       PHP_FILES="$PHP_FILES $TOP_LEVEL/$FILE"

  365.     fi

  366.     if [[ $FILE =~ \.(yml|js)$ ]]; then

  367.       JS_FILES="$JS_FILES $TOP_LEVEL/$FILE"

  368.     fi

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

  370.       BASENAME=${FILE%.css}

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

  372.         CSS_FILES="$CSS_FILES $TOP_LEVEL/$FILE"

  373.       fi

  374.     fi

  375.     if [[ $FILE =~ \.twig$ ]]; then

  376.       TWIG_FILES="$TWIG_FILES $TOP_LEVEL/$FILE"

  377.     fi

  378.   fi

  379. done

  380. 

  381. # Run PHPCS on changed PHP and YAML files.

  382. if [[ "$PHP_FILES" != "" ]] && [[ $PHPCS_XML_DIST_FILE_CHANGED == "0" ]]; then

  383.   vendor/bin/phpcs $phpcs_memory_limit --standard="$TOP_LEVEL/core/phpcs.xml.dist" $PHP_FILES

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

  385.     FINAL_STATUS=1

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

  387.   else

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

  389.   fi

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

  391.   printf "\n"

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

  393.   printf "\n"

  394. fi

  395. 

  396. # Run Twig CS Fixer on changed Twig files.

  397. if [[ "$TWIG_FILES" != "" ]] && [[ $TWIGCSFIXER_CONFIG_FILE_CHANGED == "0" ]]; then

  398.   vendor/bin/twig-cs-fixer lint $TWIG_FILES -c "$TOP_LEVEL/core/.twig-cs-fixer.php"

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

  400.     FINAL_STATUS=1

  401.     printf "\TWIGCS: ${red}failed${reset}\n"

  402.   else

  403.     printf "\TWIGCS: ${green}passed${reset}\n"

  404.   fi

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

  406.   printf "\n"

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

  408.   printf "\n"

  409. fi

  410. 

  411. # Run ESLint on changed YAML and JavaScript files.

  412. if [[ "$JS_FILES" != "" ]] && [[ $ESLINT_CONFIG_PASSING_FILE_CHANGED == "0" ]]; then

  413.   cd "$TOP_LEVEL/core"

  414.   node ./node_modules/eslint/bin/eslint.js --quiet --config=eslint.passing.config.mjs $JS_FILES

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

  416.     FINAL_STATUS=1

  417.     printf "\nESLint: ${red}failed${reset}\n"

  418.   else

  419.     printf "\nESLint: ${green}passed${reset}\n"

  420.   fi

  421.   cd "$TOP_LEVEL"

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

  423.   printf "\n"

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

  425.   printf "\n"

  426. fi

  427. 

  428. # Run Stylelint on changed CSS files.

  429. if [[ "$CSS_FILES" != "" ]] && [[ $STYLELINT_CONFIG_FILE_CHANGED == "0" ]] && [[ -f "core/node_modules/.bin/stylelint" ]]; then

  430.   cd "$TOP_LEVEL/core"

  431.   node_modules/.bin/stylelint --allow-empty-input $CSS_FILES

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

  433.     FINAL_STATUS=1

  434.     printf "\nStylelint: ${red}failed${reset}\n"

  435.   else

  436.     printf "\nStylelint: ${green}passed${reset}\n"

  437.   fi

  438.   cd "$TOP_LEVEL"

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

  440.   printf "\n"

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

  442.   printf "\n"

  443. fi

  444. 

  445. for FILE in $FILES; do

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

  447.   if [ -a $FILE ]; then

  448.     if [ ${FILE: -3} != ".sh" ] && [ "$FILE" != "core/scripts/dr" ]; then

  449.       if [ -x $FILE ]; then

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

  451.         FINAL_STATUS=1

  452.       fi

  453.     fi

  454.   fi

  455. 

  456.   # Don't commit changes to vendor.

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

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

  459.     FINAL_STATUS=1

  460.   fi

  461. 

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

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

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

  465.     FINAL_STATUS=1

  466.   fi

  467. 

  468.   ############################################################################

  469.   ### CSS FILES

  470.   ############################################################################

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

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

  473.     # version has been compiled correctly.

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

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

  476.       COMPILE_CHECK=1

  477.     else

  478.       BASENAME=${FILE%.css}

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

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

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

  482.       # changed.

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

  484.       HASPOSTCSS=$?

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

  486.         COMPILE_CHECK=1

  487.       else

  488.         COMPILE_CHECK=0

  489.       fi

  490.     fi

  491.     # PostCSS

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

  493.       cd "$TOP_LEVEL/core"

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

  495.       CORRECTCSS=$?

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

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

  498.         # than 0.

  499.         FINAL_STATUS=1

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

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

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

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

  504.       fi

  505.       cd $TOP_LEVEL

  506.     fi

  507.   fi

  508. done

  509. 

  510. if [[ "$MAINTAINERS_TXT_CHANGED" == "1" ]]; then

  511.   printf "\n${blue}INFO: MAINTAINERS.TXT changed"

  512.   printf "\n      Make sure follow up changes are made to documentation, Slack channel, email group etc."

  513.   printf "\n      See https://www.drupal.org/about/core/policies/maintainers/add-or-remove-a-subsystem-or-topic-maintainer.${reset}\n\n"

  514. 

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

  516.   printf "\n"

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

  518.   printf "\n"

  519. fi

  520. 

  521. exit $FINAL_STATUS

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