fix e2e tests that failed on the added deprecation messages

Author: trusktr

src/core/config.js

@@ -64,9 +64,6 @@ const defaultDocsifyConfig = () => ({
 
   // Deprecations //////////////////
 
-  /** @deprecated */
-  topMargin: 0,
-
   /** @deprecated */
   get themeColor() {
     return this.__themeColor;
@@ -78,17 +75,40 @@ const defaultDocsifyConfig = () => ({
       // eslint-disable-next-line no-console
       console.warn(
         stripIndent(`
-              $docsify.themeColor is deprecated. Use the "--theme-color" theme property to set your theme color.
-              <style>
-                :root {
-                  --theme-color: deeppink;
-                }
-              </style>
-            `).trim(),
+          $docsify.themeColor is deprecated as of v5. Use the "--theme-color" CSS property to customize your theme color.
+          <style>
+            :root {
+              --theme-color: deeppink;
+            }
+          </style>
+        `).trim(),
       );
     }
   },
   __themeColor: '',
+
+  /** @deprecated */
+  get topMargin() {
+    return this.__topMargin;
+  },
+  set topMargin(value) {
+    if (value) {
+      this.__topMargin = value;
+
+      // eslint-disable-next-line no-console
+      console.warn(
+        stripIndent(`
+          $docsify.topMargin is deprecated as of v5. Use the "--scroll-padding-top" CSS property to specify a scroll margin when using a sticky navbar.
+          <style>
+            :root {
+              --scroll-padding-top: 10px;
+            }
+          </style>
+        `).trim(),
+      );
+    }
+  },
+  __topMargin: 0,
 });
 
 /** @typedef {ReturnType<typeof defaultDocsifyConfig>} DocsifyConfig */
@@ -100,14 +120,13 @@ const defaultDocsifyConfig = () => ({
  */
 export default function (vm, config = {}) {
   if (window.$docsify) {
+    // eslint-disable-next-line no-console
     console.warn(
       'DEPRECATION: The global $docsify config variable is deprecated. See the latest getting started docs. https://docsify.js.org/#/quickstart',
     );
   }
 
   config = Object.assign(
-    {},
-
     defaultDocsifyConfig(),
 
     // Handle non-function configs no matter what (f.e. plugins assign options onto it)
@@ -156,6 +175,7 @@ export default function (vm, config = {}) {
       const val = script.getAttribute('data-' + hyphenate(prop));
 
       if (isPrimitive(val)) {
+        // eslint-disable-next-line no-console
         console.warn(
           `DEPRECATION: data-* attributes on the docsify global script (f.e. ${
             'data-' + hyphenate(prop)

test/e2e/configuration.test.js

@@ -41,7 +41,11 @@ test.describe('Configuration options', () => {
     test('false (throws uncaught errors)', async ({ page }) => {
       let consoleMsg, errorMsg;
 
-      page.on('console', msg => (consoleMsg = msg.text()));
+      page.on('console', msg => {
+        const text = msg.text();
+        if (text.startsWith('DEPRECATION:')) {return;} // ignore expected deprecation warnings
+        consoleMsg = text;
+      });
       page.on('pageerror', err => (errorMsg = err.message));
 
       await docsifyInit({

test/e2e/plugins.test.js

@@ -16,7 +16,11 @@ test.describe('Plugins', () => {
       'ready',
     ];
 
-    page.on('console', msg => consoleMsgs.push(msg.text()));
+    page.on('console', msg => {
+      const text = msg.text();
+      if (text.startsWith('DEPRECATION:')) {return;} // ignore expected deprecation warnings
+      consoleMsgs.push(text);
+    });
 
     await docsifyInit({
       config: {
@@ -166,8 +170,14 @@ test.describe('Plugins', () => {
       page.on('console', async msg => {
         for (const arg of msg.args()) {
           const val = await arg.jsonValue();
-          const obj = JSON.parse(val);
-          obj.response && (routeData = obj);
+          if (typeof val === 'string' && val.startsWith('DEPRECATION:'))
+            {continue;}
+          try {
+            const obj = typeof val === 'string' ? JSON.parse(val) : val;
+            obj && obj.response && (routeData = obj);
+          } catch {
+            // ignore non-JSON console messages
+          }
         }
       });
     });