fix: migration app router from pages router #180
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,16 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 'use client'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { type ThemeOption, useTheme } from '@/hooks/useTheme'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { useEffect } from 'react'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| function ThemeInitializer() { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const { setTheme } = useTheme(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| useEffect(() => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const themeOption = (window.localStorage.getItem('theme') || 'system') as ThemeOption; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| setTheme(themeOption); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, [setTheme]); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return null; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+6
to
+14
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider hydration mismatch prevention. To prevent hydration mismatches, consider using a mounting check before accessing localStorage. function ThemeInitializer() {
const { setTheme } = useTheme();
useEffect(() => {
+ let mounted = true;
try {
const themeOption = (window.localStorage.getItem('theme') || 'system') as ThemeOption;
- setTheme(themeOption);
+ if (mounted) {
+ setTheme(themeOption);
+ }
} catch (error) {
console.warn('Failed to access localStorage:', error);
- setTheme('system');
+ if (mounted) {
+ setTheme('system');
+ }
}
+ return () => {
+ mounted = false;
+ };
}, [setTheme]);
return null;
}📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export default ThemeInitializer; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import { Metadata } from 'next'; | ||
| import CommunityPage from './community-page'; | ||
|
|
||
| export const metadata: Metadata = { | ||
| title: 'Community · Yorkie', | ||
| }; | ||
|
|
||
| export default async function Page() { | ||
| return <CommunityPage />; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| import { getSlugs, getDocsFromSlug, getDocsMetaFromSlug, getDocsOrderList } from '@/utils/mdxUtils'; | ||
| import type { MDXComponents } from 'mdx/types'; | ||
| import remarkGfm from 'remark-gfm'; | ||
| import rehypeSlug from 'rehype-slug'; | ||
| import rehypeAutolinkHeadings from 'rehype-autolink-headings'; | ||
| import rehypeToc, { HtmlElementNode, ListItemNode } from '@jsdevtools/rehype-toc'; | ||
| import rehypeImageMeta from '@/utils/rehypeImageMeta'; | ||
| import rehypeWrapContents from '@/utils/rehypeWrapContents'; | ||
| import rehypeVariables from '@/utils/rehypeVariables'; | ||
| import { Button, Icon, CodeBlock, CodeBlockContentWrapper, CodeBlockHeader, Image } from '@/components'; | ||
| import { CustomLink, CustomCodeBlock, Breadcrumb, Caption, ImageWrap, Alert, Blockquote } from '@/components/docs'; | ||
| import SlugPage from './slug-page'; | ||
| import { MDXRemote } from 'next-mdx-remote/rsc'; | ||
|
|
||
| type Props = { | ||
| params: { | ||
| slug?: string[]; | ||
| }; | ||
| }; | ||
|
|
||
| const components: MDXComponents = { | ||
| a: CustomLink, | ||
| h3: (props) => <h3 className="heading" {...props} />, | ||
| h4: (props) => <h4 className="heading" {...props} />, | ||
| h5: (props) => <h5 className="heading" {...props} />, | ||
| h6: (props) => <h6 className="heading" {...props} />, | ||
| Button, | ||
| Icon, | ||
| pre: (props) => <CustomCodeBlock {...props} />, | ||
| blockquote: (props) => <Blockquote {...props} />, | ||
| img: ({ src, alt, title, width, height }) => ( | ||
| <Image src={src!} alt={alt || ''} title={title} width={width as number} height={height as number} /> | ||
| ), | ||
| Image, | ||
| ImageWrap, | ||
| Breadcrumb, | ||
| Caption, | ||
| Alert, | ||
| CodeBlock, | ||
| CodeBlockHeader, | ||
| CodeBlockContentWrapper, | ||
| }; | ||
|
|
||
| export default async function DocsPage({ params }: Props) { | ||
| const slug = params.slug?.join('/') ?? 'index'; | ||
|
|
||
| const { content, source } = getDocsFromSlug(slug); | ||
|
|
||
| const navList = getDocsOrderList('/docs'); | ||
|
|
||
| const mdxContent = await MDXRemote({ | ||
| source, | ||
| components, | ||
| options: { | ||
| mdxOptions: { | ||
| remarkPlugins: [remarkGfm], | ||
| rehypePlugins: [ | ||
| rehypeImageMeta, | ||
| [ | ||
| rehypeVariables, | ||
| { | ||
| variables: [ | ||
| { pattern: 'YORKIE_VERSION', value: process.env.NEXT_PUBLIC_YORKIE_VERSION }, | ||
| { pattern: 'YORKIE_JS_VERSION', value: process.env.NEXT_PUBLIC_YORKIE_JS_VERSION }, | ||
| { pattern: 'YORKIE_IOS_VERSION', value: process.env.NEXT_PUBLIC_YORKIE_IOS_VERSION }, | ||
| { pattern: 'YORKIE_ANDROID_VERSION', value: process.env.NEXT_PUBLIC_YORKIE_ANDROID_VERSION }, | ||
| { pattern: 'DASHBOARD_PATH', value: process.env.NEXT_PUBLIC_DASHBOARD_PATH }, | ||
| { pattern: 'API_ADDR', value: process.env.NEXT_PUBLIC_API_ADDR }, | ||
| { pattern: 'API_HOST', value: process.env.NEXT_PUBLIC_API_HOST }, | ||
| { pattern: 'API_PORT', value: process.env.NEXT_PUBLIC_API_PORT }, | ||
| ], | ||
| }, | ||
| ], | ||
| rehypeSlug, | ||
| [ | ||
| rehypeAutolinkHeadings, | ||
| { | ||
| test: ['h3', 'h4', 'h5', 'h6'], | ||
| behavior: 'wrap', | ||
| }, | ||
| ], | ||
| [ | ||
| rehypeToc, | ||
| { | ||
| position: 'afterend', | ||
| headings: ['h3', 'h4', 'h5', 'h6'], | ||
| customizeTOC: (toc: HtmlElementNode) => { | ||
| const children = toc.children || []; | ||
| const contents = (children[0] as any)?.children?.length; | ||
| if (!contents) return false; | ||
|
|
||
| toc.tagName = 'div'; | ||
| toc.properties.className = 'pagination'; | ||
| const wrapper = { | ||
| type: 'element', | ||
| tagName: 'div', | ||
| properties: { className: 'pagination_inner' }, | ||
| children: [ | ||
| { | ||
| type: 'element', | ||
| tagName: 'strong', | ||
| properties: { className: 'pagination_title' }, | ||
| children: [{ type: 'text', value: 'On this page' }], | ||
| }, | ||
| ...children, | ||
| ], | ||
| }; | ||
| toc.children = [wrapper]; | ||
| }, | ||
| customizeTOCItem: (tocItem: ListItemNode, heading: HtmlElementNode) => { | ||
| tocItem.properties['data-heading'] = heading.properties.id; | ||
| }, | ||
| }, | ||
| ], | ||
| rehypeWrapContents, | ||
| ], | ||
| }, | ||
| parseFrontmatter: true, | ||
| }, | ||
| }); | ||
|
|
||
| return ( | ||
| <SlugPage navList={navList} content={content}> | ||
| {mdxContent} | ||
| </SlugPage> | ||
| ); | ||
| } | ||
|
|
||
| export async function generateMetadata({ params }: Props) { | ||
| const slug = params.slug?.join('/') ?? 'index'; | ||
| const { meta } = getDocsFromSlug(slug); | ||
|
|
||
| return { | ||
| ...meta, | ||
| }; | ||
| } | ||
|
|
||
| export const generateStaticParams = async () => { | ||
| const params = getSlugs() | ||
| .filter((slug) => { | ||
| if (process.env.NODE_ENV === 'development') return true; | ||
|
|
||
| const { phase } = getDocsMetaFromSlug(slug); | ||
| return phase !== 'development'; | ||
| }) | ||
| .map((slug) => ({ | ||
| slug: slug === 'index' ? [''] : slug.split('/'), | ||
| })); | ||
|
|
||
| return params; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| 'use client'; | ||
|
|
||
| import Head from 'next/head'; | ||
|
There was a problem hiding this comment. Remove commented Head component and use metadata.ts instead The commented Remove the commented code and implement metadata using App Router conventions: -import Head from 'next/head';Create a new file import { Metadata } from 'next';
export const metadata: Metadata = {
title: 'Documentation · Yorkie',
};Also applies to: 19-21 |
||
| import { type DocsOrderList } from '@/utils/mdxUtils'; | ||
| import { Layout, Navigator } from '@/components'; | ||
| import ScrollPositionIndicator from '../_components/scroll-position-indicator'; | ||
|
|
||
| export default function DocsPage({ | ||
| content, | ||
| navList, | ||
| children, | ||
| }: { | ||
| content: string; | ||
| navList: DocsOrderList; | ||
| children: React.ReactNode; | ||
| }) { | ||
| return ( | ||
| <Layout className="documentation_page"> | ||
| {/* <Head> | ||
| <title>Documentation · Yorkie</title> | ||
| </Head> */} | ||
| <ScrollPositionIndicator content={content} /> | ||
| <div className="content"> | ||
| <Navigator navList={navList} /> | ||
| <section className="section">{children}</section> | ||
| </div> | ||
| </Layout> | ||
| ); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| 'use client'; | ||
|
|
||
| import { useState, useEffect, useCallback } from 'react'; | ||
|
|
||
| export default function ScrollPositionIndicator({ content }: { content: string }) { | ||
| const [activeId, setActiveId] = useState<string>(''); | ||
| const [headings, setHeadings] = useState<Array<Element>>([]); | ||
| const [headingTops, setHeadingTops] = useState<Array<{ id: string; top: number }>>([]); | ||
|
|
||
| const updateHeadingPositions = useCallback(() => { | ||
| const scrollTop = document.documentElement.scrollTop; | ||
| const headingTops = [...headings].map((heading) => { | ||
| const top = heading.getBoundingClientRect().top + scrollTop; | ||
| return { | ||
| id: heading.id, | ||
| top, | ||
| }; | ||
| }); | ||
| setHeadingTops(headingTops); | ||
| }, [headings]); | ||
|
|
||
| useEffect(() => { | ||
| setHeadings(Array.from(document.querySelectorAll('.documentation_page .heading'))); | ||
| }, [content]); | ||
|
|
||
|
Comment on lines
+22
to
+25
There was a problem hiding this comment. Ensure heading positions are updated when headings change Currently, Apply this diff to call useEffect(() => {
+ updateHeadingPositions();
}, [activeId, updateHeadingPositions]);Alternatively, adjust the dependencies: -}, [activeId, updateHeadingPositions]);
+}, [activeId, headings, updateHeadingPositions]);
|
||
| useEffect(() => { | ||
| if (headings.length === 0) return; | ||
|
|
||
| const setActiveTOCLink = () => { | ||
| const scrollTop = document.documentElement.scrollTop; | ||
| const yOffset = 150; | ||
|
|
||
| const currentHeading = | ||
| scrollTop < 10 | ||
| ? headingTops.find((headingTop) => { | ||
| return scrollTop >= headingTop.top - yOffset; | ||
| }) | ||
| : [...headingTops].reverse().find((headingTop) => { | ||
| return scrollTop >= headingTop.top - yOffset; | ||
| }); | ||
|
|
||
| setActiveId(currentHeading?.id || ''); | ||
| }; | ||
|
|
||
| window.addEventListener('scroll', setActiveTOCLink); | ||
| setActiveTOCLink(); | ||
| return () => { | ||
| window.removeEventListener('scroll', setActiveTOCLink); | ||
| }; | ||
| }, [headings, headingTops]); | ||
|
|
||
| useEffect(() => { | ||
| updateHeadingPositions(); | ||
| document.querySelector(`.toc-item.is_active`)?.classList.remove('is_active'); | ||
| document.querySelector(`[data-heading="${activeId}"]`)?.classList.add('is_active'); | ||
|
Comment on lines
+54
to
+55
There was a problem hiding this comment. 🛠️ Refactor suggestion Avoid direct DOM manipulation; use React state or refs instead Directly manipulating the DOM with |
||
| }, [activeId, updateHeadingPositions]); | ||
|
|
||
| return null; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { Metadata } from 'next'; | ||
| import CalendarPage from './calendar-page'; | ||
|
|
||
| const exampleTitle = 'Calendar'; | ||
|
|
||
| export const metadata: Metadata = { | ||
| title: `${exampleTitle} · Yorkie Examples`, | ||
| }; | ||
|
|
||
| export default async function Page() { | ||
| return <CalendarPage />; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { Metadata } from 'next'; | ||
| import CodemirrorPage from './codemirror-page'; | ||
|
|
||
| const exampleTitle = 'CodeMirror'; | ||
|
|
||
| export const metadata: Metadata = { | ||
| title: `${exampleTitle} · Yorkie Examples`, | ||
| }; | ||
|
|
||
| export default async function Page() { | ||
| return <CodemirrorPage />; | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add error handling for localStorage access.
The localStorage access should be wrapped in a try-catch block to handle cases where it might be unavailable (e.g., in private browsing mode).
useEffect(() => { - const themeOption = (window.localStorage.getItem('theme') || 'system') as ThemeOption; - setTheme(themeOption); + try { + const themeOption = (window.localStorage.getItem('theme') || 'system') as ThemeOption; + setTheme(themeOption); + } catch (error) { + console.warn('Failed to access localStorage:', error); + setTheme('system'); + } }, [setTheme]);📝 Committable suggestion