@heytherevibin/skillforge 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/CODE_OF_CONDUCT.md +34 -0
- package/CONTRIBUTING.md +38 -0
- package/LICENSE +21 -0
- package/README.md +337 -0
- package/RELEASING.md +93 -0
- package/SECURITY.md +31 -0
- package/STRATEGY.md +26 -0
- package/bin/cli.js +547 -0
- package/lib/packs.js +184 -0
- package/package.json +38 -0
- package/python/app/__init__.py +0 -0
- package/python/app/__pycache__/__init__.cpython-312.pyc +0 -0
- package/python/app/__pycache__/auth.cpython-312.pyc +0 -0
- package/python/app/__pycache__/main.cpython-312.pyc +0 -0
- package/python/app/auth.py +63 -0
- package/python/app/cli.py +78 -0
- package/python/app/db_paths.py +26 -0
- package/python/app/events_cli.py +175 -0
- package/python/app/main.py +647 -0
- package/python/app/materialize.py +138 -0
- package/python/app/mcp_server.py +610 -0
- package/python/app/route_cli.py +117 -0
- package/python/requirements-dev.txt +1 -0
- package/python/requirements.txt +7 -0
- package/python/tests/test_db_paths.py +41 -0
- package/skills/accessibility/SKILL.md +145 -0
- package/skills/agent-architecture-audit/SKILL.md +256 -0
- package/skills/agent-eval/SKILL.md +144 -0
- package/skills/agent-harness-construction/SKILL.md +72 -0
- package/skills/agent-introspection-debugging/SKILL.md +152 -0
- package/skills/agent-payment-x402/SKILL.md +224 -0
- package/skills/agent-sort/SKILL.md +214 -0
- package/skills/agentic-engineering/SKILL.md +62 -0
- package/skills/agentic-os/SKILL.md +386 -0
- package/skills/ai-first-engineering/SKILL.md +50 -0
- package/skills/ai-regression-testing/SKILL.md +384 -0
- package/skills/android-clean-architecture/SKILL.md +338 -0
- package/skills/angular-developer/SKILL.md +153 -0
- package/skills/angular-developer/references/angular-animations.md +160 -0
- package/skills/angular-developer/references/angular-aria.md +410 -0
- package/skills/angular-developer/references/cli.md +86 -0
- package/skills/angular-developer/references/component-harnesses.md +59 -0
- package/skills/angular-developer/references/component-styling.md +91 -0
- package/skills/angular-developer/references/components.md +117 -0
- package/skills/angular-developer/references/creating-services.md +97 -0
- package/skills/angular-developer/references/data-resolvers.md +69 -0
- package/skills/angular-developer/references/define-routes.md +67 -0
- package/skills/angular-developer/references/defining-providers.md +72 -0
- package/skills/angular-developer/references/di-fundamentals.md +120 -0
- package/skills/angular-developer/references/e2e-testing.md +56 -0
- package/skills/angular-developer/references/effects.md +83 -0
- package/skills/angular-developer/references/hierarchical-injectors.md +43 -0
- package/skills/angular-developer/references/host-elements.md +80 -0
- package/skills/angular-developer/references/injection-context.md +63 -0
- package/skills/angular-developer/references/inputs.md +101 -0
- package/skills/angular-developer/references/linked-signal.md +59 -0
- package/skills/angular-developer/references/loading-strategies.md +61 -0
- package/skills/angular-developer/references/mcp.md +108 -0
- package/skills/angular-developer/references/navigate-to-routes.md +69 -0
- package/skills/angular-developer/references/outputs.md +86 -0
- package/skills/angular-developer/references/reactive-forms.md +122 -0
- package/skills/angular-developer/references/rendering-strategies.md +44 -0
- package/skills/angular-developer/references/resource.md +77 -0
- package/skills/angular-developer/references/route-animations.md +56 -0
- package/skills/angular-developer/references/route-guards.md +52 -0
- package/skills/angular-developer/references/router-lifecycle.md +45 -0
- package/skills/angular-developer/references/router-testing.md +87 -0
- package/skills/angular-developer/references/show-routes-with-outlets.md +68 -0
- package/skills/angular-developer/references/signal-forms.md +795 -0
- package/skills/angular-developer/references/signals-overview.md +94 -0
- package/skills/angular-developer/references/tailwind-css.md +69 -0
- package/skills/angular-developer/references/template-driven-forms.md +114 -0
- package/skills/angular-developer/references/testing-fundamentals.md +65 -0
- package/skills/api-connector-builder/SKILL.md +120 -0
- package/skills/api-design/SKILL.md +522 -0
- package/skills/architecture-decision-records/SKILL.md +178 -0
- package/skills/article-writing/SKILL.md +78 -0
- package/skills/automation-audit-ops/SKILL.md +141 -0
- package/skills/autonomous-agent-harness/SKILL.md +272 -0
- package/skills/autonomous-loops/SKILL.md +609 -0
- package/skills/backend-patterns/SKILL.md +560 -0
- package/skills/benchmark/SKILL.md +92 -0
- package/skills/blueprint/SKILL.md +104 -0
- package/skills/browser-qa/SKILL.md +86 -0
- package/skills/bun-runtime/SKILL.md +83 -0
- package/skills/canary-watch/SKILL.md +98 -0
- package/skills/carrier-relationship-management/SKILL.md +211 -0
- package/skills/cisco-ios-patterns/SKILL.md +163 -0
- package/skills/ck/SKILL.md +147 -0
- package/skills/ck/commands/forget.mjs +44 -0
- package/skills/ck/commands/info.mjs +24 -0
- package/skills/ck/commands/init.mjs +143 -0
- package/skills/ck/commands/list.mjs +40 -0
- package/skills/ck/commands/migrate.mjs +202 -0
- package/skills/ck/commands/resume.mjs +36 -0
- package/skills/ck/commands/save.mjs +210 -0
- package/skills/ck/commands/shared.mjs +387 -0
- package/skills/ck/hooks/session-start.mjs +224 -0
- package/skills/claude-devfleet/SKILL.md +103 -0
- package/skills/click-path-audit/SKILL.md +244 -0
- package/skills/clickhouse-io/SKILL.md +438 -0
- package/skills/code-tour/SKILL.md +235 -0
- package/skills/codebase-onboarding/SKILL.md +232 -0
- package/skills/coding-standards/SKILL.md +548 -0
- package/skills/compose-multiplatform-patterns/SKILL.md +298 -0
- package/skills/connections-optimizer/SKILL.md +188 -0
- package/skills/content-engine/SKILL.md +126 -0
- package/skills/content-hash-cache-pattern/SKILL.md +160 -0
- package/skills/context-budget/SKILL.md +134 -0
- package/skills/continuous-agent-loop/SKILL.md +44 -0
- package/skills/continuous-learning/SKILL.md +129 -0
- package/skills/continuous-learning/config.json +18 -0
- package/skills/continuous-learning/evaluate-session.sh +69 -0
- package/skills/continuous-learning-v2/SKILL.md +358 -0
- package/skills/continuous-learning-v2/agents/observer-loop.sh +322 -0
- package/skills/continuous-learning-v2/agents/observer.md +198 -0
- package/skills/continuous-learning-v2/agents/session-guardian.sh +150 -0
- package/skills/continuous-learning-v2/agents/start-observer.sh +248 -0
- package/skills/continuous-learning-v2/config.json +8 -0
- package/skills/continuous-learning-v2/hooks/observe.sh +476 -0
- package/skills/continuous-learning-v2/scripts/detect-project.sh +288 -0
- package/skills/continuous-learning-v2/scripts/instinct-cli.py +1519 -0
- package/skills/continuous-learning-v2/scripts/lib/homunculus-dir.sh +31 -0
- package/skills/continuous-learning-v2/scripts/migrate-homunculus.sh +62 -0
- package/skills/continuous-learning-v2/scripts/test_parse_instinct.py +1018 -0
- package/skills/cost-aware-llm-pipeline/SKILL.md +182 -0
- package/skills/cost-tracking/SKILL.md +147 -0
- package/skills/council/SKILL.md +202 -0
- package/skills/cpp-coding-standards/SKILL.md +722 -0
- package/skills/cpp-testing/SKILL.md +323 -0
- package/skills/crosspost/SKILL.md +110 -0
- package/skills/csharp-testing/SKILL.md +320 -0
- package/skills/customer-billing-ops/SKILL.md +139 -0
- package/skills/customs-trade-compliance/SKILL.md +262 -0
- package/skills/dart-flutter-patterns/SKILL.md +562 -0
- package/skills/dashboard-builder/SKILL.md +108 -0
- package/skills/data-scraper-agent/SKILL.md +764 -0
- package/skills/database-migrations/SKILL.md +428 -0
- package/skills/deep-research/SKILL.md +158 -0
- package/skills/defi-amm-security/SKILL.md +166 -0
- package/skills/deployment-patterns/SKILL.md +426 -0
- package/skills/design-system/SKILL.md +81 -0
- package/skills/django-celery/SKILL.md +456 -0
- package/skills/django-patterns/SKILL.md +733 -0
- package/skills/django-security/SKILL.md +592 -0
- package/skills/django-tdd/SKILL.md +728 -0
- package/skills/django-verification/SKILL.md +468 -0
- package/skills/dmux-workflows/SKILL.md +190 -0
- package/skills/docker-patterns/SKILL.md +363 -0
- package/skills/documentation-lookup/SKILL.md +89 -0
- package/skills/dotnet-patterns/SKILL.md +320 -0
- package/skills/e2e-testing/SKILL.md +325 -0
- package/skills/email-ops/SKILL.md +120 -0
- package/skills/energy-procurement/SKILL.md +227 -0
- package/skills/enterprise-agent-ops/SKILL.md +49 -0
- package/skills/error-handling/SKILL.md +375 -0
- package/skills/eval-harness/SKILL.md +269 -0
- package/skills/evm-token-decimals/SKILL.md +130 -0
- package/skills/exa-search/SKILL.md +106 -0
- package/skills/fal-ai-media/SKILL.md +287 -0
- package/skills/fastapi-patterns/SKILL.md +327 -0
- package/skills/finance-billing-ops/SKILL.md +126 -0
- package/skills/flox-environments/SKILL.md +496 -0
- package/skills/flutter-dart-code-review/SKILL.md +434 -0
- package/skills/foundation-models-on-device/SKILL.md +243 -0
- package/skills/frontend-design-direction/SKILL.md +92 -0
- package/skills/frontend-patterns/SKILL.md +641 -0
- package/skills/frontend-slides/SKILL.md +183 -0
- package/skills/frontend-slides/STYLE_PRESETS.md +330 -0
- package/skills/frontend-slides/animation-patterns.md +122 -0
- package/skills/frontend-slides/html-template.md +419 -0
- package/skills/frontend-slides/scripts/export-pdf.sh +418 -0
- package/skills/frontend-slides/scripts/extract-pptx.py +96 -0
- package/skills/frontend-slides/viewport-base.css +153 -0
- package/skills/fsharp-testing/SKILL.md +279 -0
- package/skills/gan-style-harness/SKILL.md +278 -0
- package/skills/gateguard/SKILL.md +125 -0
- package/skills/git-workflow/SKILL.md +714 -0
- package/skills/github-ops/SKILL.md +143 -0
- package/skills/golang-patterns/SKILL.md +673 -0
- package/skills/golang-testing/SKILL.md +719 -0
- package/skills/google-workspace-ops/SKILL.md +94 -0
- package/skills/healthcare-cdss-patterns/SKILL.md +245 -0
- package/skills/healthcare-emr-patterns/SKILL.md +159 -0
- package/skills/healthcare-eval-harness/SKILL.md +207 -0
- package/skills/healthcare-phi-compliance/SKILL.md +145 -0
- package/skills/hermes-imports/SKILL.md +87 -0
- package/skills/hexagonal-architecture/SKILL.md +275 -0
- package/skills/hipaa-compliance/SKILL.md +78 -0
- package/skills/homelab-network-readiness/SKILL.md +169 -0
- package/skills/homelab-network-setup/SKILL.md +129 -0
- package/skills/homelab-pihole-dns/SKILL.md +274 -0
- package/skills/homelab-vlan-segmentation/SKILL.md +311 -0
- package/skills/homelab-wireguard-vpn/SKILL.md +305 -0
- package/skills/hookify-rules/SKILL.md +128 -0
- package/skills/inventory-demand-planning/SKILL.md +246 -0
- package/skills/investor-materials/SKILL.md +95 -0
- package/skills/investor-outreach/SKILL.md +90 -0
- package/skills/ios-icon-gen/SKILL.md +157 -0
- package/skills/ios-icon-gen/scripts/generate_icons.swift +258 -0
- package/skills/ios-icon-gen/scripts/iconify_gen.sh +235 -0
- package/skills/iterative-retrieval/SKILL.md +209 -0
- package/skills/java-coding-standards/SKILL.md +382 -0
- package/skills/jira-integration/SKILL.md +292 -0
- package/skills/jpa-patterns/SKILL.md +150 -0
- package/skills/knowledge-ops/SKILL.md +153 -0
- package/skills/kotlin-coroutines-flows/SKILL.md +283 -0
- package/skills/kotlin-exposed-patterns/SKILL.md +718 -0
- package/skills/kotlin-ktor-patterns/SKILL.md +688 -0
- package/skills/kotlin-patterns/SKILL.md +710 -0
- package/skills/kotlin-testing/SKILL.md +823 -0
- package/skills/laravel-patterns/SKILL.md +414 -0
- package/skills/laravel-plugin-discovery/SKILL.md +228 -0
- package/skills/laravel-security/SKILL.md +284 -0
- package/skills/laravel-tdd/SKILL.md +282 -0
- package/skills/laravel-verification/SKILL.md +178 -0
- package/skills/lead-intelligence/SKILL.md +320 -0
- package/skills/lead-intelligence/agents/enrichment-agent.md +85 -0
- package/skills/lead-intelligence/agents/mutual-mapper.md +75 -0
- package/skills/lead-intelligence/agents/outreach-drafter.md +98 -0
- package/skills/lead-intelligence/agents/signal-scorer.md +60 -0
- package/skills/liquid-glass-design/SKILL.md +279 -0
- package/skills/llm-trading-agent-security/SKILL.md +146 -0
- package/skills/logistics-exception-management/SKILL.md +221 -0
- package/skills/make-interfaces-feel-better/SKILL.md +151 -0
- package/skills/manim-video/SKILL.md +88 -0
- package/skills/manim-video/assets/network_graph_scene.py +52 -0
- package/skills/market-research/SKILL.md +74 -0
- package/skills/mcp-server-patterns/SKILL.md +68 -0
- package/skills/messages-ops/SKILL.md +103 -0
- package/skills/mle-workflow/SKILL.md +345 -0
- package/skills/motion-advanced/SKILL.md +596 -0
- package/skills/motion-foundations/SKILL.md +299 -0
- package/skills/motion-patterns/SKILL.md +435 -0
- package/skills/motion-ui/SKILL.md +574 -0
- package/skills/mysql-patterns/SKILL.md +411 -0
- package/skills/nanoclaw-repl/SKILL.md +32 -0
- package/skills/nestjs-patterns/SKILL.md +229 -0
- package/skills/netmiko-ssh-automation/SKILL.md +173 -0
- package/skills/network-bgp-diagnostics/SKILL.md +167 -0
- package/skills/network-config-validation/SKILL.md +210 -0
- package/skills/network-interface-health/SKILL.md +152 -0
- package/skills/nextjs-turbopack/SKILL.md +43 -0
- package/skills/nodejs-keccak256/SKILL.md +102 -0
- package/skills/nutrient-document-processing/SKILL.md +166 -0
- package/skills/nuxt4-patterns/SKILL.md +99 -0
- package/skills/openclaw-persona-forge/SKILL.md +288 -0
- package/skills/openclaw-persona-forge/gacha.py +224 -0
- package/skills/openclaw-persona-forge/gacha.sh +5 -0
- package/skills/openclaw-persona-forge/references/avatar-style.md +124 -0
- package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -0
- package/skills/openclaw-persona-forge/references/error-handling.md +53 -0
- package/skills/openclaw-persona-forge/references/identity-tension.md +48 -0
- package/skills/openclaw-persona-forge/references/naming-system.md +39 -0
- package/skills/openclaw-persona-forge/references/output-template.md +166 -0
- package/skills/opensource-pipeline/SKILL.md +254 -0
- package/skills/perl-patterns/SKILL.md +503 -0
- package/skills/perl-security/SKILL.md +502 -0
- package/skills/perl-testing/SKILL.md +474 -0
- package/skills/plan-orchestrate/SKILL.md +253 -0
- package/skills/plankton-code-quality/SKILL.md +236 -0
- package/skills/postgres-patterns/SKILL.md +146 -0
- package/skills/product-capability/SKILL.md +140 -0
- package/skills/product-lens/SKILL.md +91 -0
- package/skills/production-audit/SKILL.md +206 -0
- package/skills/production-scheduling/SKILL.md +237 -0
- package/skills/project-flow-ops/SKILL.md +110 -0
- package/skills/prompt-optimizer/SKILL.md +398 -0
- package/skills/python-patterns/SKILL.md +749 -0
- package/skills/python-testing/SKILL.md +815 -0
- package/skills/pytorch-patterns/SKILL.md +395 -0
- package/skills/quality-nonconformance/SKILL.md +259 -0
- package/skills/quarkus-patterns/SKILL.md +721 -0
- package/skills/quarkus-security/SKILL.md +466 -0
- package/skills/quarkus-tdd/SKILL.md +810 -0
- package/skills/quarkus-verification/SKILL.md +478 -0
- package/skills/ralphinho-rfc-pipeline/SKILL.md +66 -0
- package/skills/redis-patterns/SKILL.md +402 -0
- package/skills/regex-vs-llm-structured-text/SKILL.md +219 -0
- package/skills/remotion-video-creation/SKILL.md +43 -0
- package/skills/remotion-video-creation/rules/3d.md +86 -0
- package/skills/remotion-video-creation/rules/animations.md +29 -0
- package/skills/remotion-video-creation/rules/assets/charts-bar-chart.tsx +173 -0
- package/skills/remotion-video-creation/rules/assets/text-animations-typewriter.tsx +100 -0
- package/skills/remotion-video-creation/rules/assets/text-animations-word-highlight.tsx +108 -0
- package/skills/remotion-video-creation/rules/assets.md +78 -0
- package/skills/remotion-video-creation/rules/audio.md +172 -0
- package/skills/remotion-video-creation/rules/calculate-metadata.md +104 -0
- package/skills/remotion-video-creation/rules/can-decode.md +75 -0
- package/skills/remotion-video-creation/rules/charts.md +58 -0
- package/skills/remotion-video-creation/rules/compositions.md +146 -0
- package/skills/remotion-video-creation/rules/display-captions.md +126 -0
- package/skills/remotion-video-creation/rules/extract-frames.md +229 -0
- package/skills/remotion-video-creation/rules/fonts.md +152 -0
- package/skills/remotion-video-creation/rules/get-audio-duration.md +58 -0
- package/skills/remotion-video-creation/rules/get-video-dimensions.md +68 -0
- package/skills/remotion-video-creation/rules/get-video-duration.md +58 -0
- package/skills/remotion-video-creation/rules/gifs.md +138 -0
- package/skills/remotion-video-creation/rules/images.md +130 -0
- package/skills/remotion-video-creation/rules/import-srt-captions.md +67 -0
- package/skills/remotion-video-creation/rules/lottie.md +67 -0
- package/skills/remotion-video-creation/rules/measuring-dom-nodes.md +34 -0
- package/skills/remotion-video-creation/rules/measuring-text.md +143 -0
- package/skills/remotion-video-creation/rules/sequencing.md +106 -0
- package/skills/remotion-video-creation/rules/tailwind.md +11 -0
- package/skills/remotion-video-creation/rules/text-animations.md +20 -0
- package/skills/remotion-video-creation/rules/timing.md +179 -0
- package/skills/remotion-video-creation/rules/transcribe-captions.md +19 -0
- package/skills/remotion-video-creation/rules/transitions.md +122 -0
- package/skills/remotion-video-creation/rules/trimming.md +52 -0
- package/skills/remotion-video-creation/rules/videos.md +171 -0
- package/skills/repo-scan/SKILL.md +78 -0
- package/skills/research-ops/SKILL.md +111 -0
- package/skills/returns-reverse-logistics/SKILL.md +239 -0
- package/skills/rules-distill/SKILL.md +263 -0
- package/skills/rules-distill/scripts/scan-rules.sh +58 -0
- package/skills/rules-distill/scripts/scan-skills.sh +129 -0
- package/skills/rust-patterns/SKILL.md +498 -0
- package/skills/rust-testing/SKILL.md +499 -0
- package/skills/safety-guard/SKILL.md +74 -0
- package/skills/santa-method/SKILL.md +306 -0
- package/skills/scientific-db-pubmed-database/SKILL.md +175 -0
- package/skills/scientific-db-uspto-database/SKILL.md +177 -0
- package/skills/scientific-pkg-gget/SKILL.md +166 -0
- package/skills/scientific-thinking-literature-review/SKILL.md +192 -0
- package/skills/scientific-thinking-scholar-evaluation/SKILL.md +160 -0
- package/skills/search-first/SKILL.md +181 -0
- package/skills/security-bounty-hunter/SKILL.md +99 -0
- package/skills/security-review/SKILL.md +502 -0
- package/skills/security-review/cloud-infrastructure-security.md +361 -0
- package/skills/seo/SKILL.md +153 -0
- package/skills/skill-comply/SKILL.md +57 -0
- package/skills/skill-comply/fixtures/compliant_trace.jsonl +5 -0
- package/skills/skill-comply/fixtures/noncompliant_trace.jsonl +3 -0
- package/skills/skill-comply/fixtures/tdd_spec.yaml +44 -0
- package/skills/skill-comply/prompts/classifier.md +24 -0
- package/skills/skill-comply/prompts/scenario_generator.md +62 -0
- package/skills/skill-comply/prompts/spec_generator.md +42 -0
- package/skills/skill-comply/pyproject.toml +15 -0
- package/skills/skill-comply/scripts/__init__.py +0 -0
- package/skills/skill-comply/scripts/classifier.py +85 -0
- package/skills/skill-comply/scripts/grader.py +124 -0
- package/skills/skill-comply/scripts/parser.py +107 -0
- package/skills/skill-comply/scripts/report.py +170 -0
- package/skills/skill-comply/scripts/run.py +127 -0
- package/skills/skill-comply/scripts/runner.py +186 -0
- package/skills/skill-comply/scripts/scenario_generator.py +70 -0
- package/skills/skill-comply/scripts/spec_generator.py +72 -0
- package/skills/skill-comply/scripts/utils.py +13 -0
- package/skills/skill-comply/tests/test_grader.py +197 -0
- package/skills/skill-comply/tests/test_parser.py +90 -0
- package/skills/skill-comply/tests/test_runner.py +172 -0
- package/skills/skill-scout/SKILL.md +139 -0
- package/skills/skill-stocktake/SKILL.md +193 -0
- package/skills/skill-stocktake/scripts/quick-diff.sh +87 -0
- package/skills/skill-stocktake/scripts/save-results.sh +56 -0
- package/skills/skill-stocktake/scripts/scan.sh +170 -0
- package/skills/social-graph-ranker/SKILL.md +153 -0
- package/skills/springboot-patterns/SKILL.md +313 -0
- package/skills/springboot-security/SKILL.md +271 -0
- package/skills/springboot-tdd/SKILL.md +157 -0
- package/skills/springboot-verification/SKILL.md +230 -0
- package/skills/strategic-compact/SKILL.md +129 -0
- package/skills/strategic-compact/suggest-compact.sh +54 -0
- package/skills/swift-actor-persistence/SKILL.md +142 -0
- package/skills/swift-concurrency-6-2/SKILL.md +216 -0
- package/skills/swift-protocol-di-testing/SKILL.md +189 -0
- package/skills/swiftui-patterns/SKILL.md +259 -0
- package/skills/tdd-workflow/SKILL.md +462 -0
- package/skills/team-builder/SKILL.md +166 -0
- package/skills/terminal-ops/SKILL.md +108 -0
- package/skills/tinystruct-patterns/SKILL.md +130 -0
- package/skills/tinystruct-patterns/references/architecture.md +77 -0
- package/skills/tinystruct-patterns/references/data-handling.md +35 -0
- package/skills/tinystruct-patterns/references/routing.md +57 -0
- package/skills/tinystruct-patterns/references/system-usage.md +74 -0
- package/skills/tinystruct-patterns/references/testing.md +59 -0
- package/skills/token-budget-advisor/SKILL.md +133 -0
- package/skills/ui-demo/SKILL.md +464 -0
- package/skills/ui-to-vue/SKILL.md +134 -0
- package/skills/unified-notifications-ops/SKILL.md +186 -0
- package/skills/verification-loop/SKILL.md +125 -0
- package/skills/video-editing/SKILL.md +309 -0
- package/skills/videodb/SKILL.md +373 -0
- package/skills/videodb/reference/api-reference.md +550 -0
- package/skills/videodb/reference/capture-reference.md +407 -0
- package/skills/videodb/reference/capture.md +101 -0
- package/skills/videodb/reference/editor.md +443 -0
- package/skills/videodb/reference/generative.md +331 -0
- package/skills/videodb/reference/rtstream-reference.md +564 -0
- package/skills/videodb/reference/rtstream.md +65 -0
- package/skills/videodb/reference/search.md +230 -0
- package/skills/videodb/reference/streaming.md +406 -0
- package/skills/videodb/reference/use-cases.md +118 -0
- package/skills/videodb/scripts/ws_listener.py +282 -0
- package/skills/visa-doc-translate/README.md +86 -0
- package/skills/visa-doc-translate/SKILL.md +117 -0
- package/skills/vite-patterns/SKILL.md +448 -0
- package/skills/windows-desktop-e2e/SKILL.md +787 -0
- package/skills/workspace-surface-audit/SKILL.md +124 -0
- package/skills/x-api/SKILL.md +233 -0
|
@@ -0,0 +1,464 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ui-demo
|
|
3
|
+
description: Record polished UI demo videos using Playwright. Use when the user asks to create a demo, walkthrough, screen recording, or tutorial video of a web application. Produces WebM videos with visible cursor, natural pacing, and professional feel.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# UI Demo Video Recorder
|
|
7
|
+
|
|
8
|
+
Record polished demo videos of web applications using Playwright's video recording with an injected cursor overlay, natural pacing, and storytelling flow.
|
|
9
|
+
|
|
10
|
+
## When to Use
|
|
11
|
+
|
|
12
|
+
- User asks for a "demo video", "screen recording", "walkthrough", or "tutorial"
|
|
13
|
+
- User wants to showcase a feature or workflow visually
|
|
14
|
+
- User needs a video for documentation, onboarding, or stakeholder presentation
|
|
15
|
+
|
|
16
|
+
## Three-Phase Process
|
|
17
|
+
|
|
18
|
+
Every demo goes through three phases: **Discover -> Rehearse -> Record**. Never skip straight to recording.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Phase 1: Discover
|
|
23
|
+
|
|
24
|
+
Before writing any script, explore the target pages to understand what is actually there.
|
|
25
|
+
|
|
26
|
+
### Why
|
|
27
|
+
|
|
28
|
+
You cannot script what you have not seen. Fields may be `<input>` not `<textarea>`, dropdowns may be custom components not `<select>`, and comment boxes may support `@mentions` or `#tags`. Assumptions break recordings silently.
|
|
29
|
+
|
|
30
|
+
### How
|
|
31
|
+
|
|
32
|
+
Navigate to each page in the flow and dump its interactive elements:
|
|
33
|
+
|
|
34
|
+
```javascript
|
|
35
|
+
// Run this for each page in the flow BEFORE writing the demo script
|
|
36
|
+
const fields = await page.evaluate(() => {
|
|
37
|
+
const els = [];
|
|
38
|
+
document.querySelectorAll('input, select, textarea, button, [contenteditable]').forEach(el => {
|
|
39
|
+
if (el.offsetParent !== null) {
|
|
40
|
+
els.push({
|
|
41
|
+
tag: el.tagName,
|
|
42
|
+
type: el.type || '',
|
|
43
|
+
name: el.name || '',
|
|
44
|
+
placeholder: el.placeholder || '',
|
|
45
|
+
text: el.textContent?.trim().substring(0, 40) || '',
|
|
46
|
+
contentEditable: el.contentEditable === 'true',
|
|
47
|
+
role: el.getAttribute('role') || '',
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
});
|
|
51
|
+
return els;
|
|
52
|
+
});
|
|
53
|
+
console.log(JSON.stringify(fields, null, 2));
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### What to look for
|
|
57
|
+
|
|
58
|
+
- **Form fields**: Are they `<select>`, `<input>`, custom dropdowns, or comboboxes?
|
|
59
|
+
- **Select options**: Dump option values AND text. Placeholders often have `value="0"` or `value=""` which looks non-empty. Use `Array.from(el.options).map(o => ({ value: o.value, text: o.text }))`. Skip options where text includes "Select" or value is `"0"`.
|
|
60
|
+
- **Rich text**: Does the comment box support `@mentions`, `#tags`, markdown, or emoji? Check placeholder text.
|
|
61
|
+
- **Required fields**: Which fields block form submission? Check `required`, `*` in labels, and try submitting empty to see validation errors.
|
|
62
|
+
- **Dynamic content**: Do fields appear after other fields are filled?
|
|
63
|
+
- **Button labels**: Exact text such as `"Submit"`, `"Submit Request"`, or `"Send"`.
|
|
64
|
+
- **Table column headers**: For table-driven modals, map each `input[type="number"]` to its column header instead of assuming all numeric inputs mean the same thing.
|
|
65
|
+
|
|
66
|
+
### Output
|
|
67
|
+
|
|
68
|
+
A field map for each page, used to write correct selectors in the script. Example:
|
|
69
|
+
|
|
70
|
+
```text
|
|
71
|
+
/purchase-requests/new:
|
|
72
|
+
- Budget Code: <select> (first select on page, 4 options)
|
|
73
|
+
- Desired Delivery: <input type="date">
|
|
74
|
+
- Context: <textarea> (not input)
|
|
75
|
+
- BOM table: inline-editable cells with span.cursor-pointer -> input pattern
|
|
76
|
+
- Submit: <button> text="Submit"
|
|
77
|
+
|
|
78
|
+
/purchase-requests/N (detail):
|
|
79
|
+
- Comment: <input placeholder="Type a message..."> supports @user and #PR tags
|
|
80
|
+
- Send: <button> text="Send" (disabled until input has content)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Phase 2: Rehearse
|
|
86
|
+
|
|
87
|
+
Run through all steps without recording. Verify every selector resolves.
|
|
88
|
+
|
|
89
|
+
### Why
|
|
90
|
+
|
|
91
|
+
Silent selector failures are the main reason demo recordings break. Rehearsal catches them before you waste a recording.
|
|
92
|
+
|
|
93
|
+
### How
|
|
94
|
+
|
|
95
|
+
Use `ensureVisible`, a wrapper that logs and fails loudly:
|
|
96
|
+
|
|
97
|
+
```javascript
|
|
98
|
+
async function ensureVisible(page, locator, label) {
|
|
99
|
+
const el = typeof locator === 'string' ? page.locator(locator).first() : locator;
|
|
100
|
+
const visible = await el.isVisible().catch(() => false);
|
|
101
|
+
if (!visible) {
|
|
102
|
+
const msg = `REHEARSAL FAIL: "${label}" not found - selector: ${typeof locator === 'string' ? locator : '(locator object)'}`;
|
|
103
|
+
console.error(msg);
|
|
104
|
+
const found = await page.evaluate(() => {
|
|
105
|
+
return Array.from(document.querySelectorAll('button, input, select, textarea, a'))
|
|
106
|
+
.filter(el => el.offsetParent !== null)
|
|
107
|
+
.map(el => `${el.tagName}[${el.type || ''}] "${el.textContent?.trim().substring(0, 30)}"`)
|
|
108
|
+
.join('\n ');
|
|
109
|
+
});
|
|
110
|
+
console.error(' Visible elements:\n ' + found);
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
console.log(`REHEARSAL OK: "${label}"`);
|
|
114
|
+
return true;
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Rehearsal script structure
|
|
119
|
+
|
|
120
|
+
```javascript
|
|
121
|
+
const steps = [
|
|
122
|
+
{ label: 'Login email field', selector: '#email' },
|
|
123
|
+
{ label: 'Login submit', selector: 'button[type="submit"]' },
|
|
124
|
+
{ label: 'New Request button', selector: 'button:has-text("New Request")' },
|
|
125
|
+
{ label: 'Budget Code select', selector: 'select' },
|
|
126
|
+
{ label: 'Delivery date', selector: 'input[type="date"]:visible' },
|
|
127
|
+
{ label: 'Description field', selector: 'textarea:visible' },
|
|
128
|
+
{ label: 'Add Item button', selector: 'button:has-text("Add Item")' },
|
|
129
|
+
{ label: 'Submit button', selector: 'button:has-text("Submit")' },
|
|
130
|
+
];
|
|
131
|
+
|
|
132
|
+
let allOk = true;
|
|
133
|
+
for (const step of steps) {
|
|
134
|
+
if (!await ensureVisible(page, step.selector, step.label)) {
|
|
135
|
+
allOk = false;
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
if (!allOk) {
|
|
139
|
+
console.error('REHEARSAL FAILED - fix selectors before recording');
|
|
140
|
+
process.exit(1);
|
|
141
|
+
}
|
|
142
|
+
console.log('REHEARSAL PASSED - all selectors verified');
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### When rehearsal fails
|
|
146
|
+
|
|
147
|
+
1. Read the visible-element dump.
|
|
148
|
+
2. Find the correct selector.
|
|
149
|
+
3. Update the script.
|
|
150
|
+
4. Re-run rehearsal.
|
|
151
|
+
5. Only proceed when every selector passes.
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## Phase 3: Record
|
|
156
|
+
|
|
157
|
+
Only after discovery and rehearsal pass should you create the recording.
|
|
158
|
+
|
|
159
|
+
### Recording Principles
|
|
160
|
+
|
|
161
|
+
#### 1. Storytelling Flow
|
|
162
|
+
|
|
163
|
+
Plan the video as a story. Follow user-specified order, or use this default:
|
|
164
|
+
|
|
165
|
+
- **Entry**: Login or navigate to the starting point
|
|
166
|
+
- **Context**: Pan the surroundings so viewers orient themselves
|
|
167
|
+
- **Action**: Perform the main workflow steps
|
|
168
|
+
- **Variation**: Show a secondary feature such as settings, theme, or localization
|
|
169
|
+
- **Result**: Show the outcome, confirmation, or new state
|
|
170
|
+
|
|
171
|
+
#### 2. Pacing
|
|
172
|
+
|
|
173
|
+
- After login: `4s`
|
|
174
|
+
- After navigation: `3s`
|
|
175
|
+
- After clicking a button: `2s`
|
|
176
|
+
- Between major steps: `1.5-2s`
|
|
177
|
+
- After the final action: `3s`
|
|
178
|
+
- Typing delay: `25-40ms` per character
|
|
179
|
+
|
|
180
|
+
#### 3. Cursor Overlay
|
|
181
|
+
|
|
182
|
+
Inject an SVG arrow cursor that follows mouse movements:
|
|
183
|
+
|
|
184
|
+
```javascript
|
|
185
|
+
async function injectCursor(page) {
|
|
186
|
+
await page.evaluate(() => {
|
|
187
|
+
if (document.getElementById('demo-cursor')) return;
|
|
188
|
+
const cursor = document.createElement('div');
|
|
189
|
+
cursor.id = 'demo-cursor';
|
|
190
|
+
cursor.innerHTML = `<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
191
|
+
<path d="M5 3L19 12L12 13L9 20L5 3Z" fill="white" stroke="black" stroke-width="1.5" stroke-linejoin="round"/>
|
|
192
|
+
</svg>`;
|
|
193
|
+
cursor.style.cssText = `
|
|
194
|
+
position: fixed; z-index: 999999; pointer-events: none;
|
|
195
|
+
width: 24px; height: 24px;
|
|
196
|
+
transition: left 0.1s, top 0.1s;
|
|
197
|
+
filter: drop-shadow(1px 1px 2px rgba(0,0,0,0.3));
|
|
198
|
+
`;
|
|
199
|
+
cursor.style.left = '0px';
|
|
200
|
+
cursor.style.top = '0px';
|
|
201
|
+
document.body.appendChild(cursor);
|
|
202
|
+
document.addEventListener('mousemove', (e) => {
|
|
203
|
+
cursor.style.left = e.clientX + 'px';
|
|
204
|
+
cursor.style.top = e.clientY + 'px';
|
|
205
|
+
});
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
Call `injectCursor(page)` after every page navigation because the overlay is destroyed on navigate.
|
|
211
|
+
|
|
212
|
+
#### 4. Mouse Movement
|
|
213
|
+
|
|
214
|
+
Never teleport the cursor. Move to the target before clicking:
|
|
215
|
+
|
|
216
|
+
```javascript
|
|
217
|
+
async function moveAndClick(page, locator, label, opts = {}) {
|
|
218
|
+
const { postClickDelay = 800, ...clickOpts } = opts;
|
|
219
|
+
const el = typeof locator === 'string' ? page.locator(locator).first() : locator;
|
|
220
|
+
const visible = await el.isVisible().catch(() => false);
|
|
221
|
+
if (!visible) {
|
|
222
|
+
console.error(`WARNING: moveAndClick skipped - "${label}" not visible`);
|
|
223
|
+
return false;
|
|
224
|
+
}
|
|
225
|
+
try {
|
|
226
|
+
await el.scrollIntoViewIfNeeded();
|
|
227
|
+
await page.waitForTimeout(300);
|
|
228
|
+
const box = await el.boundingBox();
|
|
229
|
+
if (box) {
|
|
230
|
+
await page.mouse.move(box.x + box.width / 2, box.y + box.height / 2, { steps: 10 });
|
|
231
|
+
await page.waitForTimeout(400);
|
|
232
|
+
}
|
|
233
|
+
await el.click(clickOpts);
|
|
234
|
+
} catch (e) {
|
|
235
|
+
console.error(`WARNING: moveAndClick failed on "${label}": ${e.message}`);
|
|
236
|
+
return false;
|
|
237
|
+
}
|
|
238
|
+
await page.waitForTimeout(postClickDelay);
|
|
239
|
+
return true;
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
Every call should include a descriptive `label` for debugging.
|
|
244
|
+
|
|
245
|
+
#### 5. Typing
|
|
246
|
+
|
|
247
|
+
Type visibly, not instant-fill:
|
|
248
|
+
|
|
249
|
+
```javascript
|
|
250
|
+
async function typeSlowly(page, locator, text, label, charDelay = 35) {
|
|
251
|
+
const el = typeof locator === 'string' ? page.locator(locator).first() : locator;
|
|
252
|
+
const visible = await el.isVisible().catch(() => false);
|
|
253
|
+
if (!visible) {
|
|
254
|
+
console.error(`WARNING: typeSlowly skipped - "${label}" not visible`);
|
|
255
|
+
return false;
|
|
256
|
+
}
|
|
257
|
+
await moveAndClick(page, el, label);
|
|
258
|
+
await el.fill('');
|
|
259
|
+
await el.pressSequentially(text, { delay: charDelay });
|
|
260
|
+
await page.waitForTimeout(500);
|
|
261
|
+
return true;
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
#### 6. Scrolling
|
|
266
|
+
|
|
267
|
+
Use smooth scroll instead of jumps:
|
|
268
|
+
|
|
269
|
+
```javascript
|
|
270
|
+
await page.evaluate(() => window.scrollTo({ top: 400, behavior: 'smooth' }));
|
|
271
|
+
await page.waitForTimeout(1500);
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
#### 7. Dashboard Panning
|
|
275
|
+
|
|
276
|
+
When showing a dashboard or overview page, move the cursor across key elements:
|
|
277
|
+
|
|
278
|
+
```javascript
|
|
279
|
+
async function panElements(page, selector, maxCount = 6) {
|
|
280
|
+
const elements = await page.locator(selector).all();
|
|
281
|
+
for (let i = 0; i < Math.min(elements.length, maxCount); i++) {
|
|
282
|
+
try {
|
|
283
|
+
const box = await elements[i].boundingBox();
|
|
284
|
+
if (box && box.y < 700) {
|
|
285
|
+
await page.mouse.move(box.x + box.width / 2, box.y + box.height / 2, { steps: 8 });
|
|
286
|
+
await page.waitForTimeout(600);
|
|
287
|
+
}
|
|
288
|
+
} catch (e) {
|
|
289
|
+
console.warn(`WARNING: panElements skipped element ${i} (selector: "${selector}"): ${e.message}`);
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
#### 8. Subtitles
|
|
296
|
+
|
|
297
|
+
Inject a subtitle bar at the bottom of the viewport:
|
|
298
|
+
|
|
299
|
+
```javascript
|
|
300
|
+
async function injectSubtitleBar(page) {
|
|
301
|
+
await page.evaluate(() => {
|
|
302
|
+
if (document.getElementById('demo-subtitle')) return;
|
|
303
|
+
const bar = document.createElement('div');
|
|
304
|
+
bar.id = 'demo-subtitle';
|
|
305
|
+
bar.style.cssText = `
|
|
306
|
+
position: fixed; bottom: 0; left: 0; right: 0; z-index: 999998;
|
|
307
|
+
text-align: center; padding: 12px 24px;
|
|
308
|
+
background: rgba(0, 0, 0, 0.75);
|
|
309
|
+
color: white; font-family: -apple-system, "Segoe UI", sans-serif;
|
|
310
|
+
font-size: 16px; font-weight: 500; letter-spacing: 0.3px;
|
|
311
|
+
transition: opacity 0.3s;
|
|
312
|
+
pointer-events: none;
|
|
313
|
+
`;
|
|
314
|
+
bar.textContent = '';
|
|
315
|
+
bar.style.opacity = '0';
|
|
316
|
+
document.body.appendChild(bar);
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
async function showSubtitle(page, text) {
|
|
321
|
+
await page.evaluate((t) => {
|
|
322
|
+
const bar = document.getElementById('demo-subtitle');
|
|
323
|
+
if (!bar) return;
|
|
324
|
+
if (t) {
|
|
325
|
+
bar.textContent = t;
|
|
326
|
+
bar.style.opacity = '1';
|
|
327
|
+
} else {
|
|
328
|
+
bar.style.opacity = '0';
|
|
329
|
+
}
|
|
330
|
+
}, text);
|
|
331
|
+
if (text) await page.waitForTimeout(800);
|
|
332
|
+
}
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
Call `injectSubtitleBar(page)` alongside `injectCursor(page)` after every navigation.
|
|
336
|
+
|
|
337
|
+
Usage pattern:
|
|
338
|
+
|
|
339
|
+
```javascript
|
|
340
|
+
await showSubtitle(page, 'Step 1 - Logging in');
|
|
341
|
+
await showSubtitle(page, 'Step 2 - Dashboard overview');
|
|
342
|
+
await showSubtitle(page, '');
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
Guidelines:
|
|
346
|
+
|
|
347
|
+
- Keep subtitle text short, ideally under 60 characters.
|
|
348
|
+
- Use `Step N - Action` format for consistency.
|
|
349
|
+
- Clear the subtitle during long pauses where the UI can speak for itself.
|
|
350
|
+
|
|
351
|
+
## Script Template
|
|
352
|
+
|
|
353
|
+
```javascript
|
|
354
|
+
'use strict';
|
|
355
|
+
const { chromium } = require('playwright');
|
|
356
|
+
const path = require('path');
|
|
357
|
+
const fs = require('fs');
|
|
358
|
+
|
|
359
|
+
const BASE_URL = process.env.QA_BASE_URL || 'http://localhost:3000';
|
|
360
|
+
const VIDEO_DIR = path.join(__dirname, 'screenshots');
|
|
361
|
+
const OUTPUT_NAME = 'demo-FEATURE.webm';
|
|
362
|
+
const REHEARSAL = process.argv.includes('--rehearse');
|
|
363
|
+
|
|
364
|
+
// Paste injectCursor, injectSubtitleBar, showSubtitle, moveAndClick,
|
|
365
|
+
// typeSlowly, ensureVisible, and panElements here.
|
|
366
|
+
|
|
367
|
+
(async () => {
|
|
368
|
+
const browser = await chromium.launch({ headless: true });
|
|
369
|
+
|
|
370
|
+
if (REHEARSAL) {
|
|
371
|
+
const context = await browser.newContext({ viewport: { width: 1280, height: 720 } });
|
|
372
|
+
const page = await context.newPage();
|
|
373
|
+
// Navigate through the flow and run ensureVisible for each selector.
|
|
374
|
+
await browser.close();
|
|
375
|
+
return;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
const context = await browser.newContext({
|
|
379
|
+
recordVideo: { dir: VIDEO_DIR, size: { width: 1280, height: 720 } },
|
|
380
|
+
viewport: { width: 1280, height: 720 }
|
|
381
|
+
});
|
|
382
|
+
const page = await context.newPage();
|
|
383
|
+
|
|
384
|
+
try {
|
|
385
|
+
await injectCursor(page);
|
|
386
|
+
await injectSubtitleBar(page);
|
|
387
|
+
|
|
388
|
+
await showSubtitle(page, 'Step 1 - Logging in');
|
|
389
|
+
// login actions
|
|
390
|
+
|
|
391
|
+
await page.goto(`${BASE_URL}/dashboard`);
|
|
392
|
+
await injectCursor(page);
|
|
393
|
+
await injectSubtitleBar(page);
|
|
394
|
+
await showSubtitle(page, 'Step 2 - Dashboard overview');
|
|
395
|
+
// pan dashboard
|
|
396
|
+
|
|
397
|
+
await showSubtitle(page, 'Step 3 - Main workflow');
|
|
398
|
+
// action sequence
|
|
399
|
+
|
|
400
|
+
await showSubtitle(page, 'Step 4 - Result');
|
|
401
|
+
// final reveal
|
|
402
|
+
await showSubtitle(page, '');
|
|
403
|
+
} catch (err) {
|
|
404
|
+
console.error('DEMO ERROR:', err.message);
|
|
405
|
+
} finally {
|
|
406
|
+
await context.close();
|
|
407
|
+
const video = page.video();
|
|
408
|
+
if (video) {
|
|
409
|
+
const src = await video.path();
|
|
410
|
+
const dest = path.join(VIDEO_DIR, OUTPUT_NAME);
|
|
411
|
+
try {
|
|
412
|
+
fs.copyFileSync(src, dest);
|
|
413
|
+
console.log('Video saved:', dest);
|
|
414
|
+
} catch (e) {
|
|
415
|
+
console.error('ERROR: Failed to copy video:', e.message);
|
|
416
|
+
console.error(' Source:', src);
|
|
417
|
+
console.error(' Destination:', dest);
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
await browser.close();
|
|
421
|
+
}
|
|
422
|
+
})();
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
Usage:
|
|
426
|
+
|
|
427
|
+
```bash
|
|
428
|
+
# Phase 2: Rehearse
|
|
429
|
+
node demo-script.cjs --rehearse
|
|
430
|
+
|
|
431
|
+
# Phase 3: Record
|
|
432
|
+
node demo-script.cjs
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
## Checklist Before Recording
|
|
436
|
+
|
|
437
|
+
- [ ] Discovery phase completed
|
|
438
|
+
- [ ] Rehearsal passes with all selectors OK
|
|
439
|
+
- [ ] Headless mode enabled
|
|
440
|
+
- [ ] Resolution set to `1280x720`
|
|
441
|
+
- [ ] Cursor and subtitle overlays re-injected after every navigation
|
|
442
|
+
- [ ] `showSubtitle(page, 'Step N - ...')` used at major transitions
|
|
443
|
+
- [ ] `moveAndClick` used for all clicks with descriptive labels
|
|
444
|
+
- [ ] `typeSlowly` used for visible input
|
|
445
|
+
- [ ] No silent catches; helpers log warnings
|
|
446
|
+
- [ ] Smooth scrolling used for content reveal
|
|
447
|
+
- [ ] Key pauses are visible to a human viewer
|
|
448
|
+
- [ ] Flow matches the requested story order
|
|
449
|
+
- [ ] Script reflects the actual UI discovered in phase 1
|
|
450
|
+
|
|
451
|
+
## Common Pitfalls
|
|
452
|
+
|
|
453
|
+
1. Cursor disappears after navigation - re-inject it.
|
|
454
|
+
2. Video is too fast - add pauses.
|
|
455
|
+
3. Cursor is a dot instead of an arrow - use the SVG overlay.
|
|
456
|
+
4. Cursor teleports - move before clicking.
|
|
457
|
+
5. Select dropdowns look wrong - show the move, then pick the option.
|
|
458
|
+
6. Modals feel abrupt - add a read pause before confirming.
|
|
459
|
+
7. Video file path is random - copy it to a stable output name.
|
|
460
|
+
8. Selector failures are swallowed - never use silent catch blocks.
|
|
461
|
+
9. Field types were assumed - discover them first.
|
|
462
|
+
10. Features were assumed - inspect the actual UI before scripting.
|
|
463
|
+
11. Placeholder select values look real - watch for `"0"` and `"Select..."`.
|
|
464
|
+
12. Popups create separate videos - capture popup pages explicitly and merge later if needed.
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ui-to-vue
|
|
3
|
+
description: Use when the user has UI screenshots or design exports that need batch conversion into Vue 3 components, especially with Vant, Element Plus, or Ant Design Vue.
|
|
4
|
+
origin: community
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# UI To Vue
|
|
8
|
+
|
|
9
|
+
Batch-convert UI design screenshots into Vue 3 Composition API component code.
|
|
10
|
+
|
|
11
|
+
## When to Use
|
|
12
|
+
|
|
13
|
+
- The user provides a directory of design screenshots or design-export images.
|
|
14
|
+
- The target application is Vue 3.
|
|
15
|
+
- The user wants a first pass of page components, shared components, and router wiring.
|
|
16
|
+
- The user specifies Vant, Element Plus, or Ant Design Vue as the component library.
|
|
17
|
+
|
|
18
|
+
## When Not to Use
|
|
19
|
+
|
|
20
|
+
- The user has only one screenshot and wants a bespoke component.
|
|
21
|
+
- The target project is not Vue.
|
|
22
|
+
- The design requires detailed interaction logic, data flow, or accessibility review.
|
|
23
|
+
- The screenshots contain private customer data that cannot be sent to an external model API.
|
|
24
|
+
|
|
25
|
+
## Inputs
|
|
26
|
+
|
|
27
|
+
Use an input directory that groups screenshots by module and page state:
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
screenshots/
|
|
31
|
+
|-- HomePage/
|
|
32
|
+
| |-- List/
|
|
33
|
+
| | |-- HomePage-List-Default@3x.png
|
|
34
|
+
| | `-- cut-images/
|
|
35
|
+
| |-- cut-images/
|
|
36
|
+
| `-- HomePage-Default@3x.png
|
|
37
|
+
`-- cut-images/
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Supported cut-image directory names include `assets`, `icons`, `sprites`, `cut`, `images`, and `cut-images`.
|
|
41
|
+
|
|
42
|
+
## Conversion Model
|
|
43
|
+
|
|
44
|
+
- Page grouping: combine related screenshots into one page component when they represent list, detail, form, loading, or empty states.
|
|
45
|
+
- UI library mapping: map native visual elements to Vant, Element Plus, or Ant Design Vue components where practical.
|
|
46
|
+
- Cut-image priority: prefer page-level assets, then module-level assets, then global shared assets.
|
|
47
|
+
- Component extraction: extract repeated UI regions into shared components when they appear more than once.
|
|
48
|
+
|
|
49
|
+
## CLI Usage
|
|
50
|
+
|
|
51
|
+
Run the converter with `npx` so the documented command works without relying on a global binary:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
export DASHSCOPE_API_KEY=your_key
|
|
55
|
+
npx ui-to-vue-converter@1.0.2 --input ./screenshots --ui vant --output ./src
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
For desktop UI libraries:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npx ui-to-vue-converter@1.0.2 --input ./designs --ui element-plus --output ./src
|
|
62
|
+
npx ui-to-vue-converter@1.0.2 --input ./designs --ui antd-vue --output ./src
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
If the package is installed globally, the `ui-to-vue` binary can be used directly:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm install -g ui-to-vue-converter@1.0.2
|
|
69
|
+
ui-to-vue --input ./screenshots --ui vant --output ./src
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Options
|
|
73
|
+
|
|
74
|
+
| Option | Description | Default |
|
|
75
|
+
| --- | --- | --- |
|
|
76
|
+
| `--input` | Design image directory | `./screenshots` |
|
|
77
|
+
| `--ui` | UI library: `vant`, `element-plus`, or `antd-vue` | `vant` |
|
|
78
|
+
| `--output` | Output directory | `./src` |
|
|
79
|
+
| `--config` | Config file path | `./.ui-to-vue.config.json` |
|
|
80
|
+
|
|
81
|
+
## API Key Handling
|
|
82
|
+
|
|
83
|
+
The converter can read DashScope credentials from a config file or from the environment. Prefer an environment variable in repositories:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
export DASHSCOPE_API_KEY=your_key
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
If a local config file is required, keep it out of version control:
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"apiKey": "your_dashscope_key",
|
|
94
|
+
"input": "./designs",
|
|
95
|
+
"ui": "vant",
|
|
96
|
+
"output": "./src"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
```gitignore
|
|
101
|
+
.ui-to-vue.config.json
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Security and Privacy
|
|
105
|
+
|
|
106
|
+
- Treat design screenshots as source material that may be sent to an external model API.
|
|
107
|
+
- Do not run this flow on private customer designs without permission.
|
|
108
|
+
- Pin the converter version in repeatable workflows instead of using `@latest`.
|
|
109
|
+
- Review generated Vue code before committing it.
|
|
110
|
+
- Do not commit `.ui-to-vue.config.json`, API keys, generated secrets, or customer screenshots.
|
|
111
|
+
|
|
112
|
+
## Output Review Checklist
|
|
113
|
+
|
|
114
|
+
- [ ] Page components were generated under `views/` or the chosen output directory.
|
|
115
|
+
- [ ] Repeated UI regions were extracted into `components/` only when reuse is clear.
|
|
116
|
+
- [ ] Router output is compatible with the target project's router style.
|
|
117
|
+
- [ ] Generated components use the requested UI library consistently.
|
|
118
|
+
- [ ] Generated CSS units match the design baseline.
|
|
119
|
+
- [ ] The code passes the project's formatter, linter, type checker, and build.
|
|
120
|
+
- [ ] Placeholder copy, mock data, and generated assets were reviewed before commit.
|
|
121
|
+
|
|
122
|
+
## Troubleshooting
|
|
123
|
+
|
|
124
|
+
| Issue | Check |
|
|
125
|
+
| --- | --- |
|
|
126
|
+
| `401` or authentication error | Confirm `DASHSCOPE_API_KEY` is set in the shell running the command. |
|
|
127
|
+
| `command not found: ui-to-vue` | Use the `npx ui-to-vue-converter@1.0.2` form or install the package globally. |
|
|
128
|
+
| Cut images are ignored | Confirm the asset directory name is supported and nested under the matching page or module. |
|
|
129
|
+
| Components ignore the requested UI library | Re-run with an explicit `--ui` value and inspect the generated imports. |
|
|
130
|
+
| Generated layout dimensions look wrong | Confirm the screenshot export width matches the target library baseline. |
|
|
131
|
+
|
|
132
|
+
## References
|
|
133
|
+
|
|
134
|
+
- npm package: `ui-to-vue-converter`
|