@apify/docs-theme 1.0.165 → 1.0.167

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@apify/docs-theme",
-    "version": "1.0.165",
+    "version": "1.0.167",
     "description": "",
     "main": "./src/index.js",
     "files": [

package/src/markdown.js

@@ -1,27 +1,7 @@
 const remarkParse = require('remark-parse');
 const remarkStringify = require('remark-stringify');
 const { unified } = require('unified');
-const { visitParents } = require('unist-util-visit-parents');
-
-/**
- * Updates the markdown content for better UX and compatibility with Docusaurus v3.
- * @param {string} changelog The markdown content.
- * @returns {string} The updated markdown content.
- */
-function updateChangelog(changelog) {
-    const pipeline = unified()
-        .use(remarkParse)
-        .use(removeGitCliffMarkers)
-        .use(incrementHeadingLevels)
-        .use(prettifyPRLinks)
-        .use(linkifyUserTags)
-        .use(remarkStringify);
-
-    changelog = pipeline.processSync(changelog).toString();
-    changelog = addFrontmatter(changelog);
-    changelog = escapeMDXCharacters(changelog);
-    return changelog;
-}
+const { visitParents, CONTINUE } = require('unist-util-visit-parents');
 
 /**
  * Bumps the headings levels in the markdown content. This function increases the depth
@@ -60,7 +40,7 @@ const linkifyUserTags = () => (tree) => {
 
         const directParent = parents[parents.length - 1];
 
-        if (!match || directParent.type === 'link') return;
+        if (!match || directParent.type === 'link') return CONTINUE;
 
         const nodeIndexInParent = directParent.children.findIndex((x) => x === node);
 
@@ -77,10 +57,10 @@ const linkifyUserTags = () => (tree) => {
         node.value = before;
         directParent.children.splice(nodeIndexInParent + 1, 0, link);
 
-        if (!after) return nodeIndexInParent + 2;
+        if (!after) return [CONTINUE, nodeIndexInParent + 2];
 
         directParent.children.splice(nodeIndexInParent + 2, 0, { type: 'text', value: `${ending}${after}` });
-        return nodeIndexInParent + 3;
+        return [CONTINUE, nodeIndexInParent + 3];
     });
 };
 
@@ -95,7 +75,7 @@ const prettifyPRLinks = () => (tree) => {
         const prLinkRegex = /https:\/\/github.com\/[^\s]+\/pull\/(\d+)/g;
         const match = prLinkRegex.exec(node.value);
 
-        if (!match) return;
+        if (!match) return CONTINUE;
 
         const directParent = parents[parents.length - 1];
         const nodeIndexInParent = directParent.children.findIndex((x) => x === node);
@@ -112,10 +92,10 @@ const prettifyPRLinks = () => (tree) => {
         node.value = before;
 
         directParent.children.splice(nodeIndexInParent + 1, 0, link);
-        if (!after) return nodeIndexInParent + 1;
+        if (!after) return [CONTINUE, nodeIndexInParent + 1];
 
         directParent.children.splice(nodeIndexInParent + 2, 0, { type: 'text', value: after });
-        return nodeIndexInParent + 2;
+        return [CONTINUE, nodeIndexInParent + 2];
     });
 };
 
@@ -148,6 +128,26 @@ function escapeMDXCharacters(changelog) {
     });
 }
 
+/**
+ * Updates the markdown content for better UX and compatibility with Docusaurus v3.
+ * @param {string} changelog The markdown content.
+ * @returns {string} The updated markdown content.
+ */
+function updateChangelog(changelog) {
+    const pipeline = unified()
+        .use(remarkParse)
+        .use(removeGitCliffMarkers)
+        .use(incrementHeadingLevels)
+        .use(prettifyPRLinks)
+        .use(linkifyUserTags)
+        .use(remarkStringify);
+
+    changelog = pipeline.processSync(changelog).toString();
+    changelog = addFrontmatter(changelog);
+    changelog = escapeMDXCharacters(changelog);
+    return changelog;
+}
+
 module.exports = {
     updateChangelog,
 };

package/src/roa-loader/index.js

@@ -38,13 +38,14 @@ async function getHash(source) {
     })).json();
 
     if (!res.data || !res.data.encoded) {
-        // eslint-disable-next-line no-console
         console.error(`Signing failed:' ${inspect(res.error) || 'Unknown error'}`, res);
         return 'invalid-token';
     }
 
     cache[cacheKey] = res.data.encoded;
