Consolidate ASCII effects into component variants - #13
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (13)
📝 WalkthroughWalkthroughThe ASCII Effects documentation is consolidated into a single ChangesASCII Effect documentation and previews
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant DocsGallery
participant LazyRegistry
participant AsciiEffectDocs
participant AsciiEffectPreview
DocsGallery->>LazyRegistry: resolve ascii-effect
LazyRegistry->>AsciiEffectDocs: dynamically import docs
AsciiEffectDocs->>AsciiEffectPreview: render image, flow, and glitch previews
Possibly related PRs
Suggested reviewers: ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Checkov (3.3.8)apps/web/public/r/ascii-effect.jsonTraceback (most recent call last): apps/web/public/r/registry.jsonTraceback (most recent call last): 🔧 ESLint
scripts/generate-registry.jsOops! Something went wrong! :( ESLint: 9.39.1 Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './library.js' is not defined by "exports" in /node_modules/@workspace/eslint-config/package.json Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Consolidates the three separate ASCII effect components (image/flow/glitch) into a single ascii-effect registry entry and docs page, removing legacy registry items and catalog UI for palette switching while keeping customization available via props.
Changes:
- Replaced
ascii-image,ascii-flow, andascii-glitchregistry/docs routing with a singleascii-effectcomponent entry. - Added a unified docs page and previews that demonstrate
AsciiEffectvia thevariantprop. - Simplified the registry generator and removed documentation for the deprecated “shared source file” registry pattern.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate-registry.js | Removes the optional “source name” argument to align registry generation with 1:1 component files. |
| docs/COMPONENT_CREATION_GUIDE.md | Removes docs for shared-source registry generation; updates generator usage to single-arg form. |
| apps/web/registry/index.ts | Consolidates ASCII Effects metadata into a single ascii-effect entry. |
| apps/web/public/r/registry.json | Updates registry list to include ascii-effect and removes legacy ASCII items. |
| apps/web/public/r/ascii-glitch.json | Removes legacy registry item. |
| apps/web/public/r/ascii-flow.json | Removes legacy registry item. |
| apps/web/public/r/ascii-effect.json | Renames/retitles the registry item to ascii-effect and updates description. |
| apps/web/components/docs/previews/ascii-effects-preview.tsx | Removes legacy per-effect preview implementation. |
| apps/web/components/docs/previews/ascii-effect-preview.tsx | Adds unified previews driven by AsciiEffect + variant. |
| apps/web/components/docs/lazy-registry.ts | Updates docs import map to the single ascii-effect docs page. |
| apps/web/components/docs/ascii-effects.tsx | Removes legacy multi-page docs implementation. |
| apps/web/components/docs/ascii-effect.tsx | Adds unified docs page with variant examples and consolidated props table. |
| apps/web/app/docs/page.tsx | Removes ASCII palette UI and updates catalog preview to new unified preview component. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
ascii-effectcomponentValidation
pnpm --filter web exec tsc --noEmitpnpm validate:registrySummary by CodeRabbit
New Features
Improvements