@openedx/frontend-base 1.0.0-alpha.8 → 1.0.0

package/package.json

@@ -1,32 +1,46 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "1.0.0-alpha.8",
+  "version": "1.0.0",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./tools": "./dist/tools/index.js",
+    "./tools/tsconfig.json": "./dist/tools/typescript/tsconfig.json",
+    "./shell/layer-order.scss": "./dist/shell/layer-order.scss",
+    "./shell/style": "./dist/shell/style.js",
+    "./shell/site": "./dist/shell/site.js"
+  },
   "files": [
-    "/config",
-    "/runtime",
-    "/tools/dist",
-    "/shell",
-    "/types.ts"
+    "/dist"
   ],
   "bin": {
-    "intl-imports.js": "tools/dist/cli/scripts/intl-imports.js",
-    "openedx": "tools/dist/cli/openedx.js",
-    "transifex-utils.js": "tools/dist/cli/scripts/transifex-utils.js"
+    "openedx": "./dist/tools/cli/openedx.js"
+  },
+  "atlasTranslations": {
+    "path": "translations/frontend-base/src/i18n/messages",
+    "dependencies": [
+      "@openedx/paragon"
+    ]
   },
   "scripts": {
     "build": "make build",
-    "clean": "rm -rf dist",
-    "dev": "npm run build && node ./tools/dist/cli/openedx.js dev:shell",
+    "clean": "make clean",
+    "dev": "npm run build && node ./dist/tools/cli/openedx.js dev:shell",
     "docs": "jsdoc -c jsdoc.json",
-    "docs:watch": "nodemon -w runtime -w docs/template -w README.md -e js,jsx,ts,tsx --exec npm run docs",
     "lint": "eslint .; npm run lint:tools; npm --prefix ./test-site run lint",
+    "lint:fix": "eslint . --fix; npm run lint:fix:tools",
     "lint:tools": "cd ./tools && eslint . && cd ..",
-    "test": "jest"
+    "lint:fix:tools": "cd ./tools && eslint . --fix && cd ..",
+    "pack": "mkdir -p pack && npm pack --silent --pack-destination pack >/dev/null && mv \"$(ls -t pack/*.tgz | head -n 1)\" pack/openedx-frontend-base.tgz",
+    "prepack": "npm run build",
+    "test": "jest",
+    "watch:build": "nodemon --exec 'npm run build'",
+    "watch:docs": "nodemon --watch docs/template --watch README.md --exec npm run docs",
+    "watch:pack": "nodemon --exec 'npm run pack'",
+    "i18n_extract": "npm run build && node ./dist/tools/cli/openedx.js formatjs extract --include=shell"
   },
   "repository": {
     "type": "git",
@@ -40,7 +54,8 @@
   },
   "sideEffects": [
     "*.css",
-    "*.scss"
+    "*.scss",
+    "**/shell/style.{js,ts}"
   ],
   "homepage": "https://github.com/openedx/frontend-base#readme",
   "dependencies": {
@@ -53,8 +68,9 @@
     "@eslint/js": "^9.13.0",
     "@formatjs/cli": "^6.0.3",
     "@formatjs/ts-transformer": "^3.13.14",
-    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.15",
+    "@pmmmwh/react-refresh-webpack-plugin": "^0.6.0",
     "@stylistic/eslint-plugin": "^2.9.0",
+    "@tanstack/react-query-devtools": "^5.99.0",
     "@types/eslint__js": "^8.42.3",
     "@types/gradient-string": "^1.1.6",
     "autoprefixer": "^10.4.20",
@@ -81,7 +97,7 @@
     "glob": "^7.2.3",
     "globals": "^15.11.0",
     "gradient-string": "^2.0.2",
-    "html-webpack-plugin": "5.6.0",
+    "html-webpack-plugin": "5.6.7",
     "identity-obj-proxy": "3.0.0",
     "image-minimizer-webpack-plugin": "3.8.3",
     "jest": "^29.7.0",
@@ -90,31 +106,29 @@
     "jwt-decode": "^3.1.2",
     "localforage": "^1.10.0",
     "localforage-memoryStorageDriver": "^0.9.2",
-    "lodash.camelcase": "^4.3.0",
-    "lodash.memoize": "^4.1.2",
-    "lodash.merge": "^4.6.2",
-    "lodash.snakecase": "^4.1.1",
+    "lodash": "^4.18.1",
     "mini-css-extract-plugin": "1.6.2",
-    "parse5": "7.1.2",
+    "parse5": "7.3.0",
     "postcss": "^8.4.47",
     "postcss-custom-media": "10.0.8",
     "postcss-loader": "7.3.4",
     "postcss-rtlcss": "^5.5.0",
     "prop-types": "^15.8.1",
     "react-dev-utils": "12.0.1",
-    "react-focus-on": "<3.10.0",
+    "react-focus-on": "^3.10.2",
     "react-intl": "^6.6.6",
-    "react-refresh": "0.16.0",
+    "react-refresh": "0.18.0",
     "react-refresh-typescript": "^2.0.9",
     "react-responsive": "^10.0.0",
     "react-transition-group": "^4.4.5",
     "resolve-url-loader": "^5.0.0",
     "sass-embedded": "^1.87.0",
     "sass-loader": "^16.0.2",
-    "sharp": "^0.33.5",
+    "sharp": "^0.34.0",
     "source-map-loader": "4.0.2",
     "style-loader": "^4.0.0",
-    "ts-loader": "^9.5.1",
+    "ts-loader": "^9.5.7",
+    "tsconfig-paths-webpack-plugin": "^4.2.0",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.11.0",
     "universal-cookie": "^8.0.1",
@@ -125,7 +139,7 @@
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^5.1.0",
     "webpack-merge": "^5.10.0",
-    "webpack-remove-empty-scripts": "1.0.4"
+    "webpack-remove-empty-scripts": "1.1.1"
   },
   "devDependencies": {
     "@edx/browserslist-config": "^1.5.0",
@@ -133,12 +147,11 @@
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
-    "@tsconfig/node20": "^20.1.5",
+    "@tsconfig/node24": "^24.0.4",
     "@types/compression": "^1.7.5",
     "@types/jest": "^29.5.14",
-    "@types/lodash.camelcase": "^4.3.9",
-    "@types/lodash.merge": "^4.6.9",
-    "@types/node": "^18.19.43",
+    "@types/lodash": "^4.17.24",
+    "@types/node": "^24.12.0",
     "@types/react": "^18.3.20",
     "@types/react-dom": "^18.3.6",
     "axios-mock-adapter": "^1.22.0",
@@ -147,7 +160,7 @@
     "nodemon": "^3.1.4"
   },
   "peerDependencies": {
-    "@openedx/paragon": "^23.4.5",
+    "@openedx/paragon": "^23.20.0",
     "@tanstack/react-query": "^5.81.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",

package/config/eslint/base.eslint.config.js

@@ -1,113 +0,0 @@
-"use strict";
-// @ts-check
-const { fixupPluginRules } = require('@eslint/compat');
-const eslint = require('@eslint/js');
-const formatjs = require('eslint-plugin-formatjs');
-const jest = require('eslint-plugin-jest');
-const jsxA11y = require('eslint-plugin-jsx-a11y');
-const react = require('eslint-plugin-react');
-const reactHooks = require('eslint-plugin-react-hooks');
-const globals = require('globals');
-const tseslint = require('typescript-eslint');
-const stylistic = require('@stylistic/eslint-plugin');
-module.exports = tseslint.config(eslint.configs.recommended, ...tseslint.configs.stylisticTypeChecked, ...tseslint.configs.recommended, stylistic.configs['recommended-flat'], {
-    ignores: [
-        'coverage/*',
-        'dist/*',
-        'node_modules/*',
-        '**/__mocks__/*',
-        '**/__snapshots__/*',
-    ],
-}, {
-    languageOptions: {
-        parserOptions: {
-            projectService: true,
-        }
-    }
-}, {
-    languageOptions: {
-        ...(react.configs.flat !== undefined ? react.configs.flat.recommended.languageOptions : {}),
-        globals: {
-            ...globals.browser,
-            ...globals.node,
-            ...globals.jest,
-            newrelic: 'readonly',
-        },
-    },
-    plugins: {
-        jest,
-        // Type assertion is workaround for incorrect TypeScript
-        // types in eslint-plugin-react
-        //
-        // TODO: Remove when types are fixed in eslint-plugin-react
-        // - https://github.com/jsx-eslint/eslint-plugin-react/issues/3838
-        react: /** @type {import('eslint').ESLint.Plugin} */ (react),
-        'react-hooks': fixupPluginRules(reactHooks),
-        formatjs,
-        'jsx-a11y': jsxA11y,
-    },
-    settings: {
-        react: {
-            version: 'detect',
-        }
-    }
-}, {
-    rules: {
-        // For some reasons the 'flat' key in react.configs is optional, so Typescript complains if
-        // we don't guard using it.  But... it exists in the export, so something's odd with their types.
-        ...(react.configs.flat !== undefined ? react.configs.flat.recommended.rules : {}),
-        ...(react.configs.flat !== undefined ? react.configs.flat['jsx-runtime'].rules : {}),
-        ...reactHooks.configs.recommended.rules,
-        '@typescript-eslint/no-explicit-any': 'off',
-        '@typescript-eslint/non-nullable-type-assertion-style': 'off',
-        'react/no-array-index-key': 'error',
-        'formatjs/enforce-description': ['error', 'literal'],
-        'jsx-a11y/label-has-associated-control': ['error', {
-                labelComponents: [],
-                labelAttributes: [],
-                controlComponents: [],
-                assert: 'htmlFor',
-                depth: 25,
-            }],
-        // https://github.com/evcohen/eslint-plugin-jsx-a11y/issues/340#issuecomment-338424908
-        'jsx-a11y/anchor-is-valid': ['error', {
-                components: ['Link'],
-                specialLink: ['to'],
-            }],
-        '@typescript-eslint/no-unused-vars': ['error', {
-                caughtErrors: 'none',
-            }],
-        '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/prefer-nullish-coalescing': 'off',
-        '@stylistic/semi': ['error', 'always', { omitLastInOneLineBlock: true, omitLastInOneLineClassBody: true }],
-        '@stylistic/quotes': ['error', 'single', {
-                avoidEscape: true,
-                allowTemplateLiterals: true,
-            }],
-        '@stylistic/comma-dangle': 'off',
-        '@stylistic/quote-props': ['error', 'as-needed'],
-        '@stylistic/arrow-parens': 'off',
-        '@stylistic/jsx-one-expression-per-line': 'off',
-        '@stylistic/multiline-ternary': 'off',
-        '@stylistic/brace-style': ['error', '1tbs'],
-        '@stylistic/member-delimiter-style': ['error', {
-                multiline: {
-                    delimiter: 'comma',
-                    requireLast: true,
-                },
-                singleline: {
-                    delimiter: 'comma',
-                    requireLast: false,
-                }
-            }],
-    },
-}, {
-    files: [
-        'babel.config.js',
-        'jest.config.js',
-        'eslint.config.js'
-    ],
-    rules: {
-        '@typescript-eslint/no-require-imports': 'off'
-    }
-});

package/config/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "jsx": "react-jsx",
-    "lib": [
-      "DOM",
-      "DOM.Iterable",
-      "ESNext",
-      "esnext.intl",
-      "es2017.intl",
-      "es2018.intl"
-    ],
-    "isolatedModules": true,
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "noEmit": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": false,
-    "noImplicitThis": true,
-    "noUnusedParameters": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "strict": true,
-    "strictFunctionTypes": false,
-    "target": "ES6"
-  }
-}

