@openedx/frontend-build 15.0.0-alpha.2 → 15.0.0-alpha.20

package/lib/plugins/paragon-webpack-plugin/utils/htmlUtils.js

@@ -0,0 +1,69 @@
+const { sources } = require('webpack');
+
+const { getCssAssetsFromCompilation } = require('./assetUtils');
+const { generateScriptContents, insertScriptContentsIntoDocument } = require('./scriptUtils');
+
+/**
+ * Injects metadata into the HTML document by modifying the 'index.html' asset in the compilation.
+ *
+ * @param {Object} compilation - The Webpack compilation object.
+ * @param {Object} options - The options object.
+ * @param {Object} options.paragonThemeCss - The Paragon theme CSS object.
+ * @param {string} options.paragonVersion - The version of the Paragon theme.
+ * @param {Object} options.brandThemeCss - The brand theme CSS object.
+ * @param {string} options.brandVersion - The version of the brand theme.
+ * @return {Object|undefined} The script contents object if the 'index.html' asset exists, otherwise undefined.
+ */
+function injectMetadataIntoDocument(compilation, {
+  paragonThemeCss,
+  paragonVersion,
+  brandThemeCss,
+  brandVersion,
+}) {
+  const file = compilation.getAsset('index.html');
+  if (!file) {
+    return undefined;
+  }
+  const {
+    coreCssAsset: paragonCoreCssAsset,
+    themeVariantCssAssets: paragonThemeVariantCssAssets,
+  } = getCssAssetsFromCompilation(compilation, {
+    brandThemeCss,
+    paragonThemeCss,
+  });
+  const {
+    coreCssAsset: brandCoreCssAsset,
+    themeVariantCssAssets: brandThemeVariantCssAssets,
+  } = getCssAssetsFromCompilation(compilation, {
+    isBrandOverride: true,
+    brandThemeCss,
+    paragonThemeCss,
+  });
+
+  const scriptContents = generateScriptContents({
+    paragonCoreCssAsset,
+    paragonThemeVariantCssAssets,
+    brandCoreCssAsset,
+    brandThemeVariantCssAssets,
+    paragonThemeCss,
+    paragonVersion,
+    brandThemeCss,
+    brandVersion,
+  });
+
+  const originalSource = file.source.source();
+  const newSource = insertScriptContentsIntoDocument({
+    originalSource,
+    coreCssAsset: paragonCoreCssAsset,
+    themeVariantCssAssets: paragonThemeVariantCssAssets,
+    scriptContents,
+  });
+
+  compilation.updateAsset('index.html', new sources.RawSource(newSource.source()));
+
+  return scriptContents;
+}
+
+module.exports = {
+  injectMetadataIntoDocument,
+};

package/lib/plugins/paragon-webpack-plugin/utils/index.js

@@ -0,0 +1,9 @@
+const { getParagonStylesheetUrls, injectParagonCoreStylesheets, injectParagonThemeVariantStylesheets } = require('./paragonStylesheetUtils');
+const { injectMetadataIntoDocument } = require('./htmlUtils');
+
+module.exports = {
+  injectMetadataIntoDocument,
+  getParagonStylesheetUrls,
+  injectParagonCoreStylesheets,
+  injectParagonThemeVariantStylesheets,
+};

package/lib/plugins/paragon-webpack-plugin/utils/paragonStylesheetUtils.js