-    await new Promise((resolve) => setTimeout(resolve, 100));
+    await new Promise((resolve) => {
+        setTimeout(resolve, 100);
+    });
 
     return res.data.encoded;
 }
@@ -79,7 +80,6 @@ module.exports = async function (code) {
         return { code, hash: 'fast' };
     }
 
-    // eslint-disable-next-line no-console
     console.log(`Signing ${urlToRequest(this.resourcePath)}...`, { working, queue: queue.length });
     const codeHash = await encodeAndSign(code);
 

package/src/theme/ColorModeToggle/index.jsx

@@ -1,11 +1,11 @@
-import React from 'react';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import clsx from 'clsx';
-import useIsBrowser from '@docusaurus/useIsBrowser';
 import { translate } from '@docusaurus/Translate';
-import IconLightMode from '../Icon/LightMode';
-import IconDarkMode from '../Icon/DarkMode';
+import useIsBrowser from '@docusaurus/useIsBrowser';
+import clsx from 'clsx';
+import React from 'react';
+
 import styles from './styles.module.css';
+import IconDarkMode from '../Icon/DarkMode';
+import IconLightMode from '../Icon/LightMode';
 
 function ColorModeToggle({
     className,

package/src/theme/DocSidebarItem/Link/index.jsx

@@ -1,12 +1,12 @@
-import React from 'react';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import clsx from 'clsx';
+import isInternalUrl from '@docusaurus/isInternalUrl';
+import Link from '@docusaurus/Link';
+import { isActiveSidebarItem } from '@docusaurus/plugin-content-docs/client';
 import { ThemeClassNames } from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { isActiveSidebarItem } from '@docusaurus/plugin-content-docs/client';
-import Link from '@docusaurus/Link';
-import isInternalUrl from '@docusaurus/isInternalUrl';
 import IconExternalLink from '@theme/Icon/ExternalLink';
+import clsx from 'clsx';
+import React from 'react';
+
 import styles from './styles.module.css';
 
 export default function DocSidebarItemLink({

package/src/theme/Footer/index.jsx

@@ -1,8 +1,8 @@
-import React from 'react';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import clsx from 'clsx';
 import { useThemeConfig } from '@docusaurus/theme-common';
 import LinkItem from '@theme/Footer/LinkItem';
+import clsx from 'clsx';
+import React from 'react';
+
 import styles from './index.module.css';
 
 function FooterLinksColumn({ column }) {

package/src/theme/Layout/index.jsx

@@ -1,9 +1,9 @@
-import React from 'react';
+import { useLocation } from '@docusaurus/router';
 // cannot use any of the theme aliases here as it causes a circular dependency :( ideas welcome
 import Layout from '@docusaurus/theme-classic/lib/theme/Layout/index';
-import { usePluginData } from '@docusaurus/useGlobalData';
 import useBaseUrl from '@docusaurus/useBaseUrl';
-import { useLocation } from '@docusaurus/router';
+import { usePluginData } from '@docusaurus/useGlobalData';
+import React from 'react';
 
 export default function LayoutWrapper(props) {
     const { options: { subNavbar } } = usePluginData('@apify/docs-theme');
@@ -13,9 +13,9 @@ export default function LayoutWrapper(props) {
     return (
         <div style={{
             '--ifm-navbar-height': subNavbar && !currentPath.startsWith('api/v2') ? '123px' : '68px',
-            'margin': 0,
-            'padding': 0,
-            'boxSizing': 'border-box',
+            margin: 0,
+            padding: 0,
+            boxSizing: 'border-box',
         }}>
             <Layout {...props} />
         </div>

package/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.jsx

@@ -1,8 +1,8 @@
-import React from 'react';
 import { useThemeConfig } from '@docusaurus/theme-common';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import { usePluginData } from '@docusaurus/useGlobalData';
 import NavbarItem from '@theme/NavbarItem';
+import React from 'react';
 
 function useNavbarItems() {
     // TODO temporary casting until ThemeConfig type is improved

package/src/theme/NavbarItem/ComponentTypes.jsx

@@ -1,13 +1,13 @@
+import { useDocsVersion, useLayoutDoc } from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+import DocSidebarNavbarItem from '@theme/NavbarItem/DocSidebarNavbarItem';
+import DocsVersionDropdownNavbarItem from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
+import DocsVersionNavbarItem from '@theme/NavbarItem/DocsVersionNavbarItem';
 import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
+import HtmlNavbarItem from '@theme/NavbarItem/HtmlNavbarItem';
 import LocaleDropdownNavbarItem from '@theme/NavbarItem/LocaleDropdownNavbarItem';
 import SearchNavbarItem from '@theme/NavbarItem/SearchNavbarItem';
-import HtmlNavbarItem from '@theme/NavbarItem/HtmlNavbarItem';
-import DocSidebarNavbarItem from '@theme/NavbarItem/DocSidebarNavbarItem';
-import DocsVersionNavbarItem from '@theme/NavbarItem/DocsVersionNavbarItem';
-import DocsVersionDropdownNavbarItem from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
-import { useDocsVersion, useLayoutDoc } from '@docusaurus/plugin-content-docs/client';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import React from 'react';
 
 // const versions = require('../../../versions.json');
@@ -40,7 +40,6 @@ function ApiNavbarItem(ctx) {
     let version = {};
 
     try {
-        // eslint-disable-next-line react-hooks/rules-of-hooks
         version = useDocsVersion();
     } catch {
         version.version = stable;
@@ -87,15 +86,15 @@ function ApiNavbarItem(ctx) {
 }
 
 const ComponentTypes = {
-    'default': DefaultNavbarItem,
-    'localeDropdown': LocaleDropdownNavbarItem,
-    'search': SearchNavbarItem,
-    'dropdown': DropdownNavbarItem,
-    'html': HtmlNavbarItem,
+    default: DefaultNavbarItem,
+    localeDropdown: LocaleDropdownNavbarItem,
+    search: SearchNavbarItem,
+    dropdown: DropdownNavbarItem,
+    html: HtmlNavbarItem,
     'custom-api': ApiNavbarItem,
-    'doc': DocNavbarItem,
-    'docSidebar': DocSidebarNavbarItem,
-    'docsVersion': DocsVersionNavbarItem,
-    'docsVersionDropdown': DocsVersionDropdownNavbarItem,
+    doc: DocNavbarItem,
+    docSidebar: DocSidebarNavbarItem,
+    docsVersion: DocsVersionNavbarItem,
+    docsVersionDropdown: DocsVersionDropdownNavbarItem,
 };
 export default ComponentTypes;

package/src/theme/RunnableCodeBlock/RunnableCodeBlock.jsx

@@ -1,8 +1,8 @@
-import React from 'react';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import clsx from 'clsx';
-import CodeBlock from '@theme/CodeBlock';
 import Link from '@docusaurus/Link';
+import CodeBlock from '@theme/CodeBlock';
+import clsx from 'clsx';
+import React from 'react';
+
 import styles from './RunnableCodeBlock.module.css';
 
 const EXAMPLE_RUNNERS = {

package/src/theme/SearchBar/index.js

@@ -1,10 +1,11 @@
-import { ApifySearch } from '@apify/docs-search-modal';
 import BrowserOnly from '@docusaurus/BrowserOnly';
 import RouterLink from '@docusaurus/Link';
 import { useLocation, useHistory } from '@docusaurus/router';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import React, { useCallback } from 'react';
 
+import { ApifySearch } from '@apify/docs-search-modal';
+
 /**
  * Tests whether the given href is pointing to the current docusaurus instance (so we can use the router link).
  */

package/src/theme.js

@@ -108,7 +108,6 @@ This either means that your Docusaurus setup is misconfigured, or that your GitH
                     await generateChangelogFromGitHubReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
                 }
             } catch (e) {
-                // eslint-disable-next-line no-console
                 console.warn(`Changelog page could not be initialized: ${e.message}`);
             }
         },