Vexylicon Development Guidelines
@vexyart/vexylicon
ā¢
Vexylicon is a Python package for creating sophisticated liquid-glass SVG icon effects. It transforms SVG icons with dual contours into glass-morphism designs with beveled edges and theme support.
prpm install @vexyart/vexylicon%0A%E2%94%82%20%20%20%E2%94%9C%E2%94%80%E2%94%80%20path_tools.py%20%20%20%20%23%20Path%20interpolation%20algorithms%20from%20icon_blender.py%0A%E2%94%82%20%20%20%E2%94%94%E2%94%80%E2%94%80%20theme_loader.py%20%20%23%20Pydantic-based%20theme%20validation%0A%E2%94%94%E2%94%80%E2%94%80%20assets%2F%0A%20%20%20%20%E2%94%9C%E2%94%80%E2%94%80%20best_base.svg%20%20%20%20%23%20Canonical%20base%20template%20with%20dual%20contours%0A%20%20%20%20%E2%94%94%E2%94%80%E2%94%80%20themes%2F%0A%20%20%20%20%20%20%20%20%E2%94%94%E2%94%80%E2%94%80%20default.json%20%23%20Theme%20definitions%0A%60%60%60%0A%0A%23%23%20Core%20Workflow%0A%0A1.%20**Input**%3A%20%60best_base.svg%60%20(1200x1200%20with%20dual%20contours)%20%2B%20optional%20payload%20SVG%0A2.%20**Processing**%3A%0A%20%20%20-%20Parse%20dual%20contours%20(outer%20and%20inner%20paths)%0A%20%20%20-%20Generate%20N%20interpolated%20rings%20(default%2024)%0A%20%20%20-%20Apply%20opacity%20progression%20(quartic%20by%20default)%0A%20%20%20-%20Add%20%60mix-blend-mode%3A%20screen%60%20for%20glass%20effect%0A%20%20%20-%20Inject%20payload%20with%20clipPath%20masking%0A3.%20**Output**%3A%20Glass%20effect%20SVG%20with%20optional%20theme%20variants%0A%0A%23%23%20Development%20Principles%0A%0A%23%23%23%20Code%20Quality%0A-%20Use%20%60uv%20pip%60%2C%20never%20%60pip%60%0A-%20Type%20hints%20on%20all%20public%20functions%0A-%20Docstrings%20in%20NumPy%20style%0A-%20Test%20coverage%20%3E90%25%0A-%20Black%20formatting%2C%20ruff%20linting%0A%0A%23%23%23%20SVG%20Processing%20Rules%0A-%20**ALWAYS%20use%20lxml**%20for%20XML%20manipulation%0A-%20**NEVER%20use%20string%20replacement**%20for%20SVG%20operations%0A-%20Preserve%20namespaces%20and%20attributes%0A-%20Round%20coordinates%20to%202%20decimal%20places%0A%0A%23%23%23%20Key%20Implementation%20Details%0A%0A1.%20**Path%20Interpolation**%3A%20%0A%20%20%20-%20Reverse%20outer%20contour%20for%20proper%20alignment%0A%20%20%20-%20Convert%20Line%20segments%20to%20degenerate%20CubicBeziers%0A%20%20%20-%20Ensure%20segment%20count%20compatibility%0A%0A2.%20**Opacity%20Progression**%3A%0A%20%20%20-%20Mode%201%3A%20Linear%0A%20%20%20-%20Mode%202%3A%20Decreasing%20(reverse%20exponential)%0A%20%20%20-%20Mode%203%3A%20Exponential%20(quadratic)%0A%20%20%20-%20Mode%204%3A%20More%20exponential%20(quartic)%20-%20DEFAULT%0A%0A3.%20**Theme%20System**%20(needs%20completion)%3A%0A%20%20%20-%20Duplicate%20gradients%20with%20-light%2F-dark%20suffixes%0A%20%20%20-%20Adjust%20opacity%20for%20dark%20variants%20(%2B20%25)%0A%20%20%20-%20Add%20CSS%20for%20prefers-color-scheme%0A%0A%23%23%20Current%20Issues%0A%0A1.%20**Theme%20Implementation%20Incomplete**%3A%0A%20%20%20-%20Gradients%20not%20properly%20duplicated%0A%20%20%20-%20CSS%20for%20theme%20switching%20missing%0A%20%20%20-%20Theme%20groups%20created%20but%20not%20functional%0A%0A2.%20**Payload%20Masking**%3A%0A%20%20%20-%20Works%20but%20needs%20refinement%20for%20complex%20SVGs%0A%20%20%20-%20ViewBox%20handling%20could%20be%20improved%0A%0A3.%20**Missing%20Features**%3A%0A%20%20%20-%20No%20Gradio-lite%20web%20interface%20yet%0A%20%20%20-%20Limited%20test%20coverage%0A%20%20%20-%20No%20progress%20indicators%20for%20batch%20mode%0A%0A%23%23%20Development%20Workflow%0A%0A1.%20**Before%20Changes**%3A%0A%20%20%20-%20Read%20existing%20code%20thoroughly%0A%20%20%20-%20Check%20PLAN.md%20and%20TODO.md%0A%20%20%20-%20Understand%20the%20dual-contour%20SVG%20format%0A%0A2.%20**Making%20Changes**%3A%0A%20%20%20-%20Work%20in%20small%2C%20testable%20increments%0A%20%20%20-%20Update%20CHANGELOG.md%20after%20each%20feature%0A%20%20%20-%20Keep%20TODO.md%20current%0A%0A3.%20**After%20Changes**%3A%0A%20%20%20%60%60%60bash%0A%20%20%20%23%20Format%20and%20lint%0A%20%20%20black%20src%20tests%0A%20%20%20ruff%20check%20--fix%20src%20tests%0A%20%20%20%0A%20%20%20%23%20Run%20tests%0A%20%20%20pytest%0A%20%20%20%0A%20%20%20%23%20Type%20check%0A%20%20%20mypy%20src%0A%20%20%20%60%60%60%0A%0A%23%23%20Priority%20Tasks%0A%0A1.%20**Fix%20Theme%20System**%3A%0A%20%20%20-%20Implement%20%60_duplicate_gradients_for_themes()%60%0A%20%20%20-%20Add%20proper%20CSS%20with%20media%20queries%0A%20%20%20-%20Test%20light%2Fdark%20switching%0A%0A2.%20**Gradio-lite%20Interface**%3A%0A%20%20%20-%20Minimal%20dependencies%20(may%20need%20to%20vendor%20svgpathtools)%0A%20%20%20-%20Handle%20Pyodide%20limitations%0A%20%20%20-%20Focus%20on%20core%20features%20only%0A%0A3.%20**Testing**%3A%0A%20%20%20-%20Unit%20tests%20for%20all%20path_tools%20functions%0A%20%20%20-%20Integration%20tests%20for%20full%20pipeline%0A%20%20%20-%20Snapshot%20tests%20for%20SVG%20output%0A%0A%23%23%20Technical%20Constraints%0A%0A-%20**Python%203.11%2B**%20required%0A-%20**Minimal%20dependencies**%3A%20lxml%2C%20svgpathtools%2C%20fire%2C%20pydantic%2C%20rich%0A-%20**No%20string%20manipulation**%20for%20SVG%20operations%0A-%20**Gradio-lite%20limitations**%3A%20Some%20packages%20won't%20work%20in%20browser%0A%0A%23%23%20File%20Path%20Tracking%0A%0AAlways%20include%20%60%23%20this_file%3A%20path%2Fto%2Ffile.py%60%20at%20the%20top%20of%20each%20Python%20file.%0A%0A%23%23%20Logging%20Guidelines%0A%0AWhen%20adding%20logging%20(pending)%3A%0A-%20Use%20loguru%20for%20structured%20logging%0A-%20Add%20%60--verbose%60%20flag%20to%20CLI%0A-%20Log%20at%20DEBUG%20level%20for%20development%0A-%20Include%20timing%20information%20for%20optimization%0A%0A%23%23%20Error%20Handling%0A%0A-%20Custom%20exceptions%3A%20%60VexyliconError%60%2C%20%60InvalidSVGError%60%2C%20%60ThemeValidationError%60%0A-%20Provide%20actionable%20error%20messages%0A-%20Suggest%20fixes%20for%20common%20issues%0A-%20Validate%20inputs%20early%0A%0A%23%23%20Remember%0A%0A-%20Focus%20on%20core%20functionality%2C%20not%20fancy%20features%0A-%20Glass%20effect%20quality%20is%20the%20top%20priority%0A-%20Keep%20dependencies%20minimal%0A-%20Test%20with%20real%20SVG%20files%0A-%20Document%20edge%20cases%0A%0A%24END%24){kind=link}
%0A%E2%94%82%20%20%20%E2%94%9C%E2%94%80%E2%94%80%20path_tools.py%20%20%20%20%23%20Path%20interpolation%20algorithms%20from%20icon_blender.py%0A%E2%94%82%20%20%20%E2%94%94%E2%94%80%E2%94%80%20theme_loader.py%20%20%23%20Pydantic-based%20theme%20validation%0A%E2%94%94%E2%94%80%E2%94%80%20assets%2F%0A%20%20%20%20%E2%94%9C%E2%94%80%E2%94%80%20best_base.svg%20%20%20%20%23%20Canonical%20base%20template%20with%20dual%20contours%0A%20%20%20%20%E2%94%94%E2%94%80%E2%94%80%20themes%2F%0A%20%20%20%20%20%20%20%20%E2%94%94%E2%94%80%E2%94%80%20default.json%20%23%20Theme%20definitions%0A%60%60%60%0A%0A%23%23%20Core%20Workflow%0A%0A1.%20**Input**%3A%20%60best_base.svg%60%20(1200x1200%20with%20dual%20contours)%20%2B%20optional%20payload%20SVG%0A2.%20**Processing**%3A%0A%20%20%20-%20Parse%20dual%20contours%20(outer%20and%20inner%20paths)%0A%20%20%20-%20Generate%20N%20interpolated%20rings%20(default%2024)%0A%20%20%20-%20Apply%20opacity%20progression%20(quartic%20by%20default)%0A%20%20%20-%20Add%20%60mix-blend-mode%3A%20screen%60%20for%20glass%20effect%0A%20%20%20-%20Inject%20payload%20with%20clipPath%20masking%0A3.%20**Output**%3A%20Glass%20effect%20SVG%20with%20optional%20theme%20variants%0A%0A%23%23%20Development%20Principles%0A%0A%23%23%23%20Code%20Quality%0A-%20Use%20%60uv%20pip%60%2C%20never%20%60pip%60%0A-%20Type%20hints%20on%20all%20public%20functions%0A-%20Docstrings%20in%20NumPy%20style%0A-%20Test%20coverage%20%3E90%25%0A-%20Black%20formatting%2C%20ruff%20linting%0A%0A%23%23%23%20SVG%20Processing%20Rules%0A-%20**ALWAYS%20use%20lxml**%20for%20XML%20manipulation%0A-%20**NEVER%20use%20string%20replacement**%20for%20SVG%20operations%0A-%20Preserve%20namespaces%20and%20attributes%0A-%20Round%20coordinates%20to%202%20decimal%20places%0A%0A%23%23%23%20Key%20Implementation%20Details%0A%0A1.%20**Path%20Interpolation**%3A%20%0A%20%20%20-%20Reverse%20outer%20contour%20for%20proper%20alignment%0A%20%20%20-%20Convert%20Line%20segments%20to%20degenerate%20CubicBeziers%0A%20%20%20-%20Ensure%20segment%20count%20compatibility%0A%0A2.%20**Opacity%20Progression**%3A%0A%20%20%20-%20Mode%201%3A%20Linear%0A%20%20%20-%20Mode%202%3A%20Decreasing%20(reverse%20exponential)%0A%20%20%20-%20Mode%203%3A%20Exponential%20(quadratic)%0A%20%20%20-%20Mode%204%3A%20More%20exponential%20(quartic)%20-%20DEFAULT%0A%0A3.%20**Theme%20System**%20(needs%20completion)%3A%0A%20%20%20-%20Duplicate%20gradients%20with%20-light%2F-dark%20suffixes%0A%20%20%20-%20Adjust%20opacity%20for%20dark%20variants%20(%2B20%25)%0A%20%20%20-%20Add%20CSS%20for%20prefers-color-scheme%0A%0A%23%23%20Current%20Issues%0A%0A1.%20**Theme%20Implementation%20Incomplete**%3A%0A%20%20%20-%20Gradients%20not%20properly%20duplicated%0A%20%20%20-%20CSS%20for%20theme%20switching%20missing%0A%20%20%20-%20Theme%20groups%20created%20but%20not%20functional%0A%0A2.%20**Payload%20Masking**%3A%0A%20%20%20-%20Works%20but%20needs%20refinement%20for%20complex%20SVGs%0A%20%20%20-%20ViewBox%20handling%20could%20be%20improved%0A%0A3.%20**Missing%20Features**%3A%0A%20%20%20-%20No%20Gradio-lite%20web%20interface%20yet%0A%20%20%20-%20Limited%20test%20coverage%0A%20%20%20-%20No%20progress%20indicators%20for%20batch%20mode%0A%0A%23%23%20Development%20Workflow%0A%0A1.%20**Before%20Changes**%3A%0A%20%20%20-%20Read%20existing%20code%20thoroughly%0A%20%20%20-%20Check%20PLAN.md%20and%20TODO.md%0A%20%20%20-%20Understand%20the%20dual-contour%20SVG%20format%0A%0A2.%20**Making%20Changes**%3A%0A%20%20%20-%20Work%20in%20small%2C%20testable%20increments%0A%20%20%20-%20Update%20CHANGELOG.md%20after%20each%20feature%0A%20%20%20-%20Keep%20TODO.md%20current%0A%0A3.%20**After%20Changes**%3A%0A%20%20%20%60%60%60bash%0A%20%20%20%23%20Format%20and%20lint%0A%20%20%20black%20src%20tests%0A%20%20%20ruff%20check%20--fix%20src%20tests%0A%20%20%20%0A%20%20%20%23%20Run%20tests%0A%20%20%20pytest%0A%20%20%20%0A%20%20%20%23%20Type%20check%0A%20%20%20mypy%20src%0A%20%20%20%60%60%60%0A%0A%23%23%20Priority%20Tasks%0A%0A1.%20**Fix%20Theme%20System**%3A%0A%20%20%20-%20Implement%20%60_duplicate_gradients_for_themes()%60%0A%20%20%20-%20Add%20proper%20CSS%20with%20media%20queries%0A%20%20%20-%20Test%20light%2Fdark%20switching%0A%0A2.%20**Gradio-lite%20Interface**%3A%0A%20%20%20-%20Minimal%20dependencies%20(may%20need%20to%20vendor%20svgpathtools)%0A%20%20%20-%20Handle%20Pyodide%20limitations%0A%20%20%20-%20Focus%20on%20core%20features%20only%0A%0A3.%20**Testing**%3A%0A%20%20%20-%20Unit%20tests%20for%20all%20path_tools%20functions%0A%20%20%20-%20Integration%20tests%20for%20full%20pipeline%0A%20%20%20-%20Snapshot%20tests%20for%20SVG%20output%0A%0A%23%23%20Technical%20Constraints%0A%0A-%20**Python%203.11%2B**%20required%0A-%20**Minimal%20dependencies**%3A%20lxml%2C%20svgpathtools%2C%20fire%2C%20pydantic%2C%20rich%0A-%20**No%20string%20manipulation**%20for%20SVG%20operations%0A-%20**Gradio-lite%20limitations**%3A%20Some%20packages%20won't%20work%20in%20browser%0A%0A%23%23%20File%20Path%20Tracking%0A%0AAlways%20include%20%60%23%20this_file%3A%20path%2Fto%2Ffile.py%60%20at%20the%20top%20of%20each%20Python%20file.%0A%0A%23%23%20Logging%20Guidelines%0A%0AWhen%20adding%20logging%20(pending)%3A%0A-%20Use%20loguru%20for%20structured%20logging%0A-%20Add%20%60--verbose%60%20flag%20to%20CLI%0A-%20Log%20at%20DEBUG%20level%20for%20development%0A-%20Include%20timing%20information%20for%20optimization%0A%0A%23%23%20Error%20Handling%0A%0A-%20Custom%20exceptions%3A%20%60VexyliconError%60%2C%20%60InvalidSVGError%60%2C%20%60ThemeValidationError%60%0A-%20Provide%20actionable%20error%20messages%0A-%20Suggest%20fixes%20for%20common%20issues%0A-%20Validate%20inputs%20early%0A%0A%23%23%20Remember%0A%0A-%20Focus%20on%20core%20functionality%2C%20not%20fancy%20features%0A-%20Glass%20effect%20quality%20is%20the%20top%20priority%0A-%20Keep%20dependencies%20minimal%0A-%20Test%20with%20real%20SVG%20files%0A-%20Document%20edge%20cases%0A%0A%24END%24){kind=link}
0 total downloads
š” Suggested Test Inputs
Loading suggested inputs...
šÆ Community Test Results
Loading results...
š¦ Package Info
- Format
- cursor
- Type
- rule
- Category
- testing
- License
- MIT
š Links
- Repository
- https://github.com/vexyart/vexylicon