Merge branch 'main' into main-lmp-responsive-pagination-2

.eslintignore

@@ -3,7 +3,6 @@
 **/vendor/
 /_site/
 /js/coverage/
-/js/tests/integration/
 /site/static/sw.js
-/site/layouts/
+/site/layouts/partials/
 /stories/auto/

.eslintrc.json

@@ -14,6 +14,35 @@
       "error",
       "never"
     ],
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "js": "always"
+      }
+    ],
+    "import/first": "error",
+    "import/newline-after-import": "error",
+    "import/no-absolute-path": "error",
+    "import/no-amd": "error",
+    "import/no-cycle": [
+      "error",
+      {
+        "ignoreExternal": true
+      }
+    ],
+    "import/no-duplicates": "error",
+    "import/no-extraneous-dependencies": "error",
+    "import/no-mutable-exports": "error",
+    "import/no-named-as-default": "error",
+    "import/no-named-as-default-member": "error",
+    "import/no-named-default": "error",
+    "import/no-self-import": "error",
+    "import/no-unassigned-import": [
+      "error"
+    ],
+    "import/no-useless-path-segments": "error",
+    "import/order": "error",
     "indent": [
       "error",
       2,
@@ -51,17 +80,160 @@
       "error",
       "never"
     ],
+    "strict": "error",
     "unicorn/explicit-length-check": "off",
+    "unicorn/filename-case": "off",
     "unicorn/no-array-callback-reference": "off",
     "unicorn/no-array-method-this-argument": "off",
     "unicorn/no-null": "off",
     "unicorn/no-typeof-undefined": "off",
     "unicorn/no-unused-properties": "error",
+    "unicorn/numeric-separators-style": "off",
     "unicorn/prefer-array-flat": "off",
+    "unicorn/prefer-at": "off",
     "unicorn/prefer-dom-node-dataset": "off",
     "unicorn/prefer-module": "off",
     "unicorn/prefer-query-selector": "off",
     "unicorn/prefer-spread": "off",
+    "unicorn/prefer-string-replace-all": "off",
     "unicorn/prevent-abbreviations": "off"
-  }
+  },
+  "overrides": [
+    {
+      "files": [
+        "build/**"
+      ],
+      "env": {
+        "browser": false,
+        "node": true
+      },
+      "parserOptions": {
+        "sourceType": "script"
+      },
+      "rules": {
+        "no-console": "off",
+        "unicorn/prefer-top-level-await": "off"
+      }
+    },
+    {
+      "files": [
+        "js/**"
+      ],
+      "parserOptions": {
+        "sourceType": "module"
+      }
+    },
+    {
+      "files": [
+        "js/tests/*.js",
+        "js/tests/integration/rollup*.js"
+      ],
+      "env": {
+        "node": true
+      },
+      "parserOptions": {
+        "sourceType": "script"
+      }
+    },
+    {
+      "files": [
+        "js/tests/unit/**"
+      ],
+      "env": {
+        "jasmine": true
+      },
+      "rules": {
+        "no-console": "off",
+        "unicorn/consistent-function-scoping": "off",
+        "unicorn/no-useless-undefined": "off",
+        "unicorn/prefer-add-event-listener": "off"
+      }
+    },
+    {
+      "files": [
+        "js/tests/visual/**"
+      ],
+      "plugins": [
+        "html"
+      ],
+      "settings": {
+        "html/html-extensions": [
+          ".html"
+        ]
+      },
+      "rules": {
+        "no-console": "off",
+        "no-new": "off",
+        "unicorn/no-array-for-each": "off"
+      }
+    },
+    {
+      "files": [
+        "scss/tests/**"
+      ],
+      "env": {
+        "node": true
+      },
+      "parserOptions": {
+        "sourceType": "script"
+      }
+    },
+    {
+      "files": [
+        "site/**"
+      ],
+      "env": {
+        "browser": true,
+        "node": false
+      },
+      "parserOptions": {
+        "sourceType": "script",
+        "ecmaVersion": 2019
+      },
+      "rules": {
+        "no-new": "off",
+        "unicorn/no-array-for-each": "off"
+      }
+    },
+    {
+      "files": [
+        "stories/**"
+      ],
+      "env": {
+        "browser": false,
+        "node": true
+      },
+      "parserOptions": {
+        "sourceType": "script"
+      },
+      "rules": {
+        "no-await-in-loop": "off",
+        "no-console": "off",
+        "no-multi-str": "off",
+        "strict": "error",
+        "unicorn/prefer-top-level-await": "off"
+      }
+    },
+    {
+      "files": [
+        "**/*.md"
+      ],
+      "plugins": [
+        "markdown"
+      ],
+      "processor": "markdown/markdown"
+    },
+    {
+      "files": [
+        "**/*.md/*.js"
+      ],
+      "extends": "plugin:markdown/recommended",
+      "parserOptions": {
+        "sourceType": "module"
+      },
+      "rules": {
+        "unicorn/prefer-node-protocol": "off"
+      }
+    }
+  ]
 }

