TS - templates migration #6479
TS - templates migration #6479
Conversation
pettinarip
requested review from
samajammin,
wackerow,
corwintines and
minimalsm
as code owners
github-actions
bot
added
dependencies 📦
Gatsby Cloud Build Reportethereum-org-website-dev 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 27m PerformanceLighthouse report
|
| @@ -165,15 +165,22 @@ const Contributors = styled(FileContributors)` | |||
| } | |||
| ` | |||
|
|
|||
| const DocsPage = ({ data, pageContext }) => { | |||
| const DocsPage = ({ | |||
| data: { siteData, pageData: mdx }, | |||
There was a problem hiding this comment.
Not specific to this PR but just noting - should we just update pageData to mdx in the query? Seems kind of silly to rename the variable here.
There was a problem hiding this comment.
Yeah, would make sense. Looks like we immediately rename is in all cases except for the Tutorials template, which is now converted to mdx in this PR.
There was a problem hiding this comment.
Agree. This was a try to make them consistent but doing them at the query level is better.
|
|
||
| const tocItems = mdx.tableOfContents.items | ||
| if (!siteData || !mdx?.frontmatter) { | ||
| throw new Error("Docs page template query does not return expected values") |
| const tocItems = mdx.tableOfContents.items | ||
| const { summaryPoints } = mdx.frontmatter | ||
| const StakingPage = ({ | ||
| data: { pageData: mdx }, |
There was a problem hiding this comment.
Same here - should we just rename pageData to mdx in the query? 😄
|
|
||
| const isRightToLeft = isLangRightToLeft(mdx.frontmatter.lang as Lang) | ||
|
|
||
| // FIXME: remove this any, currently not sure how to fix the ts error |
There was a problem hiding this comment.
Hmmm what was the TS error? Is the type inconsistent?
Not sure if the comment below this is related:
// TODO some `gitLogLatestDate` are `null` - why?
There was a problem hiding this comment.
So, the auto-generated types for mdx are kind of weird. I have an error with in the next line where we call parent.fields.
The generated type for mdx is saying that it could possibly be {}, not sure if that is correct.
The error:
Property 'fields' does not exist on type '{} | { readonly mtime: string; readonly fields: { readonly gitLogLatestDate: string | null; } | null; }'.
Property 'fields' does not exist on type '{}'.
| const pageData = data.pageData | ||
| const isRightToLeft = isLangRightToLeft(pageData.frontmatter.lang) | ||
| const TutorialPage = ({ | ||
| data: { siteData, pageData: mdx }, |
Description
Migration to TS of the templates.
Related Issue
#6392