Merge branch 'main' into format-tests

.github/workflows/lighthouse-ci.yml

@@ -20,7 +20,11 @@ jobs:
               run: yarn install
             - name: Build pages
               run: yarn build
+            - name: Build urls
+              run: node ./lighthouse/lighthouse-get-urls.js
             - name: Run Lighthouse CI
-              run: ./lighthouse/lighthouse.sh
+              run: |
+                  npm install -g @lhci/[email protected]
+                  lhci autorun --config=./lighthouse/lighthouserc.js
               env:
                   LHCI_GITHUB_APP_TOKEN: ${{ secrets.LHCI_GITHUB_APP_TOKEN }}

README.md

@@ -44,6 +44,15 @@ yarn start
 
 Once the server has started, navigate to <http://localhost:3030>
 
+## Lighthouse Testing - local
+
+This project uses [LHCI](https://www.npmjs.com/package/@lhci/cli).
+
+```bash
+yarn global add @lhci/cli
+yarn test-lighthouse 
+```
+
 ## Testing - macros and scripts
 
 This project uses [jest](https://jestjs.io/docs/cli) and supports its command line options.

lighthouse/lighthouse-get-urls.js

@@ -30,9 +30,10 @@ async function getURLs() {
     for (const directory of directories) {
         const folders = await readdir(directory.path);
         for (const folder of folders) {
-            const files = await glob(`${directory.path}/${folder}/**/*.html`, { ignore: `${directory.path}/${folder}/index.html` });
-            for (const file of files) {
-                data.urls.push(file.replace('./build/', 'http://localhost:9000/'));
+            const files = await glob(`${directory.path}/${folder}/**/*.html`);
+            const filteredFiles = files.filter((path) => !path.includes('index.html') && !path.includes('example-skip-to-content.html'));
+            for (const file of filteredFiles) {
+                data.urls.push(file.replace('build/', 'http://localhost/'));
             }
         }
     }

lighthouse/lighthouserc.js

@@ -1,6 +1,8 @@
 module.exports = {
     ci: {
         collect: {
+            staticDistDir: './build',
+            url: require('./urls.json').urls,
             numberOfRuns: 1,
             settings: {
                 onlyCategories: ['accessibility'],

package.json

@@ -15,6 +15,7 @@
         "test:no-build": "TEST_PORT=3020 TEST_WITH_PUPPETEER=1 jest '.*\\.spec\\.js'",
         "test:with-log": "yarn test --no-color 2>test.log",
         "test:start-server": "TEST_PORT=3020 gulp start-dev-server",
+        "test-lighthouse": "yarn build && node ./lighthouse/lighthouse-get-urls.js && lhci autorun --config=./lighthouse/lighthouserc.js",
         "build": "yarn && yarn tidy-clean && NODE_ENV=production gulp build",
         "build-serve": "yarn build && gulp start-dev-server",
         "npm-bundle": "NODE_ENV=production yarn tidy-clean && NODE_ENV=production gulp build-package && babel-node ci/generate-npm-package.js",