package/config/types.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandTypes = exports.ConfigTypes = void 0;
-var ConfigTypes;
-(function (ConfigTypes) {
-    ConfigTypes["BABEL"] = "babel";
-    ConfigTypes["WEBPACK_BUILD"] = "webpack-build";
-    ConfigTypes["WEBPACK_DEV"] = "webpack-dev";
-    ConfigTypes["WEBPACK_DEV_SHELL"] = "webpack-dev-shell";
-    ConfigTypes["LINT"] = "lint";
-    ConfigTypes["TEST"] = "test";
-})(ConfigTypes || (exports.ConfigTypes = ConfigTypes = {}));
-var CommandTypes;
-(function (CommandTypes) {
-    CommandTypes["LINT"] = "lint";
-    CommandTypes["TEST"] = "test";
-    CommandTypes["BUILD"] = "build";
-    CommandTypes["DEV_SHELL"] = "dev:shell";
-    CommandTypes["DEV"] = "dev";
-    CommandTypes["FORMAT_JS"] = "formatjs";
-    CommandTypes["SERVE"] = "serve";
-    CommandTypes["HELP"] = "help";
-})(CommandTypes || (exports.CommandTypes = CommandTypes = {}));

package/config/webpack/common-config/all/getIgnoreWarnings.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getIgnoreWarnings;
-function getIgnoreWarnings() {
-    return [
-        // Ignore warnings raised by source-map-loader.
-        // some third party packages may ship miss-configured sourcemaps, that interrupts the build
-        // See: https://github.com/facebook/create-react-app/discussions/11278#discussioncomment-1780169
-        (warning) => !!(
-        // @ts-expect-error 'resource' is something TypeScript can't find for whatever reason.
-        warning.module?.resource.includes('node_modules')
-            && warning.details?.includes('source-map-loader')),
-    ];
-}

