feat: log option key renamings to console (#150)

* feat: added logging for deprecated config options

* fix: added formatError

* fix: uppercase

Author: mxschmitt

README.md

@@ -83,7 +83,7 @@ You can specify a `jest-playwright.config.js` at the root of the project or defi
   - `webkit` Each test runs Webkit.
 - `devices` <[string[]]>. Define a [devices](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsertypedevices) to run tests in. Actual list of devices can be found [here](https://github.com/Microsoft/playwright/blob/master/src/deviceDescriptors.ts).
 - `exitOnPageError` <[boolean]> Exits process on any page error. Defaults to `true`.
-- `server` <[object]> [All `jest-dev-server` options](https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-dev-server#options).
+- `serverOptions` <[object]> [All `jest-dev-server` options](https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-dev-server#options).
 - `selectors` <[array]>. Define [selectors](https://github.com/microsoft/playwright/blob/v0.11.1/docs/api.md#class-selectors). Each selector must be an object with name and script properties.
 
   Usage with [query-selector-shadow-dom](https://github.com/Georgegriff/query-selector-shadow-dom):

src/constants.ts

@@ -15,3 +15,5 @@ export const DEFAULT_CONFIG: Config = {
 }
 
 export const DEFAULT_TEST_PLAYWRIGHT_TIMEOUT = 15000
+
+export const PACKAGE_NAME = 'jest-playwright-preset'

src/utils.ts

@@ -14,6 +14,7 @@ import {
   FIREFOX,
   IMPORT_KIND_PLAYWRIGHT,
   WEBKIT,
+  PACKAGE_NAME,
 } from './constants'
 
 const exists = promisify(fs.exists)
@@ -42,7 +43,9 @@ export const checkDependencies = (
 export const checkBrowserEnv = (param: BrowserType): void => {
   if (param !== CHROMIUM && param !== FIREFOX && param !== WEBKIT) {
     throw new Error(
-      `Wrong browser type. Should be one of [${CHROMIUM}, ${FIREFOX}, ${WEBKIT}], but got ${param}`,
+      formatError(
+        `Wrong browser type. Should be one of [${CHROMIUM}, ${FIREFOX}, ${WEBKIT}], but got ${param}`,
+      ),
     )
   }
 }
@@ -53,7 +56,9 @@ export const checkDeviceEnv = (
 ): void => {
   if (!availableDevices.includes(device)) {
     throw new Error(
-      `Wrong device. Should be one of [${availableDevices}], but got ${device}`,
+      formatError(
+        `Wrong device. Should be one of [${availableDevices}], but got ${device}`,
+      ),
     )
   }
 }
@@ -95,7 +100,9 @@ export const readPackage = async (): Promise<
     checkDependencies(packageConfig.dependencies) ||
     checkDependencies(packageConfig.devDependencies)
   if (playwright === null) {
-    throw new Error('None of playwright packages was not found in dependencies')
+    throw new Error(
+      formatError('None of playwright packages was not found in dependencies'),
+    )
   }
   return playwright
 }
@@ -116,13 +123,46 @@ export const getPlaywrightInstance = (
     return buildPlaywrightStructure('playwright')
   }
   if (!playwrightPackage[browserName]) {
-    throw new Error('Cannot find provided playwright package')
+    throw new Error(formatError('Cannot find provided playwright package'))
   }
   return buildPlaywrightStructure(
     `playwright-${playwrightPackage[browserName]}`,
   )
 }
 
+const validateConfig = (config: Config) => {
+  const renamings = [
+    {
+      from: 'launchBrowserApp',
+      to: 'launchOptions',
+    },
+    {
+      from: 'connectBrowserApp',
+      to: 'connectOptions',
+    },
+    {
+      from: 'context',
+      to: 'contextOptions',
+    },
+    {
+      from: 'server',
+      to: 'serverOptions',
+    },
+  ]
+  const hasError = renamings.some(({ from, to }) => {
+    if (from in config) {
+      console.warn(
+        formatError(`"${from}" was renamed to "${to}" in version 1.0`),
+      )
+      return true
+    }
+    return false
+  })
+  if (hasError) {
+    throw new Error(formatError('Validation error occurred'))
+  }
+}
+
 export const readConfig = async (
   rootDir: string = process.cwd(),
 ): Promise<Config> => {
@@ -134,7 +174,9 @@ export const readConfig = async (
 
   if (hasCustomConfigPath && !configExists) {
     throw new Error(
-      `Error: Can't find a root directory while resolving a config file path.\nProvided path to resolve: ${configPath}`,
+      formatError(
+        `Can't find a root directory while resolving a config file path.\nProvided path to resolve: ${configPath}`,
+      ),
     )
   }
 
@@ -143,6 +185,7 @@ export const readConfig = async (
   }
 
   const localConfig = await require(absConfigPath)
+  validateConfig(localConfig)
   return {
     ...DEFAULT_CONFIG,
     ...localConfig,
@@ -156,3 +199,6 @@ export const readConfig = async (
     },
   }
 }
+
+export const formatError = (error: string): string =>
+  `${PACKAGE_NAME}: ${error}`