@@ -0,0 +1,120 @@
+const { insertStylesheetsIntoDocument } = require('./stylesheetUtils');
+const { handleVersionSubstitution } = require('./tagUtils');
+
+/**
+ * Injects Paragon core stylesheets into the document.
+ *
+ * @param {Object} options - The options object.
+ * @param {string|object} options.source - The source HTML document.
+ * @param {Object} options.paragonCoreCss - The Paragon core CSS object.
+ * @param {Object} options.paragonThemeCss - The Paragon theme CSS object.
+ * @param {Object} options.brandThemeCss - The brand theme CSS object.
+ * @return {string|object} The modified HTML document with Paragon core stylesheets injected.
+ */
+function injectParagonCoreStylesheets({
+  source,
+  paragonCoreCss,
+  paragonThemeCss,
+  brandThemeCss,
+}) {
+  return insertStylesheetsIntoDocument({
+    source,
+    urls: paragonCoreCss.urls,
+    paragonThemeCss,
+    brandThemeCss,
+  });
+}
+
+/**
+ * Injects Paragon theme variant stylesheets into the document.
+ *
+ * @param {Object} options - The options object.
+ * @param {string|object} options.source - The source HTML document.
+ * @param {Object} options.paragonThemeVariantCss - The Paragon theme variant CSS object.
+ * @param {Object} options.paragonThemeCss - The Paragon theme CSS object.
+ * @param {Object} options.brandThemeCss - The brand theme CSS object.
+ * @return {string|object} The modified HTML document with Paragon theme variant stylesheets injected.
+ */
+function injectParagonThemeVariantStylesheets({
+  source,
+  paragonThemeVariantCss,
+  paragonThemeCss,
+  brandThemeCss,
+}) {
+  let newSource = source;
+  Object.values(paragonThemeVariantCss).forEach(({ urls }) => {
+    newSource = insertStylesheetsIntoDocument({
+      source: typeof newSource === 'object' ? newSource.source() : newSource,
+      urls,
+      paragonThemeCss,
+      brandThemeCss,
+    });
+  });
+  return newSource;
+}
+/**
+ * Retrieves the URLs of the Paragon stylesheets based on the provided theme URLs, Paragon version, and brand version.
+ *
+ * @param {Object} options - The options object.
+ * @param {Object} options.paragonThemeUrls - The URLs of the Paragon theme.
+ * @param {string} options.paragonVersion - The version of the Paragon theme.
+ * @param {string} options.brandVersion - The version of the brand theme.
+ * @return {Object} An object containing the URLs of the Paragon stylesheets.
+ */
+function getParagonStylesheetUrls({ paragonThemeUrls, paragonVersion, brandVersion }) {
+  const paragonCoreCssUrl = typeof paragonThemeUrls.core.urls === 'object' ? paragonThemeUrls.core.urls.default : paragonThemeUrls.core.url;
+  const brandCoreCssUrl = typeof paragonThemeUrls.core.urls === 'object' ? paragonThemeUrls.core.urls.brandOverride : undefined;
+
+  const defaultThemeVariants = paragonThemeUrls.defaults || {};
+
+  const coreCss = {
+    urls: {
+      default: handleVersionSubstitution({ url: paragonCoreCssUrl, wildcardKeyword: '$paragonVersion', localVersion: paragonVersion }),
+      brandOverride: handleVersionSubstitution({ url: brandCoreCssUrl, wildcardKeyword: '$brandVersion', localVersion: brandVersion }),
+    },
+  };
+
+  const themeVariantsCss = {};
+  const themeVariantsEntries = Object.entries(paragonThemeUrls.variants || {});
+  themeVariantsEntries.forEach(([themeVariant, { url, urls }]) => {
+    const themeVariantMetadata = { urls: null };
+    if (url) {
+      themeVariantMetadata.urls = {
+        default: handleVersionSubstitution({
+          url,
+          wildcardKeyword: '$paragonVersion',
+          localVersion: paragonVersion,
+        }),
+        // If there is no brand override URL, then we don't need to do any version substitution
+        // but we still need to return the property.
+        brandOverride: undefined,
+      };
+    } else {
+      themeVariantMetadata.urls = {
+        default: handleVersionSubstitution({
+          url: urls.default,
+          wildcardKeyword: '$paragonVersion',
+          localVersion: paragonVersion,
+        }),
+        brandOverride: handleVersionSubstitution({
+          url: urls.brandOverride,
+          wildcardKeyword: '$brandVersion',
+          localVersion: brandVersion,
+        }),
+      };
+    }
+    themeVariantsCss[themeVariant] = themeVariantMetadata;
+  });
+
+  return {
+    core: coreCss,
+    variants: themeVariantsCss,
+    defaults: defaultThemeVariants,
+  };
+}
+
+module.exports = {
+  injectParagonCoreStylesheets,
+  injectParagonThemeVariantStylesheets,
+  getParagonStylesheetUrls,
+};

package/lib/plugins/paragon-webpack-plugin/utils/scriptUtils.js

