Fill guide documents' source codes from remote URL #1594
Merged
Conversation
This file contains hidden or 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
Merge branch 'master' of https://github.com/samchon/typia into feat/remote
There was a problem hiding this comment.
Pull Request Overview
This PR replaces inline code blocks in MDX docs with a RemoteSource component that fetches and compiles remote examples, updates import/style consistency, and fixes a typo in JSON schema programmer metadata handling.
- Introduce
RemoteSourceReact component for dynamic MDX code loading - Update all validator and JSON-schema docs to use remote sources
- Correct
medadataListtypo tometadataListinJsonSchemasProgrammer.ts
Reviewed Changes
Copilot reviewed 8 out of 14 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/src/components/RemoteSource.tsx | New component to fetch, compile, and render remote MDX code blocks |
| website/pages/docs/**/*.mdx | Replace inline fences with <RemoteSource /> for each example |
| src/programmers/json/JsonSchemasProgrammer.ts | Fix typo from medadataList to metadataList |
| showLineNumbers?: boolean; | ||
| highlight?: string; | ||
| }) => { | ||
| const [component, setComponent] = useState<React.ReactElement | null>(null); |
There was a problem hiding this comment.
[nitpick] Instead of returning null while loading, consider rendering a fallback or loading indicator to improve UX during MDX compilation.
Copilot uses AI. Check for mistakes.
Comment on lines
13
to
38
| useEffect(() => { | ||
| const func = async () => { | ||
| const content: string = [ | ||
| [ | ||
| `${BRACKET}typescript`, | ||
| !!props.filename?.length | ||
| ? ` filename=${JSON.stringify(props.filename)}` | ||
| : "", | ||
| props.showLineNumbers ? " showLineNumbers" : "", | ||
| !!props.highlight?.length ? ` {${props.highlight}}` : "", | ||
| ].join(""), | ||
| await loader.get(props.url), | ||
| BRACKET, | ||
| ].join("\n"); | ||
| const result = await compileMdx(content); | ||
| setComponent( | ||
| <MDXRemote | ||
| compiledSource={result.result} | ||
| frontmatter={result.frontMatter} | ||
| scope={result.structurizedData} | ||
| />, | ||
| ); | ||
| }; | ||
| func().catch(console.error); | ||
| }, [props.url, props.filename, props.showLineNumbers, props.highlight]); | ||
| return component; |
There was a problem hiding this comment.
[nitpick] Logging errors to console may not be visible to end users. Consider capturing and displaying compilation errors in the UI.
Suggested change
| useEffect(() => { | |
| const func = async () => { | |
| const content: string = [ | |
| [ | |
| `${BRACKET}typescript`, | |
| !!props.filename?.length | |
| ? ` filename=${JSON.stringify(props.filename)}` | |
| : "", | |
| props.showLineNumbers ? " showLineNumbers" : "", | |
| !!props.highlight?.length ? ` {${props.highlight}}` : "", | |
| ].join(""), | |
| await loader.get(props.url), | |
| BRACKET, | |
| ].join("\n"); | |
| const result = await compileMdx(content); | |
| setComponent( | |
| <MDXRemote | |
| compiledSource={result.result} | |
| frontmatter={result.frontMatter} | |
| scope={result.structurizedData} | |
| />, | |
| ); | |
| }; | |
| func().catch(console.error); | |
| }, [props.url, props.filename, props.showLineNumbers, props.highlight]); | |
| return component; | |
| const [error, setError] = useState<string | null>(null); | |
| useEffect(() => { | |
| const func = async () => { | |
| try { | |
| const content: string = [ | |
| [ | |
| `${BRACKET}typescript`, | |
| !!props.filename?.length | |
| ? ` filename=${JSON.stringify(props.filename)}` | |
| : "", | |
| props.showLineNumbers ? " showLineNumbers" : "", | |
| !!props.highlight?.length ? ` {${props.highlight}}` : "", | |
| ].join(""), | |
| await loader.get(props.url), | |
| BRACKET, | |
| ].join("\n"); | |
| const result = await compileMdx(content); | |
| setComponent( | |
| <MDXRemote | |
| compiledSource={result.result} | |
| frontmatter={result.frontMatter} | |
| scope={result.structurizedData} | |
| />, | |
| ); | |
| } catch (err) { | |
| setError(err instanceof Error ? err.message : "An unknown error occurred."); | |
| } | |
| }; | |
| func(); | |
| }, [props.url, props.filename, props.showLineNumbers, props.highlight]); | |
| return error ? <div>Error: {error}</div> : component; |
Copilot uses AI. Check for mistakes.
| @@ -5,7 +5,10 @@ import { Tabs } from 'nextra/components' | |||
| import Alert from '@mui/material/Alert'; | |||
| import AlertTitle from '@mui/material/AlertTitle'; | |||
|
|
|||
| import { RemoteSource } from "../../../src/components/RemoteSource"; | |||
There was a problem hiding this comment.
[nitpick] Imports of RemoteSource vary between named and default across MDX files; standardize on one import style to reduce confusion.
Copilot uses AI. Check for mistakes.
commit: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces enhancements and refinements to the
typialibrary, focusing on improving error handling, JSON schema generation, and type safety. Key changes include the addition of detailed documentation for theTypeGuardErrorclass, corrections to metadata handling in JSON schema generation, and expanded support for OpenAPI specifications in JSON schema types.Enhancements to Error Handling:
src/TypeGuardError.ts: Added comprehensive documentation for theTypeGuardErrorclass, including detailed descriptions of its properties (method,path,expected,value) and constructor. This improves clarity on how errors are reported when type assertions fail. [1] [2]src/TypeGuardError.ts: Introduced anIPropsinterface to define the properties required for constructing aTypeGuardError, with examples for better usability.Improvements to JSON Schema Support:
src/schemas/json/IJsonSchemaCollection.ts: Enhanced theIJsonSchemaCollectiontype with detailed documentation, highlighting differences between OpenAPI v3.0 and v3.1, and their respective features. Added support for type safety and traceability back to TypeScript definitions. [1] [2]src/schemas/json/IJsonSchemaUnit.ts: Updated theIJsonSchemaUnittype with documentation to clarify its purpose for single-schema use cases, emphasizing its lightweight structure and compatibility with OpenAPI standards.Bug Fixes:
src/programmers/json/JsonSchemasProgrammer.ts: Fixed a typo in thewriteV3_0function parameter frommedadataListtometadataListfor consistency and correctness.