feat: shoreline to json #2115
feat: shoreline to json #2115
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a script to generate a comprehensive JSON schema representation of Shoreline components to support experimentation with Gen UI concepts for VTEX AI Agents.
- Adds a component documentation generation script using
react-docgen - Creates JSON output with component metadata including props, types, and descriptions
- Updates documentation and package configuration to support the new script
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| shoreline-components.json | Contains the generated JSON representation of all Shoreline components with their metadata |
| scripts/create-json-rep.mjs | Main script that analyzes component files and generates structured JSON documentation |
| scripts/README.md | Updated documentation explaining the new component generation script |
| package.json | Added dependencies and npm script to run the component documentation generator |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| { | ||
| "VisuallyHidden": { | ||
| "displayName": "VisuallyHidden", | ||
| "description": "Renders an element that is visually only to screen readers", |
There was a problem hiding this comment.
The description should be 'Renders an element that is visually hidden and only available to screen readers' or similar. The phrase 'visually only to screen readers' is grammatically incorrect.
| "description": "Renders an element that is visually only to screen readers", | |
| "description": "Renders an element that is visually hidden and only available to screen readers", |
| "reverseOrder": { | ||
| "type": "boolean", | ||
| "required": false, | ||
| "description": "Wether should invert the order" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
| "visible": { | ||
| "type": "unknown", | ||
| "required": false, | ||
| "description": "Wether is visible" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
| "error": { | ||
| "type": "unknown", | ||
| "required": false, | ||
| "description": "Wether has error" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
| "description": "Wether has error" | |
| "description": "Whether has error" |
| "error": { | ||
| "type": "boolean", | ||
| "required": false, | ||
| "description": "Wether is disabled @default false" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
| "description": "Wether is disabled @default false" | |
| "description": "Whether is disabled @default false" |
| "sorted": { | ||
| "type": "unknown", | ||
| "required": false, | ||
| "description": "Indicates if column is currently sorted, and in witch order @default null" |
There was a problem hiding this comment.
Spelling error: 'witch' should be 'which'.
| "description": "Indicates if column is currently sorted, and in witch order @default null" | |
| "description": "Indicates if column is currently sorted, and in which order @default null" |
| "error": { | ||
| "type": "unknown", | ||
| "required": false, | ||
| "description": "Wether has error" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
| "error": { | ||
| "type": "unknown", | ||
| "required": false, | ||
| "description": "Wether has error" |
There was a problem hiding this comment.
Spelling error: 'Wether' should be 'Whether'.
Summary
Script to generate a JSON schema representation of Shoreline components to experiment with Gen UI concepts for VTEX AI Agents.