Problem/Motivation
As mentioned in the parent issue #3238306: [META] Where possible, refactor existing jQuery uses to vanillaJS to reduce jQuery footprint, we are working towards reducing our jQuery footprint. One of the ways to accomplish this is to reduce the number of jQuery features used in Drupal core. We have added eslint rules that identify specific features and fail tests when those features are in use.
There are (or will be) individual issues for each jQuery-use eslint rule. This one is specific to jquery/no-when, which targets the jQuery when function.
Steps to reproduce
Proposed resolution
Remaining tasks
- In
core/.eslintrc.jquery.jsonChange"jquery/no-when": 0,to"jquery/no-when": 2,to enable eslint checks for uses of jQueryjQuery.when(). With this change, you'll be able to see uses of the undesirable jQuery feature by runningyarn lint:core-js-passingfrom thecoredirectory - Add the following lines to
core/scripts/dev/commit-code-check.shso the DrupalCI testing script can catch this jQuery usage on all files, not just those which have changed
# @todo Remove the next chunk of lines before committing. This script only lints # JavaScript files that have changed, so we add this to check all files for # jQuery-specific lint errors. cd "$TOP_LEVEL/core" node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json . CORRECTJQS=$? if [ "$CORRECTJQS" -ne "0" ]; then # No need to write any output the node command will do this for us. printf "${red}FAILURE ${reset}: unsupported jQuery usage. See errors above." STATUS=1 FINAL_STATUS=1 fi cd $TOP_LEVEL # @todo end lines to removeAdd the block about 10 lines before the end of the file, just before
if [[ "$FINAL_STATUS" == "1" ]] && [[ "$DRUPALCI" == "1" ]]; then, then remove it once all the jQuery uses have been refactored. - If it's determined to be feasible, refactor those uses of jQuery
jQuery.when()to use Vanilla (native) JavaScript instead.
User interface changes
API changes
Data model changes
Release notes snippet
Issue fork drupal-3239136
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
- 3239136-refactor-when
changes, plain diff MR !6618
- 3239136-refactor-if-feasible
changes, plain diff MR !1248
Comments
Comment #7
ahsannazir commentedComment #9
ahsannazir commentedComment #11
smustgrave commentedSmall nitpicky comment.
Comment #12
ahsannazir commentedComment #13
smustgrave commentedStraight forward and guess this rule didn't need to be turned off to begin with.
Comment #15
nod_confirmed we don't have code using jquery .when (outside jquery ui at least)
Committed 56bf8c1 and pushed to 11.x. Thanks!