@@ -0,0 +1,144 @@
+const { sources } = require('webpack');
+const parse5 = require('parse5');
+
+const { getDescendantByTag, minifyScript } = require('./tagUtils');
+
+/**
+ * Finds the insertion point for a script in an HTML document.
+ *
+ * @param {Object} options - The options object.
+ * @param {Object} options.document - The parsed HTML document.
+ * @param {string} options.originalSource - The original source code of the HTML document.
+ * @throws {Error} If the body element is missing in the HTML document.
+ * @return {number} The insertion point for the script in the HTML document.
+ */
+function findScriptInsertionPoint({ document, originalSource }) {
+  const bodyElement = getDescendantByTag(document, 'body');
+  if (!bodyElement) {
+    throw new Error('Missing body element in index.html.');
+  }
+
+  // determine script insertion point
+  if (bodyElement.sourceCodeLocation?.endTag) {
+    return bodyElement.sourceCodeLocation.endTag.startOffset;
+  }
+
+  // less accurate fallback
+  return originalSource.indexOf('</body>');
+}
+
+/**
+ * Inserts the given script contents into the HTML document and returns a new source with the modified content.
+ *
+ * @param {Object} options - The options object.
+ * @param {string} options.originalSource - The original HTML source.
+ * @param {Object} options.scriptContents - The contents of the script to be inserted.
+ * @return {sources.ReplaceSource} The new source with the modified HTML content.
+ */
+function insertScriptContentsIntoDocument({
+  originalSource,
+  scriptContents,
+}) {
+  // parse file as html document
+  const document = parse5.parse(originalSource, {
+    sourceCodeLocationInfo: true,
+  });
+
+  // find the body element
+  const scriptInsertionPoint = findScriptInsertionPoint({
+    document,
+    originalSource,
+  });
+
+  // create Paragon script to inject into the HTML document
+  const paragonScript = `<script type="text/javascript">var PARAGON_THEME = ${JSON.stringify(scriptContents, null, 2)};</script>`;
+
+  // insert the Paragon script into the HTML document
+  const newSource = new sources.ReplaceSource(
+    new sources.RawSource(originalSource),
+    'index.html',
+  );
+  newSource.insert(scriptInsertionPoint, minifyScript(paragonScript));
+  return newSource;
+}
+
+/**
+ * Creates an object with the provided version, defaults, coreCssAsset, and themeVariantCssAssets
+ * and returns it. The returned object has the following structure:
+ * {
+ *   version: The provided version,
+ *   themeUrls: {
+ *     core: The provided coreCssAsset,
+ *     variants: The provided themeVariantCssAssets,
+ *     defaults: The provided defaults
+ *   }
+ * }
+ *
+ * @param {Object} options - The options object.
+ * @param {string} options.version - The version to be added to the returned object.
+ * @param {Object} options.defaults - The defaults to be added to the returned object.
+ * @param {Object} options.coreCssAsset - The coreCssAsset to be added to the returned object.
+ * @param {Object} options.themeVariantCssAssets - The themeVariantCssAssets to be added to the returned object.
+ * @return {Object} The object with the provided version, defaults, coreCssAsset, and themeVariantCssAssets.
+ */
+function addToScriptContents({
+  version,
+  defaults,
+  coreCssAsset,
+  themeVariantCssAssets,
+}) {
+  return {
+    version,
+    themeUrls: {
+      core: coreCssAsset,
+      variants: themeVariantCssAssets,
+      defaults,
+    },
+  };
+}
+
+/**
+ * Generates the script contents object based on the provided assets and versions.
+ *
+ * @param {Object} options - The options object.
+ * @param {Object} options.paragonCoreCssAsset - The asset for the Paragon core CSS.
+ * @param {Object} options.paragonThemeVariantCssAssets - The assets for the Paragon theme variants.
+ * @param {Object} options.brandCoreCssAsset - The asset for the brand core CSS.
+ * @param {Object} options.brandThemeVariantCssAssets - The assets for the brand theme variants.
+ * @param {Object} options.paragonThemeCss - The Paragon theme CSS.
+ * @param {string} options.paragonVersion - The version of the Paragon theme.
+ * @param {Object} options.brandThemeCss - The brand theme CSS.
+ * @param {string} options.brandVersion - The version of the brand theme.
+ * @return {Object} The script contents object.
+ */
+function generateScriptContents({
+  paragonCoreCssAsset,
+  paragonThemeVariantCssAssets,
+  brandCoreCssAsset,
+  brandThemeVariantCssAssets,
+  paragonThemeCss,
+  paragonVersion,
+  brandThemeCss,
+  brandVersion,
+}) {
+  const scriptContents = {};
+  scriptContents.paragon = addToScriptContents({
+    version: paragonVersion,
+    coreCssAsset: paragonCoreCssAsset,
+    themeVariantCssAssets: paragonThemeVariantCssAssets,
+    defaults: paragonThemeCss?.defaults,
+  });
+  scriptContents.brand = addToScriptContents({
+    version: brandVersion,
+    coreCssAsset: brandCoreCssAsset,
+    themeVariantCssAssets: brandThemeVariantCssAssets,
+    defaults: brandThemeCss?.defaults,
+  });
+  return scriptContents;
+}
+
+module.exports = {
+  addToScriptContents,
+  insertScriptContentsIntoDocument,
+  generateScriptContents,
+};