package/config/webpack/common-config/all/getStylesheetRule.js

@@ -1,112 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getStylesheetRule;
-const autoprefixer_1 = __importDefault(require("autoprefixer"));
-const cssnano_1 = __importDefault(require("cssnano"));
-const mini_css_extract_plugin_1 = __importDefault(require("mini-css-extract-plugin"));
-const path_1 = __importDefault(require("path"));
-const postcss_custom_media_1 = __importDefault(require("postcss-custom-media"));
-const postcss_rtlcss_1 = __importDefault(require("postcss-rtlcss"));
-/**
- * There are a few things we need to do here.
- *
- * - We only want to use MiniCssExtractPlugin on dependencies in dev, but not on our source code.
- * - We only want CssNano in production.
- */
-function getStylesheetRule(mode) {
-    if (mode === 'production') {
-        // In the production case, all files should go through MiniCssExtractPlugin.
-        return {
-            test: /(.scss|.css)$/,
-            use: [
-                mini_css_extract_plugin_1.default.loader,
-                ...getStyleUseConfig(mode),
-            ],
-        };
-    }
-    else {
-        // In the dev case, only our @openedx dependencies go through MiniCssExtractPlugin.
-        // We are not extracting CSS from the javascript bundles in development because extracting
-        // prevents hot-reloading from working, it increases build time, and we don't care about
-        // flash-of-unstyled-content issues in development.
-        return {
-            test: /(.scss|.css)$/,
-            oneOf: [
-                {
-                    resource: /(@openedx\/paragon|@(open)?edx\/brand)/,
-                    use: [
-                        mini_css_extract_plugin_1.default.loader,
-                        ...getStyleUseConfig(mode),
-                    ],
-                },
-                {
-                    use: [
-                        require.resolve('style-loader'), // creates style nodes from JS strings
-                        ...getStyleUseConfig(mode),
-                    ],
-                },
-            ]
-        };
-    }
-}
-function getStyleUseConfig(mode) {
-    return [
-        {
-            loader: require.resolve('css-loader'), // translates CSS into CommonJS
-            options: {
-                sourceMap: true,
-                modules: {
-                    // namedExport defaults to true in css-loader v7, but we rely on the old behavior.
-                    // Details here:
-                    // https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md#700-2024-04-04
-                    namedExport: false,
-                    mode: 'icss',
-                },
-            },
-        },
-        {
-            loader: require.resolve('postcss-loader'),
-            options: {
-                postcssOptions: {
-                    plugins: getPostCssLoaderPlugins(mode), // Different behavior for dev and production.
-                },
-            },
-        },
-        require.resolve('resolve-url-loader'),
-        {
-            loader: require.resolve('sass-loader'), // compiles Sass to CSS
-            options: {
-                sourceMap: true,
-                sassOptions: {
-                    includePaths: [
-                        path_1.default.join(process.cwd(), 'node_modules'),
-                        path_1.default.join(process.cwd(), 'src'),
-                    ],
-                    // Silences compiler deprecation warnings.  They mostly come from bootstrap and/or paragon.
-                    quietDeps: true,
-                    silenceDeprecations: ['abs-percent', 'color-functions', 'import', 'global-builtin', 'legacy-js-api'],
-                },
-            },
-        },
-    ];
-}
-/**
- * This exists just to conditionally include CssNano in production.
- */
-function getPostCssLoaderPlugins(mode) {
-    const plugins = [
-        (0, autoprefixer_1.default)({
-            remove: false, // Prevents removing vendor prefixes
-        }),
-        (0, postcss_rtlcss_1.default)(),
-    ];
-    // We want CSSNano third, and only in production.
-    if (mode === 'production') {
-        plugins.push((0, cssnano_1.default)());
-    }
-    plugins.push((0, postcss_custom_media_1.default)());
-    return plugins;
-}