.github/PULL_REQUEST_TEMPLATE.md

@@ -95,7 +95,7 @@ _Note: Please transform `- [ ]` into `- (NA)` in the description when things are
   - then, if bumping a minor or major version:
     - [ ] Manually change `version_short` in `package.json`
     - [ ] Add docs version to `site/data/docs-versions.yml`
-    - [ ] Manually change `docs_version` in `config.yml` and other references to the previous version
+    - [ ] Manually change `docs_version` in `hugo.yml` and other references to the previous version
     - [ ] Update redirects in docs frontmatter (`site/content/docs/_index.html`?)
     - [ ] Move `site/content/docs/5.x` to `site/content/docs/5.x+1`
     - [ ] Increment `site/static/docs/{version}` version

.github/workflows/css.yml

@@ -44,3 +44,15 @@ jobs:
 
       - name: Run CSS tests
         run: npm run css-test
+
+      # Check that there are no stylelint multiline comments (e.g. /* stylelint-disable */)
+      - name: Check built CSS files
+        shell: bash
+        run: |
+          if [[ $(find dist/css/ -name "*.css" | xargs grep -F "/* stylelint" | wc -l | bc) -eq 0 ]]; then
+            echo "All good, no stylelint multiline comments found"
+            exit 0
+          else
+            echo "Found stylelint multiline comments!"
+            exit 1
+          fi

.github/workflows/js.yml

@@ -48,7 +48,7 @@ jobs:
         run: npm run js-test
 
       - name: Run Coveralls
-        uses: coverallsapp/github-action@v2.0.0
+        uses: coverallsapp/github-action@v2
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
           path-to-lcov: "./js/coverage/lcov.info"

.github/workflows/node-sass.yml

@@ -38,14 +38,15 @@ jobs:
           npx --package node-sass@latest node-sass --output-style expanded --source-map true --source-map-contents true --precision 6 scss/ -o dist-sass/css/
           ls -Al dist-sass/css
 
-      # Check that there are no Sass variables (`$`)
-      - name: Check built CSS files
+      - name: Check built CSS files for Sass variables
         shell: bash
         run: |
-          if [[ $(find dist-sass/css/ -name "*.css" | xargs grep -F "\$" | wc -l | bc) -eq 0 ]]; then
-            echo "All good, no Sass variables found"
+          SASS_VARS_FOUND=$(find "dist-sass/css/" -type f -name "*.css" -print0 | xargs -0 --no-run-if-empty grep -F "\$" || true)
+          if [[ -z "$SASS_VARS_FOUND" ]]; then
+            echo "All good, no Sass variables found!"
             exit 0
           else
-            echo "Found Sass variables!"
+            echo "Found $(echo "$SASS_VARS_FOUND" | wc -l | bc) Sass variables:"
+            echo "$SASS_VARS_FOUND"
             exit 1
           fi

.github/workflows/update-pr-desc-links.yml

