[v3] set default head option as null in nextra-theme-docs and i…

…mprove bundle size (#2270)
shuding · Sep 7, 2023 · c77485e · c77485e
1 parent b9f88e3
commit c77485e
Show file tree

Hide file tree

Showing 11 changed files with 105 additions and 100 deletions.
diff --git a/.changeset/fair-balloons-talk.md b/.changeset/fair-balloons-talk.md
@@ -0,0 +1,5 @@
+---
+'nextra-theme-docs': minor
+---
+
+set default `head` option as `null`
diff --git a/packages/nextra-theme-docs/src/constants.tsx b/packages/nextra-theme-docs/src/constants.tsx
@@ -97,18 +97,7 @@ export const DEFAULT_THEME: DocsThemeConfig = {
       </>
     )
   },
-  head: (
-    <>
-      <meta name="msapplication-TileColor" content="#fff" />
-      <meta httpEquiv="Content-Language" content="en" />
-      <meta name="description" content="Nextra: the next docs builder" />
-      <meta name="twitter:card" content="summary_large_image" />
-      <meta name="twitter:site" content="@shuding_" />
-      <meta property="og:title" content="Nextra: the next docs builder" />
-      <meta property="og:description" content="Nextra: the next docs builder" />
-      <meta name="apple-mobile-web-app-title" content="Nextra" />
-    </>
-  ),
+  head: null,
   i18n: [],
   logo: (
     <>

diff --git a/packages/nextra/__test__/loader.test.ts b/packages/nextra/__test__/loader.test.ts
@@ -16,17 +16,26 @@ describe('tree shaking', async () => {
   )
   const pageChunkFileNames = await fs.readdir(pageChunksDirPath)
 
-  describe('_app', () => {
-    it('ensure zod is removed from production build with /* @__PURE__ */ comments', async () => {
-      const appFile = await fs.readFile(
-        path.join(
-          pageChunksDirPath,
-          pageChunkFileNames.find(name => name.startsWith('_app-'))!
-        ),
-        'utf8'
-      )
+  describe('_app', async () => {
+    const appFile = await fs.readFile(
+      path.join(
+        pageChunksDirPath,
+        pageChunkFileNames.find(name => name.startsWith('_app-'))!
+      ),
+      'utf8'
+    )
+    it('ensure `zod` is removed from production build with /* @__PURE__ */ comments', async () => {
       expect(appFile.includes('Zod')).toBe(false)
     })
+    it('ensure `title` is removed', () => {
+      expect(appFile.includes('ZEIT Inc.')).toBe(false)
+    })
+    it('ensure nextra logger is removed', () => {
+      expect(appFile.includes('[nextra]')).toBe(false)
+    })
+    it('ensure `slash` is removed', () => {
+      expect(appFile.includes('\\\\?\\')).toBe(false)
+    })
   })
 
   describe('index page', async () => {

diff --git a/packages/nextra/src/context.ts b/packages/nextra/src/context.ts
@@ -29,18 +29,18 @@ function filter(
 } {
   let activeLevelPages: Page[] = []
   const items: Page[] = []
-  const meta = pageMap.find(/* @__PURE__ */ isMeta)
+  const meta = pageMap.find(isMeta)
   const metaData = meta?.data || {}
 
   for (const item of pageMap) {
-    if (/* @__PURE__ */ isMeta(item)) continue
-    const meta = /* @__PURE__ */ normalizeMeta(metaData[item.name])
+    if (isMeta(item)) continue
+    const meta = normalizeMeta(metaData[item.name])
     const page = {
       ...item,
       ...(Object.keys(meta || {}).length > 0 && { meta })
     } as Page
 
-    if (/* @__PURE__ */ isFolder(page)) {
+    if (isFolder(page)) {
       const filtered = filter(page.children, activeLevel)
       page.children = filtered.items
       if (filtered.activeLevelPages.length) {

diff --git a/packages/nextra/src/index.ts b/packages/nextra/src/index.ts
@@ -11,8 +11,8 @@ import {
   MARKDOWN_EXTENSIONS
 } from './constants'
 import { nextraConfigSchema } from './schemas'
+import { logger } from './server/utils'
 import type { Nextra } from './types'
-import { logger } from './utils'
 import { NextraPlugin, NextraSearchPlugin } from './webpack-plugins'
 
 const DEFAULT_EXTENSIONS = ['js', 'jsx', 'ts', 'tsx']

diff --git a/packages/nextra/src/loader.ts b/packages/nextra/src/loader.ts
@@ -11,8 +11,9 @@ import {
 } from './constants'
 import { PAGES_DIR } from './file-system'
 import { collectMdx } from './plugin'
+import { logger, pageTitleFromFilename } from './server/utils'
 import type { FileMap, LoaderOptions, MdxPath, PageOpts } from './types'
-import { isMeta, logger, pageTitleFromFilename } from './utils'
+import { isMeta } from './utils'
 
 const initGitRepo = (async () => {
   const IS_WEB_CONTAINER = !!process.versions.webcontainer
@@ -266,7 +267,7 @@ ${themeConfigImport && '__nextra_internal__.themeConfig = __themeConfig'}`
     finalResult.slice(lastIndexOfFooter + FOOTER_TO_REMOVE.length)
   const pageMapPath = path.join(CHUNKS_DIR, `nextra-page-map-${locale}.mjs`)
 
-  const rawJs = `import { setupNextraPage } from 'nextra/setup-page'
+  const rawJs = `import { setupNextraPage, resolvePageMap } from 'nextra/setup-page'
 import { pageMap as __nextraPageMap, dynamicMetaModules } from '${pageMapPath}'
 ${isAppFileFromNodeModules ? cssImports : ''}
 ${mdxContent}
@@ -277,7 +278,7 @@ const __nextraPageOptions = {
   pageOpts: ${stringifiedPageOpts}
 }
 if (typeof window === 'undefined') {
-  __nextraPageOptions.dynamicMetaModules = dynamicMetaModules
+  globalThis.__nextra_resolvePageMap = resolvePageMap(dynamicMetaModules)
 }
 
 export default setupNextraPage(__nextraPageOptions)`

diff --git a/packages/nextra/src/normalize-pages.ts b/packages/nextra/src/normalize-pages.ts
@@ -96,7 +96,7 @@ export function normalizePages({
 }) {
   let _meta: Record<string, any> | undefined
   for (const item of list) {
-    if (/* @__PURE__ */ isMeta(item)) {
+    if (isMeta(item)) {
       _meta = item.data
       break
     }
@@ -140,7 +140,7 @@ export function normalizePages({
   const items = list
     .filter(
       (a): a is MdxFile | Folder =>
-        !(/* @__PURE__ */ isMeta(a)) &&
+        !isMeta(a) &&
         // not hidden routes
         !a.name.startsWith('_')
     )
@@ -259,7 +259,7 @@ export function normalizePages({
       }
     }
     if (
-      (display === 'hidden' && !(/* @__PURE__ */ isFolder(item))) ||
+      (display === 'hidden' && !isFolder(item)) ||
       ERROR_ROUTES.has(a.route)
     ) {
       continue

diff --git a/packages/nextra/src/plugin.ts b/packages/nextra/src/plugin.ts
@@ -9,6 +9,7 @@ import {
   MARKDOWN_EXTENSION_REGEX,
   META_FILENAME
 } from './constants'
+import { logger, sortPages } from './server/utils'
 import type {
   FileMap,
   Folder,
@@ -22,9 +23,7 @@ import {
   isMdxFile,
   isMeta,
   isSerializable,
-  logger,
   normalizePageRoute,
-  sortPages,
   truthy
 } from './utils'
 

diff --git a/packages/nextra/src/server/utils.ts b/packages/nextra/src/server/utils.ts
@@ -0,0 +1,41 @@
+import title from 'title'
+import type { Folder, MdxFile } from '../types'
+
+export const logger = {
+  info: console.log.bind(null, '-', '\x1b[36minfo\x1b[0m', '[nextra]'),
+  warn: console.log.bind(null, '-', '\x1b[33mwarn\x1b[0m', '[nextra]'),
+  error: console.log.bind(null, '-', '\x1b[31merror\x1b[0m', '[nextra]')
+}
+
+export function pageTitleFromFilename(fileName: string) {
+  return title(fileName.replaceAll(/[-_]/g, ' '))
+}
+
+export function sortPages(
+  pages: (Omit<MdxFile, 'route'> | Omit<Folder, 'route' | 'children'>)[],
+  locale?: string
+): [string, string][] {
+  return pages
+    .map(item => ({
+      name: item.name,
+      date: 'frontMatter' in item && item.frontMatter?.date,
+      title:
+        ('frontMatter' in item && item.frontMatter?.title) ||
+        pageTitleFromFilename(item.name)
+    }))
+    .sort((a, b) => {
+      if (a.date && b.date) {
+        return new Date(b.date).getTime() - new Date(a.date).getTime()
+      }
+      if (a.date) {
+        return -1 // sort a before b
+      }
+      if (b.date) {
+        return 1 // sort a after b
+      }
+      return a.title.localeCompare(b.title, locale || undefined, {
+        numeric: true
+      })
+    })
+    .map(item => [item.name, item.title])
+}
diff --git a/packages/nextra/src/setup-page.tsx b/packages/nextra/src/setup-page.tsx
@@ -8,6 +8,7 @@ import { useRouter } from 'next/router'
 import type { FC, ReactElement } from 'react'
 import { NEXTRA_INTERNAL } from './constants'
 import { SSGContext } from './data'
+import { pageTitleFromFilename } from './server/utils'
 import type {
   DynamicFolder,
   DynamicMeta,
@@ -19,7 +20,7 @@ import type {
   PageMapItem,
   PageOpts
 } from './types'
-import { normalizePageRoute, pageTitleFromFilename } from './utils'
+import { normalizePageRoute } from './utils'
 
 function isFolder(value: DynamicMetaItem): value is DynamicFolder {
   return !!value && typeof value === 'object' && value.type === 'folder'
@@ -32,10 +33,10 @@ function normalizeMetaData(obj: DynamicMeta): DynamicMeta {
         const keyWithoutSlash = key.replace('/', '')
         return [
           keyWithoutSlash,
-          value.title || /* @__PURE__ */ pageTitleFromFilename(keyWithoutSlash)
+          value.title || pageTitleFromFilename(keyWithoutSlash)
         ]
       }
-      return [key, value || /* @__PURE__ */ pageTitleFromFilename(key)]
+      return [key, value || pageTitleFromFilename(key)]
     })
   )
 }
@@ -57,7 +58,7 @@ export function collectCatchAllRoutes(
       }
       parent.children.push({
         name: key,
-        route: /* @__PURE__ */ normalizePageRoute(parent.route, key)
+        route: normalizePageRoute(parent.route, key)
       })
       continue
     }
@@ -75,37 +76,37 @@ export function collectCatchAllRoutes(
 
 let cachedResolvedPageMap: PageMapItem[]
 
+export const resolvePageMap =
+  (dynamicMetaModules: [() => any, DynamicMetaDescriptor][]) => async () => {
+    const __nextra_internal__ = (globalThis as NextraInternalGlobal)[
+      NEXTRA_INTERNAL
+    ]
+    if (process.env.NODE_ENV === 'production' && cachedResolvedPageMap) {
+      return cachedResolvedPageMap
+    }
+    const clonedPageMap = structuredClone(__nextra_internal__.pageMap)
+    for (const [
+      metaFunction,
+      { metaObjectKeyPath, metaParentKeyPath }
+    ] of dynamicMetaModules) {
+      const metaData = await metaFunction()
+      const meta: DynamicMetaJsonFile = get(clonedPageMap, metaObjectKeyPath)
+      meta.data = metaData
+      const parent: Folder = get(clonedPageMap, metaParentKeyPath)
+      collectCatchAllRoutes(parent, meta)
+    }
+    return (cachedResolvedPageMap = clonedPageMap)
+  }
+
 export function setupNextraPage({
   pageOpts,
   MDXContent,
-  dynamicMetaModules = [],
   route
 }: {
   pageOpts: PageOpts
   MDXContent: FC
-  dynamicMetaModules?: [() => any, DynamicMetaDescriptor][]
   route: string
 }) {
-  if (typeof window === 'undefined') {
-    globalThis.__nextra_resolvePageMap = async () => {
-      if (process.env.NODE_ENV === 'production' && cachedResolvedPageMap) {
-        return cachedResolvedPageMap
-      }
-      const clonedPageMap = structuredClone(__nextra_internal__.pageMap)
-      for (const [
-        metaFunction,
-        { metaObjectKeyPath, metaParentKeyPath }
-      ] of dynamicMetaModules) {
-        const metaData = await metaFunction()
-        const meta: DynamicMetaJsonFile = get(clonedPageMap, metaObjectKeyPath)
-        meta.data = metaData
-        const parent: Folder = get(clonedPageMap, metaParentKeyPath)
-        collectCatchAllRoutes(parent, meta)
-      }
-      return (cachedResolvedPageMap = clonedPageMap)
-    }
-  }
-
   // Make sure the same component is always returned so Next.js will render the
   // stable layout. We then put the actual content into a global store and use
   // the route to identify it.

diff --git a/packages/nextra/src/utils.ts b/packages/nextra/src/utils.ts
@@ -1,6 +1,5 @@
 import path from 'node:path'
 import slash from 'slash'
-import title from 'title'
 import type { Folder, MdxFile, Meta, MetaJsonFile, PageMapItem } from './types'
 
 type Truthy<T> = T extends false | '' | 0 | null | undefined ? never : T // from lodash
@@ -17,39 +16,6 @@ export function normalizePageRoute(parentRoute: string, route: string): string {
   return slash(path.join(parentRoute, route.replace(/^index$/, '')))
 }
 
-export function pageTitleFromFilename(fileName: string) {
-  return title(fileName.replaceAll(/[-_]/g, ' '))
-}
-
-export function sortPages(
-  pages: (Omit<MdxFile, 'route'> | Omit<Folder, 'route' | 'children'>)[],
-  locale?: string
-): [string, string][] {
-  return pages
-    .map(item => ({
-      name: item.name,
-      date: 'frontMatter' in item && item.frontMatter?.date,
-      title:
-        ('frontMatter' in item && item.frontMatter?.title) ||
-        pageTitleFromFilename(item.name)
-    }))
-    .sort((a, b) => {
-      if (a.date && b.date) {
-        return new Date(b.date).getTime() - new Date(a.date).getTime()
-      }
-      if (a.date) {
-        return -1 // sort a before b
-      }
-      if (b.date) {
-        return 1 // sort a after b
-      }
-      return a.title.localeCompare(b.title, locale || undefined, {
-        numeric: true
-      })
-    })
-    .map(item => [item.name, item.title])
-}
-
 export function isSerializable(o: any): boolean {
   try {
     JSON.stringify(o)
@@ -63,12 +29,6 @@ export function getDefault<T>(module: T & { default?: T }): T {
   return module.default || module
 }
 
-export const logger = {
-  info: console.log.bind(null, '-', '\x1b[36minfo\x1b[0m', '[nextra]'),
-  warn: console.log.bind(null, '-', '\x1b[33mwarn\x1b[0m', '[nextra]'),
-  error: console.log.bind(null, '-', '\x1b[31merror\x1b[0m', '[nextra]')
-}
-
 export function isMeta(item: PageMapItem): item is MetaJsonFile {
   return 'data' in item
 }