package/lib/plugins/paragon-webpack-plugin/utils/stylesheetUtils.js

@@ -0,0 +1,107 @@
+const parse5 = require('parse5');
+const { sources } = require('webpack');
+
+const { getDescendantByTag } = require('./tagUtils');
+
+/**
+ * Finds the insertion point for a stylesheet in an HTML document.
+ *
+ * @param {Object} options - The options object.
+ * @param {Object} options.document - The parsed HTML document.
+ * @param {string} options.source - The original source code of the HTML document.
+ * @throws {Error} If the head element is missing in the HTML document.
+ * @return {number} The insertion point for the stylesheet in the HTML document.
+ */
+function findStylesheetInsertionPoint({ document, source }) {
+  const headElement = getDescendantByTag(document, 'head');
+  if (!headElement) {
+    throw new Error('Missing head element in index.html.');
+  }
+
+  // determine script insertion point
+  if (headElement.sourceCodeLocation?.startTag) {
+    return headElement.sourceCodeLocation.startTag.endOffset;
+  }
+
+  // less accurate fallback
+  const headTagString = '<head>';
+  const headTagIndex = source.indexOf(headTagString);
+  return headTagIndex + headTagString.length;
+}
+
+/**
+ * Inserts stylesheets into an HTML document.
+ *
+ * @param {object} options - The options for inserting stylesheets.
+ * @param {string} options.source - The HTML source code.
+ * @param {object} options.urls - The URLs of the stylesheets to be inserted.
+ * @param {string} options.urls.default - The URL of the default stylesheet.
+ * @param {string} options.urls.brandOverride - The URL of the brand override stylesheet.
+ * @return {object} The new source code with the stylesheets inserted.
+ */
+function insertStylesheetsIntoDocument({
+  source,
+  urls,
+}) {
+  // parse file as html document
+  const document = parse5.parse(source, {
+    sourceCodeLocationInfo: true,
+  });
+  if (!getDescendantByTag(document, 'head')) {
+    return undefined;
+  }
+
+  const newSource = new sources.ReplaceSource(
+    new sources.RawSource(source),
+    'index.html',
+  );
+
+  // insert the brand overrides styles into the HTML document
+  const stylesheetInsertionPoint = findStylesheetInsertionPoint({
+    document,
+    source: newSource,
+  });
+
+  /**
+   * Creates a new stylesheet link element.
+   *
+   * @param {string} url - The URL of the stylesheet.
+   * @return {string} The HTML code for the stylesheet link element.
+   */
+  function createNewStylesheet(url) {
+    const baseLink = `<link
+      type="text/css"
+      rel="preload"
+      as="style"
+      href="${url}"
+      onload="this.rel='stylesheet';"
+      onerror="this.remove();"
+    />`;
+    return baseLink;
+  }
+
+  if (urls.default) {
+    const existingDefaultLink = getDescendantByTag(`link[href='${urls.default}']`);
+    if (!existingDefaultLink) {
+      // create link to inject into the HTML document
+      const stylesheetLink = createNewStylesheet(urls.default);
+      newSource.insert(stylesheetInsertionPoint, stylesheetLink);
+    }
+  }
+
+  if (urls.brandOverride) {
+    const existingBrandLink = getDescendantByTag(`link[href='${urls.brandOverride}']`);
+    if (!existingBrandLink) {
+      // create link to inject into the HTML document
+      const stylesheetLink = createNewStylesheet(urls.brandOverride);
+      newSource.insert(stylesheetInsertionPoint, stylesheetLink);
+    }
+  }
+
+  return newSource;
+}
+
+module.exports = {
+  findStylesheetInsertionPoint,
+  insertStylesheetsIntoDocument,
+};