package/config/webpack/common-config/dev/getDevServer.js

@@ -1,38 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getDevServer;
-const path_1 = __importDefault(require("path"));
-const getPublicPath_1 = __importDefault(require("../../utils/getPublicPath"));
-function getDevServer() {
-    return {
-        allowedHosts: 'all',
-        headers: {
-            'Access-Control-Allow-Origin': '*',
-        },
-        // For obvious reasons, 'auto' won't work for publicPath here, so we
-        // force '/' unless PUBLIC_PATH is set.
-        historyApiFallback: {
-            index: path_1.default.join((0, getPublicPath_1.default)('/'), 'index.html'),
-            disableDotRule: true,
-        },
-        host: 'apps.local.openedx.io',
-        hot: true,
-        port: process.env.PORT ?? 8080,
-        proxy: [
-            {
-                context: ['/api/mfe_config/v1'],
-                target: 'http://local.openedx.io:8000',
-                changeOrigin: true,
-            }
-        ],
-        // Enable hot reloading server. It will provide WDS_SOCKET_PATH endpoint
-        // for the WebpackDevServer client so it can learn when the files were
-        // updated. The WebpackDevServer client is included as an entry point
-        // in the webpack development configuration. Note that only changes
-        // to CSS are currently hot reloaded. JS changes will refresh the browser.
-        webSocketServer: 'ws',
-    };
-}

