[nextra]: refactor `loaders.ts`, provide type for `PageOpts` in loader #579

dimaMachina · 2022-07-24T11:10:08Z

No description provided.

changeset-bot · 2022-07-24T11:10:10Z

🦋 Changeset detected

Latest commit: dfa509e

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2022-07-24T11:10:11Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
nextra-theme-docs-dev	✅ Ready (Inspect)	Visit Preview	Jul 30, 2022 at 10:44AM (UTC)

1 Ignored Deployment

Name	Status	Preview	Updated
nextra	⬜️ Ignored (Inspect)		Jul 30, 2022 at 10:44AM (UTC)

dimaMachina · 2022-07-24T11:13:26Z

packages/nextra-theme-docs/src/index.tsx

-interface LayoutProps {
-  filename: string
-  pageMap: PageMapItem[]
-  meta: Meta
-  titleText: string | null
-  headings?: Heading[]
-  timestamp?: number
-}

-const Content: React.FC<LayoutProps> = ({
+const Content = ({
  filename,
  pageMap,
  meta,
  titleText,
  headings,
  timestamp,
  children
-}) => {
+}: PageOpts & { children: ReactNode }): ReactElement => {


don't need to specify props since we'll receive all PageOpts anyway

nextra/packages/nextra-theme-docs/src/index.tsx

Line 243 in 153aee6

const createLayout = (opts: PageOpts, config: DocsThemeConfig) => {

nextra/packages/nextra-theme-docs/src/index.tsx

Line 261 in 153aee6

<Content {...opts}>{page}</Content>

could use PropsWithChildren<PageOpts> here

PropsWithChildren has optional children, and like this his is required

dimaMachina · 2022-07-24T11:14:45Z

packages/nextra-theme-docs/src/index.tsx

-  const extendedConfig = Object.assign({}, defaultConfig, config, opts)
+
+const createLayout = (opts: PageOpts, config: DocsThemeConfig) => {
+  const extendedConfig = {
+    ...defaultConfig,
+    ...config,
+    unstable_flexsearch: opts.unstable_flexsearch
+  }


this was a mistake, we don't need to copy all PageOpts in ThemeConfigContext, but only unstable_flexsearch

dimaMachina · 2022-07-24T11:15:53Z

packages/nextra/src/loader.ts

+  const pageOpts: Omit<PageOpts, 'pageMap' | 'titleText'> = {
+    filename: slash(filename),
+    route: slash(route),
+    meta,
+    headings,
+    timestamp,
+    unstable_flexsearch,
+  }


now pageOpts is type safe

dimaMachina · 2022-07-24T11:17:14Z

packages/nextra/src/types.ts

-        codeblocks: boolean
-      }
+  titleText?: string
+  headings: (Heading & { value: string })[]


before headings was marked optional, but this is false, headings always exist

nextra/packages/nextra/src/compile.ts

Line 14 in 153aee6

compiler.data('headings', [])

dimaMachina · 2022-07-24T11:21:03Z

packages/nextra/src/loader.ts

-  filename: "${slash(filename)}",
-  route: "${slash(route)}",
-  meta: ${JSON.stringify(data)},
  pageMap: __nextra_pageMap__,
  titleText: typeof titleText === 'string' ? titleText : undefined,
-  headings: ${JSON.stringify(headings)},
-  ${timestamp ? `timestamp: ${timestamp},\n` : ''}
-  ${
-    unstable_flexsearch
-      ? `unstable_flexsearch: ${JSON.stringify(unstable_flexsearch)}`
-      : ''
-  }
+  ...${JSON.stringify(pageOpts)}


now it's looks much friendly

shuding · 2022-07-29T13:38:45Z

Could you resolve the conflicts?

Here're the build errors btw:

dimaMachina · 2022-07-29T14:19:36Z

@shuding sure, I'm planning to resolve conflicts on all PRs :)

dimaMachina · 2022-07-29T18:13:48Z

packages/nextra-theme-docs/src/head.tsx

-  meta: Meta
+  meta: PageOpts['meta']


this was a mistake, it's not meta.json#theme but frontmatter data!

dimaMachina · 2022-07-29T18:15:17Z

packages/nextra-theme-docs/src/types.ts

-export interface Meta extends PageTheme {
-  title: string
-}
+
+type Meta = Record<string, any>


As I said Meta is frontmatter data and not meta.json#theme

dimaMachina · 2022-07-30T10:54:23Z

packages/nextra/src/loader.ts

-    if (repository.isShallow() && !wasShallowWarningPrinted) {
-      if (process.env.VERCEL) {
-        console.warn(
-          '[nextra] The repository is shallow cloned, so the latest modified time will not be presented. Set the VERCEL_DEEP_CLONE=true environment variable to enable deep cloning.'
-        )
-      } else if (process.env.GITHUB_ACTION) {
-        console.warn(
-          '[nextra] The repository is shallow cloned, so the latest modified time will not be presented. See https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches to fetch all the history.'
-        )
-      } else {
-        console.warn(
-          '[nextra] The repository is shallow cloned, so the latest modified time will not be presented.'
-        )
-      }
-      wasShallowWarningPrinted = true
-    }


can be moved outside of loader (inside of IIFE) and wasShallowWarningPrinted variable can be removed

shuding · 2022-07-30T14:48:15Z

Thank you!

shuding#579) * chore(nextra/blog/docs): provide types for PageOpts in loader * yet more readable * move `shallow cloned` console messages outside of loader

vercel bot deployed to Preview – nextra-theme-docs-dev July 24, 2022 11:11 View deployment

dimaMachina commented Jul 24, 2022

View reviewed changes

dimaMachina marked this pull request as ready for review July 24, 2022 12:22

promer94 approved these changes Jul 24, 2022

View reviewed changes

dimaMachina force-pushed the improve-types-for-loader branch from 153aee6 to ddb9810 Compare July 25, 2022 12:49

vercel bot had a problem deploying to Preview – nextra-theme-docs-dev July 25, 2022 12:50 Failure

dimaMachina marked this pull request as draft July 29, 2022 16:03

dimaMachina force-pushed the improve-types-for-loader branch from ddb9810 to 322f598 Compare July 29, 2022 17:37

vercel bot deployed to Preview – nextra-theme-docs-dev July 29, 2022 17:40 View deployment

dimaMachina force-pushed the improve-types-for-loader branch from 322f598 to 3627650 Compare July 29, 2022 17:55

vercel bot deployed to Preview – nextra-theme-docs-dev July 29, 2022 17:57 View deployment

dimaMachina force-pushed the improve-types-for-loader branch from 3627650 to c4e8f09 Compare July 29, 2022 18:11

vercel bot deployed to Preview – nextra-theme-docs-dev July 29, 2022 18:12 View deployment

dimaMachina commented Jul 29, 2022

View reviewed changes

dimaMachina marked this pull request as ready for review July 29, 2022 18:18

dimaMachina requested a review from shuding July 29, 2022 18:18

chore(nextra/blog/docs): provide types for PageOpts in loader

b36c88c

dimaMachina force-pushed the improve-types-for-loader branch from c4e8f09 to b36c88c Compare July 30, 2022 07:53

vercel bot deployed to Preview – nextra-theme-docs-dev July 30, 2022 07:55 View deployment

yet more readable

1fe7af4

vercel bot deployed to Preview – nextra-theme-docs-dev July 30, 2022 10:25 View deployment

move shallow cloned console messages outside of loader

dfa509e

vercel bot deployed to Preview – nextra-theme-docs-dev July 30, 2022 10:44 View deployment

dimaMachina changed the title ~~chore(nextra/blog/docs): improve loaders types~~ [nextra]: refactor loaders.ts, provide type for PageOpts in loader Jul 30, 2022

dimaMachina commented Jul 30, 2022

View reviewed changes

shuding merged commit 0f4795f into core Jul 30, 2022

shuding deleted the improve-types-for-loader branch July 30, 2022 14:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[nextra]: refactor `loaders.ts`, provide type for `PageOpts` in loader #579

[nextra]: refactor `loaders.ts`, provide type for `PageOpts` in loader #579

dimaMachina commented Jul 24, 2022

changeset-bot bot commented Jul 24, 2022 •

edited

vercel bot commented Jul 24, 2022 •

edited

dimaMachina Jul 24, 2022

promer94 Jul 24, 2022 •

edited

dimaMachina Jul 24, 2022

dimaMachina Jul 24, 2022

dimaMachina Jul 24, 2022

dimaMachina Jul 24, 2022 •

edited

dimaMachina Jul 24, 2022

shuding commented Jul 29, 2022

dimaMachina commented Jul 29, 2022 •

edited

dimaMachina Jul 29, 2022

dimaMachina Jul 29, 2022

dimaMachina Jul 30, 2022

shuding commented Jul 30, 2022

[nextra]: refactor loaders.ts, provide type for PageOpts in loader #579

[nextra]: refactor loaders.ts, provide type for PageOpts in loader #579

Conversation

dimaMachina commented Jul 24, 2022

changeset-bot bot commented Jul 24, 2022 • edited

🦋 Changeset detected

vercel bot commented Jul 24, 2022 • edited

Choose a reason for hiding this comment

promer94 Jul 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dimaMachina Jul 24, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shuding commented Jul 29, 2022

dimaMachina commented Jul 29, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shuding commented Jul 30, 2022

[nextra]: refactor `loaders.ts`, provide type for `PageOpts` in loader #579

[nextra]: refactor `loaders.ts`, provide type for `PageOpts` in loader #579

changeset-bot bot commented Jul 24, 2022 •

edited

vercel bot commented Jul 24, 2022 •

edited

promer94 Jul 24, 2022 •

edited

dimaMachina Jul 24, 2022 •

edited

dimaMachina commented Jul 29, 2022 •

edited