[v3] Remove support of "_meta.json", use "_meta.{js,jsx,ts,tsx}" instead. (#2321)

Author: Dimitri POSTOLOV

.changeset/long-wombats-train.md

@@ -0,0 +1,6 @@
+---
+'nextra-theme-docs': major
+'nextra': major
+---
+
+Remove support of "_meta.json", use "_meta.{js,jsx,ts,tsx}" instead.

.changeset/rich-bananas-burn.md

@@ -0,0 +1,5 @@
+---
+'nextra-theme-docs': major
+---
+
+remove `config.serverSideError`

docs/pages/docs/docs-theme/api/use-config.mdx

@@ -45,8 +45,6 @@ context.
 - `project`: data about
   [Project Link](/docs/docs-theme/theme-configuration#project-link)
 - `search`: data about [Search](/docs/docs-theme/theme-configuration#search)
-- `serverSideError`: data to display when a server-side error happens (requires
-  `500.mdx` page too)
 - `sidebar`: data about [Sidebar](/docs/docs-theme/theme-configuration#sidebar)
 - `toc`: data about
   [Table of Contents Sidebar](/docs/docs-theme/theme-configuration#toc-sidebar)

docs/pages/docs/docs-theme/theme-configuration.mdx

@@ -743,9 +743,7 @@ export default {
 
 ### 404 - Not Found
 
-### 500 - Internal Server Error
-
-## Favicon Glyph (Experimental)
+## Favicon Glyph
 
 This isn’t supported by all browsers, but it’s a nice way to customize the
 favicon of the website simply by using an emoji or character.

docs/pages/index.mdx

@@ -38,17 +38,17 @@ export function I18n() {
       a={
         <div style={{ display: 'flex', flexDirection: 'column', gap: '.5rem' }}>
           <File
-            name="/hello.en-US.mdx"
+            name="/en/hello.mdx"
             className={active === 'en' && styles.active}
             onPointerOver={() => setActive('en')}
           />
           <File
-            name="/hello.de-DE.mdx"
+            name="/de/hello.mdx"
             className={active === 'de' && styles.active}
             onPointerOver={() => setActive('de')}
           />
           <File
-            name="/hello.ja-JP.mdx"
+            name="/ja/hello.mdx"
             className={active === 'ja' && styles.active}
             onPointerOver={() => setActive('ja')}
           />

examples/docs/src/pages/_meta.js

@@ -0,0 +1,7 @@
+export default {
+  index: 'Introduction',
+  'get-started': 'Get Started',
+  features: 'Features',
+  themes: 'Themes',
+  advanced: 'Advanced'
+}

examples/docs/src/pages/_meta.json

@@ -0,0 +1,3 @@
+export default {
+  'code-highlighting': 'Code Highlighting'
+}

examples/docs/src/pages/advanced/_meta.js

@@ -0,0 +1,8 @@
+export default {
+  mdx: 'MDX',
+  ssg: 'Next.js SSG',
+  i18n: 'Next.js i18n',
+  image: 'Next.js Image',
+  themes: 'Themes',
+  latex: 'LaTeX'
+}

examples/docs/src/pages/advanced/_meta.json

@@ -0,0 +1,4 @@
+export default {
+  docs: 'Docs Theme',
+  blog: 'Blog Theme'
+}

examples/docs/src/pages/features/_meta.js

@@ -0,0 +1,3 @@
+export default {
+  index: 'Installation'
+}

examples/docs/src/pages/features/_meta.json

@@ -0,0 +1,6 @@
+export default {
+  index: 'Installation',
+  configuration: 'Configuration',
+  callout: 'Callout',
+  bleed: 'Bleed'
+}

examples/docs/src/pages/themes/_meta.js

@@ -0,0 +1,62 @@
+export default {
+  index: {
+    title: 'Introduction',
+    type: 'page',
+    display: 'hidden'
+  },
+  docs: {
+    type: 'page',
+    title: 'Docs'
+  },
+  remote: {
+    type: 'page',
+    title: 'Remote',
+    href: '/remote/4423220'
+  },
+  about: {
+    type: 'menu',
+    title: 'About',
+    items: {
+      contributors: {
+        title: 'Contributors',
+        href: 'https://github.com/vercel/swr/graphs/contributors',
+        newWindow: true
+      },
+      team: {
+        title: 'Team'
+      },
+      acknowledgement: {
+        title: 'Acknowledgement'
+      },
+      'a-page': {
+        title: 'A Page'
+      },
+      changelog: {
+        title: 'Changelog'
+      }
+    }
+  },
+  examples: {
+    type: 'page',
+    title: 'Examples',
+    theme: {
+      layout: 'full'
+    }
+  },
+  blog: {
+    type: 'page',
+    title: 'Blog',
+    theme: {
+      sidebar: false,
+      toc: true,
+      breadcrumb: false,
+      typesetting: 'article'
+    }
+  },
+  nextra_link: {
+    type: 'page',
+    title: 'Nextra ↗',
+    href: 'https://github.com/shuding/nextra',
+    newWindow: true
+  }
+}

examples/docs/src/pages/themes/_meta.json

@@ -16,20 +16,6 @@ import { NotFoundPage } from 'nextra-theme-docs'
 
 [Click to try `/404` page.](/this-page-not-exist-trust-me)
 
-## 500
-
-To add `/500` page import `ServerSideErrorPage`:
-
-```mdx filename="pages/500.mdx"
-import { ServerSideErrorPage } from 'nextra-theme-docs'
-
-# 500 - Internal Server Error
-
-<ServerSideErrorPage />
-```
-
-[Click to try `/500` page.](/500)
-
 ## Customize Theme Config Options
 
 Also, you can customize following options:
@@ -38,8 +24,6 @@ Also, you can customize following options:
 // ...
 notFoundLink?: ReactNode | FC
 notFoundLabels?: string
-serverSideErrorLink?: ReactNode | FC
-serverSideErrorLabels?: string
 ```
 
 ## Customize Layout

examples/docs/src/pages/themes/blog/_meta.js

@@ -1,4 +1,4 @@
-import meta from '../en/_meta.json'
+import meta from '../en/_meta'
 
 export default {
   index: {

examples/docs/src/pages/themes/blog/_meta.json

@@ -13,7 +13,6 @@ export { Navbar } from './navbar'
 export { NotFoundPage } from './404'
 export { Search } from './search'
 export { Select } from './select'
-export { ServerSideErrorPage } from './500'
 export { Sidebar } from './sidebar'
 export { SkipNavContent, SkipNavLink } from './skip-nav'
 export { ThemeSwitch } from './theme-switch'

examples/docs/src/pages/themes/docs/_meta.js

@@ -154,10 +154,6 @@ export const DEFAULT_THEME: DocsThemeConfig = {
       return `${text}…`
     }
   },
-  serverSideError: {
-    content: 'Submit an issue about error in url →',
-    labels: 'bug'
-  },
   sidebar: {
     defaultMenuCollapseLevel: 2,
     toggleButton: true

examples/docs/src/pages/themes/docs/_meta.json

@@ -241,7 +241,6 @@ export {
   Bleed,
   Collapse,
   NotFoundPage,
-  ServerSideErrorPage,
   Navbar,
   SkipNavContent,
   SkipNavLink,

examples/swr-site/pages/en/_meta.json

@@ -118,10 +118,6 @@ export const themeSchema = /* @__PURE__ */ (() =>
       // Can't be React component
       placeholder: z.string().or(z.function().returns(z.string()))
     }),
-    serverSideError: z.strictObject({
-      content: z.custom<ReactNode | FC>(...reactNode),
-      labels: z.string()
-    }),
     sidebar: z.strictObject({
       autoCollapse: z.boolean().optional(),
       defaultMenuCollapseLevel: z.number().min(1).int(),

examples/swr-site/pages/en/_meta.ts

@@ -24,7 +24,7 @@ describe('collectPageMap', () => {
     const rawJs = await collectPageMap({ dir, route: '/en', locale: 'en' })
 
     expect(clean(rawJs)).toMatchInlineSnapshot(`
-      "import examples_swr_site_pages_en_meta from \\"../../examples/swr-site/pages/en/_meta.json\\";
+      "import examples_swr_site_pages_en_meta from \\"../../examples/swr-site/pages/en/_meta.ts\\";
       import examples_swr_site_pages_en_about_meta from \\"../../examples/swr-site/pages/en/about/_meta.ts\\";
       import examples_swr_site_pages_en_blog_meta from \\"../../examples/swr-site/pages/en/blog/_meta.ts\\";
       import examples_swr_site_pages_en_docs_meta from \\"../../examples/swr-site/pages/en/docs/_meta.tsx\\";

examples/swr-site/pages/en/docs/404-500.mdx

@@ -32,8 +32,6 @@ export const DEFAULT_CONFIG = {
 
 export const OFFICIAL_THEMES = ['nextra-theme-docs', 'nextra-theme-blog']
 
-export const META_FILENAME = '_meta.json'
-
 export const META_REGEX = /_meta\.[jt]sx?$/
 
 export const MARKDOWN_EXTENSIONS = ['md', 'mdx'] as const

examples/swr-site/pages/es/_meta.ts

@@ -6,10 +6,10 @@ import gracefulFs from 'graceful-fs'
 import grayMatter from 'gray-matter'
 import pLimit from 'p-limit'
 import {
+  CWD,
   DEFAULT_PROPERTY_PROPS,
   IMPORT_FRONTMATTER,
   MARKDOWN_EXTENSION_REGEX,
-  META_FILENAME,
   META_REGEX
 } from './constants.js'
 import { PAGES_DIR } from './file-system.js'
@@ -140,15 +140,20 @@ async function collectFiles({
         const fileName = name + ext
         const isMetaJs = META_REGEX.test(fileName)
 
-        if (fileName === META_FILENAME || isMetaJs) {
+        if (fileName === '_meta.json') {
+          throw new Error(
+            'Support of "_meta.json" was removed, use "_meta.{js,jsx,ts,tsx}" instead. ' +
+              `Refactor following file "${path.relative(CWD, filePath)}".`
+          )
+        }
+
+        if (isMetaJs) {
           const importName = cleanFileName(filePath)
           imports.push({ importName, filePath })
 
-          if (isMetaJs) {
-            if (hasDynamicPage) {
-              dynamicMetaImports.push({ importName, route })
-              return
-            }
+          if (hasDynamicPage) {
+            dynamicMetaImports.push({ importName, route })
+            return
           }
           return createAstObject({
             data: { type: 'Identifier', name: importName }