package/config/webpack/common-config/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHtmlWebpackPlugin = exports.getDevServer = exports.getStylesheetRule = exports.getImageMinimizer = exports.getFileLoaderRules = exports.getCodeRules = void 0;
-var getCodeRules_1 = require("./all/getCodeRules");
-Object.defineProperty(exports, "getCodeRules", { enumerable: true, get: function () { return __importDefault(getCodeRules_1).default; } });
-var getFileLoaderRules_1 = require("./all/getFileLoaderRules");
-Object.defineProperty(exports, "getFileLoaderRules", { enumerable: true, get: function () { return __importDefault(getFileLoaderRules_1).default; } });
-var getImageMinimizer_1 = require("./all/getImageMinimizer");
-Object.defineProperty(exports, "getImageMinimizer", { enumerable: true, get: function () { return __importDefault(getImageMinimizer_1).default; } });
-var getStylesheetRule_1 = require("./all/getStylesheetRule");
-Object.defineProperty(exports, "getStylesheetRule", { enumerable: true, get: function () { return __importDefault(getStylesheetRule_1).default; } });
-var getDevServer_1 = require("./dev/getDevServer");
-Object.defineProperty(exports, "getDevServer", { enumerable: true, get: function () { return __importDefault(getDevServer_1).default; } });
-var getHtmlWebpackPlugin_1 = require("./site/getHtmlWebpackPlugin");
-Object.defineProperty(exports, "getHtmlWebpackPlugin", { enumerable: true, get: function () { return __importDefault(getHtmlWebpackPlugin_1).default; } });