@@ -0,0 +1,30 @@
+name: Update PR Description Netlify Preview URLs
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  track_pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get PR Description
+        run: |
+          PR_UPDATED_BODY="$(
+            gh api /repos/$OWNER/$REPO/pulls/$PR_NUMBER | jq -r '.body' | sed 's/{your_pr_number}/${{ env.PR_NUMBER }}/g'
+          )"
+          echo 'PR_UPDATED_BODY='$PR_UPDATED_BODY >> $GITHUB_ENV
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOOSTED_MOD_PERSONAL_TOKEN_CLASSIC }}
+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.number }}
+
+      - name: Update PR Description
+        run: |
+          gh api --method PATCH /repos/$OWNER/$REPO/pulls/$PR_NUMBER -f body="$PR_UPDATED_BODY"
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOOSTED_MOD_PERSONAL_TOKEN_CLASSIC }}
+          OWNER: ${{ github.repository_owner }}
+          REPO: ${{ github.event.repository.name }}
+          PR_NUMBER: ${{ github.event.number }}

.gitignore

@@ -40,6 +40,7 @@ Thumbs.db
 *.komodoproject
 
 # Folders to ignore
+/dist-sass/
 /js/coverage/
 /node_modules/
 /.pa11y/

build/banner.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const pkg = require('../package.json')
+
 const year = new Date().getFullYear()
 
 function getBanner(pluginFilename) {

build/change-version.js

@@ -35,9 +35,17 @@ function regExpQuoteReplacement(string) {
 
 async function replaceRecursively(file, oldVersion, newVersion) {
   const originalString = await fs.readFile(file, 'utf8')
-  const newString = originalString.replace(
-    new RegExp(regExpQuote(oldVersion), 'g'), regExpQuoteReplacement(newVersion)
-  )
+  const newString = originalString
+    .replace(
+      new RegExp(regExpQuote(oldVersion), 'g'),
+      regExpQuoteReplacement(newVersion)
+    )
+    // Also replace the version used by the rubygem,
+    // which is using periods (`.`) instead of hyphens (`-`)
+    .replace(
+      new RegExp(regExpQuote(oldVersion.replace(/-/g, '.')), 'g'),
+      regExpQuoteReplacement(newVersion.replace(/-/g, '.'))
+    )
 
   // No need to move any further if the strings are identical
   if (originalString === newString) {
@@ -55,22 +63,35 @@ async function replaceRecursively(file, oldVersion, newVersion) {
   await fs.writeFile(file, newString, 'utf8')
 }
 
+function showUsage(args) {
+  console.error('USAGE: change-version old_version new_version [--verbose] [--dry[-run]]')
+  console.error('Got arguments:', args)
+  process.exit(1)
+}
+
 async function main(args) {
   let [oldVersion, newVersion] = args
 
   if (!oldVersion || !newVersion) {
-    console.error('USAGE: change-version old_version new_version [--verbose] [--dry[-run]]')
-    console.error('Got arguments:', args)
-    process.exit(1)
+    showUsage(args)
   }
 
-  // Strip any leading `v` from arguments because otherwise we will end up with duplicate `v`s
-  [oldVersion, newVersion] = [oldVersion, newVersion].map(arg => arg.startsWith('v') ? arg.slice(1) : arg)
+  // Strip any leading `v` from arguments because
+  // otherwise we will end up with duplicate `v`s
+  [oldVersion, newVersion] = [oldVersion, newVersion].map(arg => {
+    return arg.startsWith('v') ? arg.slice(1) : arg
+  })
+
+  if (oldVersion === newVersion) {
+    showUsage(args)
+  }
 
   try {
     const files = await globby(GLOB, GLOBBY_OPTIONS)
 
-    await Promise.all(files.map(file => replaceRecursively(file, oldVersion, newVersion)))
+    await Promise.all(
+      files.map(file => replaceRecursively(file, oldVersion, newVersion))
+    )
   } catch (error) {
     console.error(error)
     process.exit(1)