package/lib/plugins/paragon-webpack-plugin/utils/tagUtils.js

@@ -0,0 +1,58 @@
+/**
+ * Recursively searches for a descendant node with the specified tag name.
+ *
+ * @param {Object} node - The root node to start the search from.
+ * @param {string} tag - The tag name to search for.
+ * @return {Object|null} The first descendant node with the specified tag name, or null if not found.
+ */
+function getDescendantByTag(node, tag) {
+  for (let i = 0; i < node.childNodes?.length; i++) {
+    if (node.childNodes[i].tagName === tag) {
+      return node.childNodes[i];
+    }
+    const result = getDescendantByTag(node.childNodes[i], tag);
+    if (result) {
+      return result;
+    }
+  }
+  return null;
+}
+
+/**
+ * Replaces a wildcard keyword in a URL with a local version.
+ *
+ * @param {Object} options - The options object.
+ * @param {string} options.url - The URL to substitute the keyword in.
+ * @param {string} options.wildcardKeyword - The wildcard keyword to replace.
+ * @param {string} options.localVersion - The local version to substitute the keyword with.
+ * @return {string} The URL with the wildcard keyword substituted with the local version,
+ *                 or the original URL if no substitution is needed.
+ */
+function handleVersionSubstitution({ url, wildcardKeyword, localVersion }) {
+  if (!url || !url.includes(wildcardKeyword) || !localVersion) {
+    return url;
+  }
+  return url.replaceAll(wildcardKeyword, localVersion);
+}
+
+/**
+ * Minifies a script by removing unnecessary whitespace and line breaks.
+ *
+ * @param {string} script - The script to be minified.
+ * @return {string} The minified script.
+ */
+function minifyScript(script) {
+  return script
+    .replace(/>[\r\n ]+</g, '><')
+    .replace(/(<.*?>)|\s+/g, (m, $1) => {
+      if ($1) { return $1; }
+      return ' ';
+    })
+    .trim();
+}
+
+module.exports = {
+  getDescendantByTag,
+  handleVersionSubstitution,
+  minifyScript,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-build",
-  "version": "15.0.0-alpha.2",
+  "version": "15.0.0-alpha.20",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"
@@ -13,6 +13,12 @@
     "lint": "eslint . --no-eslintrc -c .eslintrc.js",
     "test": "bash ./smoke-test.sh"
   },