package/config/webpack/common-config/site/getHtmlWebpackPlugin.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getHtmlWebpackPlugin;
-const html_webpack_plugin_1 = __importDefault(require("html-webpack-plugin"));
-const path_1 = __importDefault(require("path"));
-// Generates an HTML file in the output directory.
-function getHtmlWebpackPlugin() {
-    return new html_webpack_plugin_1.default({
-        inject: true, // Appends script tags linking to the webpack bundles at the end of the body
-        template: path_1.default.resolve(process.cwd(), 'public/index.html'),
-        chunks: ['app'],
-    });
-}

package/config/webpack/plugins/html-webpack-new-relic-plugin/test/HtmlWebpackNewRelicPlugin.test.js

@@ -1,66 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const html_webpack_plugin_1 = __importDefault(require("html-webpack-plugin"));
-const path_1 = __importDefault(require("path"));
-const webpack_1 = __importDefault(require("webpack"));
-const HtmlWebpackNewRelicPlugin_1 = __importDefault(require("../HtmlWebpackNewRelicPlugin"));
-const OUTPUT_DIR = path_1.default.join(__dirname, './dist');
-describe('HtmlWebpackNewRelicPlugin', () => {
-    const testPluginOptions = {
-        accountID: '121212',
-        agentID: '343434',
-        trustKey: '565656',
-        licenseKey: '123456',
-        applicationID: '654321',
-    };
-    afterEach(() => {
-        if (fs_1.default.existsSync(OUTPUT_DIR)) {
-            fs_1.default.rmSync(OUTPUT_DIR, { recursive: true, force: true });
-        }
-    });
-    it('should append new relic script to body', done => {
-        (0, webpack_1.default)({
-            entry: path_1.default.resolve(__dirname, 'fixtures', 'entry.js'),
-            output: {
-                path: path_1.default.resolve(__dirname, './dist'),
-            },
-            plugins: [
-                new html_webpack_plugin_1.default(),
-                new HtmlWebpackNewRelicPlugin_1.default(testPluginOptions),
-            ],
-        }, (err) => {
-            const htmlFile = path_1.default.resolve(OUTPUT_DIR, 'index.html');
-            expect(err).toBeNull();
-            expect(fs_1.default.existsSync(htmlFile)).toBe(true);
-            const file = fs_1.default.readFileSync(path_1.default.resolve(OUTPUT_DIR, htmlFile), { encoding: 'utf-8' }, (error, data) => data.toString());
-            Object.entries(testPluginOptions).forEach(([optionName, optionValue]) => {
-                expect(file.indexOf(`${optionName}:"${optionValue}"`)).toBeGreaterThan(-1);
-            });
-            done();
-        });
-    });
-    describe('when its missing configuration variables', () => {
-        function testMissingOption(missingOptionName) {
-            it(`should throw error if ${missingOptionName} is missing`, done => {
-                const compiler = (0, webpack_1.default)({
-                    entry: path_1.default.resolve(__dirname, 'fixtures', 'entry.js'),
-                    output: {
-                        path: path_1.default.resolve(__dirname, '../dist'),
-                    },
-                    plugins: [new html_webpack_plugin_1.default()],
-                });
-                const optionsMissingOne = { ...testPluginOptions };
-                delete optionsMissingOne[missingOptionName];
-                expect(() => compiler.options.plugins.push(new HtmlWebpackNewRelicPlugin_1.default(optionsMissingOne))).toThrow(`${missingOptionName} argument is required`);
-                done();
-            });
-        }
-        Object.keys(testPluginOptions).forEach((key) => {
-            testMissingOption(key);
-        });
-    });
-});