+  "files": [
+    "/bin",
+    "/config",
+    "/lib",
+    "tsconfig.json"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/openedx/frontend-build.git"
@@ -25,25 +31,25 @@
   },
   "homepage": "https://github.com/openedx/frontend-build#readme",
   "dependencies": {
-    "@babel/cli": "7.22.5",
-    "@babel/core": "7.22.5",
+    "@babel/cli": "7.24.8",
+    "@babel/core": "7.24.9",
     "@babel/eslint-parser": "7.22.9",
     "@babel/plugin-proposal-class-properties": "7.18.6",
     "@babel/plugin-proposal-object-rest-spread": "7.20.7",
     "@babel/plugin-syntax-dynamic-import": "7.8.3",
-    "@babel/preset-env": "7.22.5",
-    "@babel/preset-react": "7.22.5",
-    "@edx/eslint-config": "4.0.0",
+    "@babel/preset-env": "7.24.8",
+    "@babel/preset-react": "7.24.7",
+    "@edx/eslint-config": "4.2.0",
     "@edx/new-relic-source-map-webpack-plugin": "2.1.0",
-    "@edx/typescript-config": "1.0.1",
+    "@edx/typescript-config": "1.1.0",
     "@formatjs/cli": "^6.0.3",
     "@fullhuman/postcss-purgecss": "5.0.0",
-    "@pmmmwh/react-refresh-webpack-plugin": "0.5.11",
+    "@pmmmwh/react-refresh-webpack-plugin": "0.5.15",
     "@svgr/webpack": "8.1.0",
     "@types/jest": "29.5.12",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
-    "autoprefixer": "10.4.19",
+    "autoprefixer": "10.4.20",
     "babel-jest": "29.6.1",
     "babel-loader": "9.1.3",
     "babel-plugin-formatjs": "^10.4.0",
@@ -71,26 +77,28 @@
     "jest": "29.6.1",
     "jest-environment-jsdom": "29.6.1",
     "mini-css-extract-plugin": "1.6.2",
-    "postcss": "8.4.38",
-    "postcss-custom-media": "10.0.4",
+    "parse5": "7.1.2",
+    "postcss": "8.4.47",
+    "postcss-custom-media": "10.0.8",
     "postcss-loader": "7.3.4",
     "postcss-rtlcss": "5.1.2",
     "react-dev-utils": "12.0.1",
-    "react-refresh": "0.14.0",
+    "react-refresh": "0.14.2",
     "resolve-url-loader": "5.0.0",
     "sass": "1.69.7",
     "sass-loader": "13.3.3",
     "sharp": "0.32.6",
     "source-map-loader": "4.0.2",
     "style-loader": "3.3.4",
-    "ts-jest": "29.1.2",
+    "ts-jest": "29.1.4",
     "typescript": "4.9.5",
     "url-loader": "4.1.1",
     "webpack": "^5.89.0",
     "webpack-bundle-analyzer": "^4.10.1",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1",
-    "webpack-merge": "^5.10.0"
+    "webpack-merge": "^5.10.0",
+    "webpack-remove-empty-scripts": "1.0.4"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.18.6",

package/.eslintignore

@@ -1,5 +0,0 @@
-coverage/*
-dist/
-node_modules/
-__mocks__/
-__snapshots__/

package/.eslintrc.js

@@ -1,10 +0,0 @@
-const { createConfig } = require('.');
-
-module.exports = createConfig('eslint', {
-  rules: {
-    'no-console': 'off',
-    'import/no-dynamic-require': 'off',
-    'global-require': 'off',
-    'no-template-curly-in-string': 'off',
-  },
-});

package/.github/workflows/add-depr-ticket-to-depr-board.yml

@@ -1,19 +0,0 @@
-# Run the workflow that adds new tickets that are either:
-# - labelled "DEPR"
-# - title starts with "[DEPR]"
-# - body starts with "Proposal Date" (this is the first template field)
-# to the org-wide DEPR project board
-
-name: Add newly created DEPR issues to the DEPR project board
-
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  routeissue:
-    uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
-    secrets:
-      GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
-      GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
-      SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}

package/.github/workflows/add-remove-label-on-comment.yml

@@ -1,20 +0,0 @@
-# This workflow runs when a comment is made on the ticket
-# If the comment starts with "label: " it tries to apply
-# the label indicated in rest of comment.
-# If the comment starts with "remove label: ", it tries
-# to remove the indicated label.
-# Note: Labels are allowed to have spaces and this script does
-# not parse spaces (as often a space is legitimate), so the command
-# "label: really long lots of words label" will apply the
-# label "really long lots of words label"
-
-name: Allows for the adding and removing of labels via comment
-
-on:
-  issue_comment:
-    types: [created]
-
-jobs:
-  add_remove_labels:
-    uses: openedx/.github/.github/workflows/add-remove-label-on-comment.yml@master
-

package/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: Default CI
-on:
-  push:
-    branches:
-    - master
-  pull_request:
-    branches:
-    - '**'
-jobs:
-  tests:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Setup Nodejs Env
-      run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
-    - name: Setup Nodejs
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ env.NODE_VER }}
-    - name: Install dependencies
-      run: npm ci
-    - name: Lint
-      run: npm run lint
-    - name: Test
-      run: npm run test
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3