@musashishao/agent-kit 1.2.2
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/.agent/agents/backend-specialist.md +263 -0
- package/.agent/agents/database-architect.md +226 -0
- package/.agent/agents/debugger.md +225 -0
- package/.agent/agents/devops-engineer.md +242 -0
- package/.agent/agents/documentation-writer.md +104 -0
- package/.agent/agents/explorer-agent.md +73 -0
- package/.agent/agents/frontend-specialist.md +556 -0
- package/.agent/agents/game-developer.md +162 -0
- package/.agent/agents/mobile-developer.md +377 -0
- package/.agent/agents/orchestrator.md +416 -0
- package/.agent/agents/penetration-tester.md +188 -0
- package/.agent/agents/performance-optimizer.md +187 -0
- package/.agent/agents/project-planner.md +403 -0
- package/.agent/agents/security-auditor.md +170 -0
- package/.agent/agents/seo-specialist.md +111 -0
- package/.agent/agents/test-engineer.md +158 -0
- package/.agent/mcp/README.md +69 -0
- package/.agent/mcp/config/mcp-config.json +62 -0
- package/.agent/mcp/config/registry.json +54 -0
- package/.agent/mcp/servers/agent-kit-core/package.json +28 -0
- package/.agent/mcp/servers/agent-kit-core/src/index.ts +455 -0
- package/.agent/mcp/servers/agent-kit-core/tsconfig.json +16 -0
- package/.agent/mcp/servers/agent-kit-fs/package.json +25 -0
- package/.agent/mcp/servers/agent-kit-fs/src/index.ts +399 -0
- package/.agent/mcp/servers/agent-kit-fs/tsconfig.json +16 -0
- package/.agent/mcp/servers/agent-kit-git/package.json +24 -0
- package/.agent/mcp/servers/agent-kit-git/src/index.ts +283 -0
- package/.agent/mcp/servers/agent-kit-git/tsconfig.json +16 -0
- package/.agent/mcp/templates/README.md +49 -0
- package/.agent/mcp/templates/api/README.md.template +45 -0
- package/.agent/mcp/templates/api/src/index.ts.template +185 -0
- package/.agent/mcp/templates/base-package.json.template +27 -0
- package/.agent/mcp/templates/base-tsconfig.json +21 -0
- package/.agent/mcp/templates/custom/src/index.ts.template +133 -0
- package/.agent/mcp/templates/database/src/index.ts.template +273 -0
- package/.agent/mcp/templates/web-scraper/src/index.ts.template +239 -0
- package/.agent/rules/CODEX.md +250 -0
- package/.agent/rules/GEMINI.md +251 -0
- package/.agent/skills/api-patterns/SKILL.md +81 -0
- package/.agent/skills/api-patterns/api-style.md +42 -0
- package/.agent/skills/api-patterns/auth.md +24 -0
- package/.agent/skills/api-patterns/documentation.md +26 -0
- package/.agent/skills/api-patterns/graphql.md +41 -0
- package/.agent/skills/api-patterns/rate-limiting.md +31 -0
- package/.agent/skills/api-patterns/response.md +37 -0
- package/.agent/skills/api-patterns/rest.md +40 -0
- package/.agent/skills/api-patterns/scripts/api_validator.py +211 -0
- package/.agent/skills/api-patterns/security-testing.md +122 -0
- package/.agent/skills/api-patterns/trpc.md +41 -0
- package/.agent/skills/api-patterns/versioning.md +22 -0
- package/.agent/skills/app-builder/SKILL.md +75 -0
- package/.agent/skills/app-builder/agent-coordination.md +71 -0
- package/.agent/skills/app-builder/feature-building.md +53 -0
- package/.agent/skills/app-builder/project-detection.md +34 -0
- package/.agent/skills/app-builder/scaffolding.md +118 -0
- package/.agent/skills/app-builder/tech-stack.md +40 -0
- package/.agent/skills/app-builder/templates/SKILL.md +39 -0
- package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +82 -0
- package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +100 -0
- package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +106 -0
- package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +101 -0
- package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +93 -0
- package/.agent/skills/architecture/SKILL.md +55 -0
- package/.agent/skills/architecture/context-discovery.md +43 -0
- package/.agent/skills/architecture/examples.md +94 -0
- package/.agent/skills/architecture/pattern-selection.md +68 -0
- package/.agent/skills/architecture/patterns-reference.md +50 -0
- package/.agent/skills/architecture/trade-off-analysis.md +77 -0
- package/.agent/skills/bash-linux/SKILL.md +199 -0
- package/.agent/skills/behavioral-modes/SKILL.md +242 -0
- package/.agent/skills/brainstorming/SKILL.md +163 -0
- package/.agent/skills/brainstorming/dynamic-questioning.md +350 -0
- package/.agent/skills/clean-code/SKILL.md +201 -0
- package/.agent/skills/code-review-checklist/SKILL.md +109 -0
- package/.agent/skills/context-engineering/SKILL.md +74 -0
- package/.agent/skills/context-engineering/examples/advanced_code_request.md +73 -0
- package/.agent/skills/context-engineering/scripts/quality_validator.py +294 -0
- package/.agent/skills/context-engineering/scripts/repo_mapper.py +27 -0
- package/.agent/skills/context-engineering/scripts/skill_checker.py +194 -0
- package/.agent/skills/context-engineering/scripts/token_counter.py +65 -0
- package/.agent/skills/context-engineering/strategies/context-caching.md +50 -0
- package/.agent/skills/context-engineering/strategies/few-shot-examples.md +56 -0
- package/.agent/skills/context-engineering/strategies/skeleton-code.md +59 -0
- package/.agent/skills/context-engineering/strategies/xml-framing.md +57 -0
- package/.agent/skills/database-design/SKILL.md +52 -0
- package/.agent/skills/database-design/database-selection.md +43 -0
- package/.agent/skills/database-design/indexing.md +39 -0
- package/.agent/skills/database-design/migrations.md +48 -0
- package/.agent/skills/database-design/optimization.md +36 -0
- package/.agent/skills/database-design/orm-selection.md +30 -0
- package/.agent/skills/database-design/schema-design.md +56 -0
- package/.agent/skills/database-design/scripts/schema_validator.py +172 -0
- package/.agent/skills/deployment-procedures/SKILL.md +241 -0
- package/.agent/skills/doc.md +177 -0
- package/.agent/skills/docker-expert/SKILL.md +409 -0
- package/.agent/skills/documentation-templates/SKILL.md +194 -0
- package/.agent/skills/frontend-design/SKILL.md +396 -0
- package/.agent/skills/frontend-design/animation-guide.md +331 -0
- package/.agent/skills/frontend-design/color-system.md +311 -0
- package/.agent/skills/frontend-design/decision-trees.md +418 -0
- package/.agent/skills/frontend-design/motion-graphics.md +306 -0
- package/.agent/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/.agent/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/.agent/skills/frontend-design/typography-system.md +345 -0
- package/.agent/skills/frontend-design/ux-psychology.md +541 -0
- package/.agent/skills/frontend-design/visual-effects.md +383 -0
- package/.agent/skills/game-development/2d-games/SKILL.md +119 -0
- package/.agent/skills/game-development/3d-games/SKILL.md +135 -0
- package/.agent/skills/game-development/SKILL.md +167 -0
- package/.agent/skills/game-development/game-art/SKILL.md +185 -0
- package/.agent/skills/game-development/game-audio/SKILL.md +190 -0
- package/.agent/skills/game-development/game-design/SKILL.md +129 -0
- package/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
- package/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
- package/.agent/skills/game-development/pc-games/SKILL.md +144 -0
- package/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
- package/.agent/skills/game-development/web-games/SKILL.md +150 -0
- package/.agent/skills/geo-fundamentals/SKILL.md +156 -0
- package/.agent/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/.agent/skills/i18n-localization/SKILL.md +154 -0
- package/.agent/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/.agent/skills/lint-and-validate/SKILL.md +45 -0
- package/.agent/skills/lint-and-validate/scripts/lint_runner.py +172 -0
- package/.agent/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/.agent/skills/mcp-builder/SKILL.md +662 -0
- package/.agent/skills/mcp-builder/python-template.md +522 -0
- package/.agent/skills/mcp-builder/tool-patterns.md +642 -0
- package/.agent/skills/mcp-builder/typescript-template.md +361 -0
- package/.agent/skills/mobile-design/SKILL.md +394 -0
- package/.agent/skills/mobile-design/decision-trees.md +516 -0
- package/.agent/skills/mobile-design/mobile-backend.md +491 -0
- package/.agent/skills/mobile-design/mobile-color-system.md +420 -0
- package/.agent/skills/mobile-design/mobile-debugging.md +122 -0
- package/.agent/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/.agent/skills/mobile-design/mobile-navigation.md +458 -0
- package/.agent/skills/mobile-design/mobile-performance.md +767 -0
- package/.agent/skills/mobile-design/mobile-testing.md +356 -0
- package/.agent/skills/mobile-design/mobile-typography.md +433 -0
- package/.agent/skills/mobile-design/platform-android.md +666 -0
- package/.agent/skills/mobile-design/platform-ios.md +561 -0
- package/.agent/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/.agent/skills/mobile-design/touch-psychology.md +537 -0
- package/.agent/skills/nestjs-expert/SKILL.md +552 -0
- package/.agent/skills/nextjs-best-practices/SKILL.md +203 -0
- package/.agent/skills/nodejs-best-practices/SKILL.md +333 -0
- package/.agent/skills/parallel-agents/SKILL.md +175 -0
- package/.agent/skills/performance-profiling/SKILL.md +143 -0
- package/.agent/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/.agent/skills/plan-writing/SKILL.md +152 -0
- package/.agent/skills/powershell-windows/SKILL.md +167 -0
- package/.agent/skills/prisma-expert/SKILL.md +355 -0
- package/.agent/skills/problem-solving/SKILL.md +556 -0
- package/.agent/skills/problem-solving/collision-zone-thinking.md +285 -0
- package/.agent/skills/problem-solving/inversion-exercise.md +205 -0
- package/.agent/skills/problem-solving/meta-pattern-recognition.md +313 -0
- package/.agent/skills/problem-solving/scale-game.md +300 -0
- package/.agent/skills/problem-solving/simplification-cascades.md +321 -0
- package/.agent/skills/problem-solving/when-stuck.md +146 -0
- package/.agent/skills/python-patterns/SKILL.md +441 -0
- package/.agent/skills/react-patterns/SKILL.md +198 -0
- package/.agent/skills/red-team-tactics/SKILL.md +199 -0
- package/.agent/skills/seo-fundamentals/SKILL.md +129 -0
- package/.agent/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/.agent/skills/server-management/SKILL.md +161 -0
- package/.agent/skills/systematic-debugging/SKILL.md +109 -0
- package/.agent/skills/tailwind-patterns/SKILL.md +269 -0
- package/.agent/skills/tdd-workflow/SKILL.md +149 -0
- package/.agent/skills/testing-patterns/SKILL.md +178 -0
- package/.agent/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/.agent/skills/typescript-expert/SKILL.md +429 -0
- package/.agent/skills/typescript-expert/references/tsconfig-strict.json +92 -0
- package/.agent/skills/typescript-expert/references/typescript-cheatsheet.md +383 -0
- package/.agent/skills/typescript-expert/references/utility-types.ts +335 -0
- package/.agent/skills/typescript-expert/scripts/ts_diagnostic.py +203 -0
- package/.agent/skills/ui-ux-pro-max/SKILL.md +351 -0
- package/.agent/skills/ui-ux-pro-max/data/charts.csv +26 -0
- package/.agent/skills/ui-ux-pro-max/data/colors.csv +97 -0
- package/.agent/skills/ui-ux-pro-max/data/icons.csv +101 -0
- package/.agent/skills/ui-ux-pro-max/data/landing.csv +31 -0
- package/.agent/skills/ui-ux-pro-max/data/products.csv +97 -0
- package/.agent/skills/ui-ux-pro-max/data/prompts.csv +24 -0
- package/.agent/skills/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/.agent/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/.agent/skills/ui-ux-pro-max/data/styles.csv +59 -0
- package/.agent/skills/ui-ux-pro-max/data/typography.csv +58 -0
- package/.agent/skills/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/.agent/skills/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/.agent/skills/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/.agent/skills/ui-ux-pro-max/scripts/core.py +257 -0
- package/.agent/skills/ui-ux-pro-max/scripts/design_system.py +487 -0
- package/.agent/skills/ui-ux-pro-max/scripts/search.py +76 -0
- package/.agent/skills/vulnerability-scanner/SKILL.md +276 -0
- package/.agent/skills/vulnerability-scanner/checklists.md +121 -0
- package/.agent/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/.agent/skills/webapp-testing/SKILL.md +187 -0
- package/.agent/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/.agent/templates/AGENTS.backend.md +230 -0
- package/.agent/templates/AGENTS.md +121 -0
- package/.agent/templates/AGENTS.mobile.md +183 -0
- package/.agent/templates/AGENTS.web.md +192 -0
- package/.agent/workflows/brainstorm.md +113 -0
- package/.agent/workflows/context.md +47 -0
- package/.agent/workflows/create.md +59 -0
- package/.agent/workflows/debug.md +103 -0
- package/.agent/workflows/deploy.md +176 -0
- package/.agent/workflows/enhance.md +63 -0
- package/.agent/workflows/orchestrate.md +237 -0
- package/.agent/workflows/plan.md +89 -0
- package/.agent/workflows/preview.md +80 -0
- package/.agent/workflows/quality.md +89 -0
- package/.agent/workflows/status.md +86 -0
- package/.agent/workflows/test.md +144 -0
- package/.agent/workflows/ui-ux-pro-max.md +250 -0
- package/LICENSE +21 -0
- package/README.md +317 -0
- package/bin/cli.js +1267 -0
- package/index.js +1 -0
- package/package.json +50 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Test generation and test running command. Creates and executes tests for code.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /test - Test Generation and Execution
|
|
6
|
+
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
|
|
13
|
+
This command generates tests, runs existing tests, or checks test coverage.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Sub-commands
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
/test - Run all tests
|
|
21
|
+
/test [file/feature] - Generate tests for specific target
|
|
22
|
+
/test coverage - Show test coverage report
|
|
23
|
+
/test watch - Run tests in watch mode
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Behavior
|
|
29
|
+
|
|
30
|
+
### Generate Tests
|
|
31
|
+
|
|
32
|
+
When asked to test a file or feature:
|
|
33
|
+
|
|
34
|
+
1. **Analyze the code**
|
|
35
|
+
- Identify functions and methods
|
|
36
|
+
- Find edge cases
|
|
37
|
+
- Detect dependencies to mock
|
|
38
|
+
|
|
39
|
+
2. **Generate test cases**
|
|
40
|
+
- Happy path tests
|
|
41
|
+
- Error cases
|
|
42
|
+
- Edge cases
|
|
43
|
+
- Integration tests (if needed)
|
|
44
|
+
|
|
45
|
+
3. **Write tests**
|
|
46
|
+
- Use project's test framework (Jest, Vitest, etc.)
|
|
47
|
+
- Follow existing test patterns
|
|
48
|
+
- Mock external dependencies
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Output Format
|
|
53
|
+
|
|
54
|
+
### For Test Generation
|
|
55
|
+
|
|
56
|
+
```markdown
|
|
57
|
+
## 🧪 Tests: [Target]
|
|
58
|
+
|
|
59
|
+
### Test Plan
|
|
60
|
+
| Test Case | Type | Coverage |
|
|
61
|
+
|-----------|------|----------|
|
|
62
|
+
| Should create user | Unit | Happy path |
|
|
63
|
+
| Should reject invalid email | Unit | Validation |
|
|
64
|
+
| Should handle db error | Unit | Error case |
|
|
65
|
+
|
|
66
|
+
### Generated Tests
|
|
67
|
+
|
|
68
|
+
`tests/[file].test.ts`
|
|
69
|
+
|
|
70
|
+
[Code block with tests]
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
Run with: `npm test`
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### For Test Execution
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
🧪 Running tests...
|
|
81
|
+
|
|
82
|
+
✅ auth.test.ts (5 passed)
|
|
83
|
+
✅ user.test.ts (8 passed)
|
|
84
|
+
❌ order.test.ts (2 passed, 1 failed)
|
|
85
|
+
|
|
86
|
+
Failed:
|
|
87
|
+
✗ should calculate total with discount
|
|
88
|
+
Expected: 90
|
|
89
|
+
Received: 100
|
|
90
|
+
|
|
91
|
+
Total: 15 tests (14 passed, 1 failed)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Examples
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
/test src/services/auth.service.ts
|
|
100
|
+
/test user registration flow
|
|
101
|
+
/test coverage
|
|
102
|
+
/test fix failed tests
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## Test Patterns
|
|
108
|
+
|
|
109
|
+
### Unit Test Structure
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
describe('AuthService', () => {
|
|
113
|
+
describe('login', () => {
|
|
114
|
+
it('should return token for valid credentials', async () => {
|
|
115
|
+
// Arrange
|
|
116
|
+
const credentials = { email: 'test@test.com', password: 'pass123' };
|
|
117
|
+
|
|
118
|
+
// Act
|
|
119
|
+
const result = await authService.login(credentials);
|
|
120
|
+
|
|
121
|
+
// Assert
|
|
122
|
+
expect(result.token).toBeDefined();
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it('should throw for invalid password', async () => {
|
|
126
|
+
// Arrange
|
|
127
|
+
const credentials = { email: 'test@test.com', password: 'wrong' };
|
|
128
|
+
|
|
129
|
+
// Act & Assert
|
|
130
|
+
await expect(authService.login(credentials)).rejects.toThrow('Invalid credentials');
|
|
131
|
+
});
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## Key Principles
|
|
139
|
+
|
|
140
|
+
- **Test behavior not implementation**
|
|
141
|
+
- **One assertion per test** (when practical)
|
|
142
|
+
- **Descriptive test names**
|
|
143
|
+
- **Arrange-Act-Assert pattern**
|
|
144
|
+
- **Mock external dependencies**
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Plan and implement UI
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# UI/UX Pro Max - Design Intelligence
|
|
6
|
+
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## ⚠️ MANDATORY: Before Starting (Socratic Gate)
|
|
12
|
+
|
|
13
|
+
**DO NOT execute any search commands until you understand the user's requirements.**
|
|
14
|
+
|
|
15
|
+
If the user only typed `/ui-ux-pro-max` without additional context, you MUST ask:
|
|
16
|
+
|
|
17
|
+
1. **What are you building?** (landing page, dashboard, e-commerce, SaaS, mobile app, etc.)
|
|
18
|
+
2. **What industry/domain?** (healthcare, fintech, beauty, gaming, education, etc.)
|
|
19
|
+
3. **Any style preferences?** (minimal, dark mode, playful, professional, glassmorphism, etc.)
|
|
20
|
+
4. **What tech stack?** (html-tailwind, React, Next.js, Vue, or other)
|
|
21
|
+
|
|
22
|
+
**Only proceed to Step 1 after receiving answers.**
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
Searchable database of UI styles, color palettes, font pairings, chart types, product recommendations, UX guidelines, and stack-specific best practices.
|
|
27
|
+
|
|
28
|
+
## Prerequisites
|
|
29
|
+
|
|
30
|
+
Check if Python is installed:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
python3 --version || python --version
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
If Python is not installed, install it based on user's OS:
|
|
37
|
+
|
|
38
|
+
**macOS:**
|
|
39
|
+
```bash
|
|
40
|
+
brew install python3
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Ubuntu/Debian:**
|
|
44
|
+
```bash
|
|
45
|
+
sudo apt update && sudo apt install python3
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Windows:**
|
|
49
|
+
```powershell
|
|
50
|
+
winget install Python.Python.3.12
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## How to Use This Workflow
|
|
56
|
+
|
|
57
|
+
When user requests UI/UX work (design, build, create, implement, review, fix, improve), follow this workflow:
|
|
58
|
+
|
|
59
|
+
### Step 1: Analyze User Requirements
|
|
60
|
+
|
|
61
|
+
Extract key information from user request:
|
|
62
|
+
- **Product type**: SaaS, e-commerce, portfolio, dashboard, landing page, etc.
|
|
63
|
+
- **Style keywords**: minimal, playful, professional, elegant, dark mode, etc.
|
|
64
|
+
- **Industry**: healthcare, fintech, gaming, education, etc.
|
|
65
|
+
- **Stack**: React, Vue, Next.js, or default to `html-tailwind`
|
|
66
|
+
|
|
67
|
+
### Step 2: Search Relevant Domains
|
|
68
|
+
|
|
69
|
+
Use `search.py` multiple times to gather comprehensive information. Search until you have enough context.
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "<keyword>" --domain <domain> [-n <max_results>]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Recommended search order:**
|
|
76
|
+
|
|
77
|
+
1. **Product** - Get style recommendations for product type
|
|
78
|
+
2. **Style** - Get detailed style guide (colors, effects, frameworks)
|
|
79
|
+
3. **Typography** - Get font pairings with Google Fonts imports
|
|
80
|
+
4. **Color** - Get color palette (Primary, Secondary, CTA, Background, Text, Border)
|
|
81
|
+
5. **Landing** - Get page structure (if landing page)
|
|
82
|
+
6. **Chart** - Get chart recommendations (if dashboard/analytics)
|
|
83
|
+
7. **UX** - Get best practices and anti-patterns
|
|
84
|
+
8. **Stack** - Get stack-specific guidelines (default: html-tailwind)
|
|
85
|
+
|
|
86
|
+
### Step 3: Stack Guidelines (Default: html-tailwind)
|
|
87
|
+
|
|
88
|
+
If user doesn't specify a stack, **default to `html-tailwind`**.
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "<keyword>" --stack html-tailwind
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Available stacks: `html-tailwind`, `react`, `nextjs`, `vue`, `svelte`, `swiftui`, `react-native`, `flutter`, `shadcn`
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Search Reference
|
|
99
|
+
|
|
100
|
+
### Available Domains
|
|
101
|
+
|
|
102
|
+
| Domain | Use For | Example Keywords |
|
|
103
|
+
|--------|---------|------------------|
|
|
104
|
+
| `product` | Product type recommendations | SaaS, e-commerce, portfolio, healthcare, beauty, service |
|
|
105
|
+
| `style` | UI styles, colors, effects | glassmorphism, minimalism, dark mode, brutalism |
|
|
106
|
+
| `typography` | Font pairings, Google Fonts | elegant, playful, professional, modern |
|
|
107
|
+
| `color` | Color palettes by product type | saas, ecommerce, healthcare, beauty, fintech, service |
|
|
108
|
+
| `landing` | Page structure, CTA strategies | hero, hero-centric, testimonial, pricing, social-proof |
|
|
109
|
+
| `chart` | Chart types, library recommendations | trend, comparison, timeline, funnel, pie |
|
|
110
|
+
| `ux` | Best practices, anti-patterns | animation, accessibility, z-index, loading |
|
|
111
|
+
| `prompt` | AI prompts, CSS keywords | (style name) |
|
|
112
|
+
|
|
113
|
+
### Available Stacks
|
|
114
|
+
|
|
115
|
+
| Stack | Focus |
|
|
116
|
+
|-------|-------|
|
|
117
|
+
| `html-tailwind` | Tailwind utilities, responsive, a11y (DEFAULT) |
|
|
118
|
+
| `react` | State, hooks, performance, patterns |
|
|
119
|
+
| `nextjs` | SSR, routing, images, API routes |
|
|
120
|
+
| `vue` | Composition API, Pinia, Vue Router |
|
|
121
|
+
| `svelte` | Runes, stores, SvelteKit |
|
|
122
|
+
| `swiftui` | Views, State, Navigation, Animation |
|
|
123
|
+
| `react-native` | Components, Navigation, Lists |
|
|
124
|
+
| `flutter` | Widgets, State, Layout, Theming |
|
|
125
|
+
| `shadcn` | shadcn/ui components, theming, forms, patterns |
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Example Workflow
|
|
130
|
+
|
|
131
|
+
**User request:** "Làm landing page cho dịch vụ chăm sóc da chuyên nghiệp"
|
|
132
|
+
|
|
133
|
+
**AI should:**
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# 1. Search product type
|
|
137
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "beauty spa wellness service" --domain product
|
|
138
|
+
|
|
139
|
+
# 2. Search style (based on industry: beauty, elegant)
|
|
140
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "elegant minimal soft" --domain style
|
|
141
|
+
|
|
142
|
+
# 3. Search typography
|
|
143
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "elegant luxury" --domain typography
|
|
144
|
+
|
|
145
|
+
# 4. Search color palette
|
|
146
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "beauty spa wellness" --domain color
|
|
147
|
+
|
|
148
|
+
# 5. Search landing page structure
|
|
149
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "hero-centric social-proof" --domain landing
|
|
150
|
+
|
|
151
|
+
# 6. Search UX guidelines
|
|
152
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "animation" --domain ux
|
|
153
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "accessibility" --domain ux
|
|
154
|
+
|
|
155
|
+
# 7. Search stack guidelines (default: html-tailwind)
|
|
156
|
+
python3 .shared/ui-ux-pro-max/scripts/search.py "layout responsive" --stack html-tailwind
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
**Then:** Synthesize all search results and implement the design.
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Tips for Better Results
|
|
164
|
+
|
|
165
|
+
1. **Be specific with keywords** - "healthcare SaaS dashboard" > "app"
|
|
166
|
+
2. **Search multiple times** - Different keywords reveal different insights
|
|
167
|
+
3. **Combine domains** - Style + Typography + Color = Complete design system
|
|
168
|
+
4. **Always check UX** - Search "animation", "z-index", "accessibility" for common issues
|
|
169
|
+
5. **Use stack flag** - Get implementation-specific best practices
|
|
170
|
+
6. **Iterate** - If first search doesn't match, try different keywords
|
|
171
|
+
7. **Split Into Multiple Files** - For better maintainability:
|
|
172
|
+
- Separate components into individual files (e.g., `Header.tsx`, `Footer.tsx`)
|
|
173
|
+
- Extract reusable styles into dedicated files
|
|
174
|
+
- Keep each file focused and under 200-300 lines
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## Common Rules for Professional UI
|
|
179
|
+
|
|
180
|
+
These are frequently overlooked issues that make UI look unprofessional:
|
|
181
|
+
|
|
182
|
+
### Icons & Visual Elements
|
|
183
|
+
|
|
184
|
+
| Rule | Do | Don't |
|
|
185
|
+
|------|----|----- |
|
|
186
|
+
| **No emoji icons** | Use SVG icons (Heroicons, Lucide, Simple Icons) | Use emojis like 🎨 🚀 ⚙️ as UI icons |
|
|
187
|
+
| **Stable hover states** | Use color/opacity transitions on hover | Use scale transforms that shift layout |
|
|
188
|
+
| **Correct brand logos** | Research official SVG from Simple Icons | Guess or use incorrect logo paths |
|
|
189
|
+
| **Consistent icon sizing** | Use fixed viewBox (24x24) with w-6 h-6 | Mix different icon sizes randomly |
|
|
190
|
+
|
|
191
|
+
### Interaction & Cursor
|
|
192
|
+
|
|
193
|
+
| Rule | Do | Don't |
|
|
194
|
+
|------|----|----- |
|
|
195
|
+
| **Cursor pointer** | Add `cursor-pointer` to all clickable/hoverable cards | Leave default cursor on interactive elements |
|
|
196
|
+
| **Hover feedback** | Provide visual feedback (color, shadow, border) | No indication element is interactive |
|
|
197
|
+
| **Smooth transitions** | Use `transition-colors duration-200` | Instant state changes or too slow (>500ms) |
|
|
198
|
+
|
|
199
|
+
### Light/Dark Mode Contrast
|
|
200
|
+
|
|
201
|
+
| Rule | Do | Don't |
|
|
202
|
+
|------|----|----- |
|
|
203
|
+
| **Glass card light mode** | Use `bg-white/80` or higher opacity | Use `bg-white/10` (too transparent) |
|
|
204
|
+
| **Text contrast light** | Use `#0F172A` (slate-900) for text | Use `#94A3B8` (slate-400) for body text |
|
|
205
|
+
| **Muted text light** | Use `#475569` (slate-600) minimum | Use gray-400 or lighter |
|
|
206
|
+
| **Border visibility** | Use `border-gray-200` in light mode | Use `border-white/10` (invisible) |
|
|
207
|
+
|
|
208
|
+
### Layout & Spacing
|
|
209
|
+
|
|
210
|
+
| Rule | Do | Don't |
|
|
211
|
+
|------|----|----- |
|
|
212
|
+
| **Floating navbar** | Add `top-4 left-4 right-4` spacing | Stick navbar to `top-0 left-0 right-0` |
|
|
213
|
+
| **Content padding** | Account for fixed navbar height | Let content hide behind fixed elements |
|
|
214
|
+
| **Consistent max-width** | Use same `max-w-6xl` or `max-w-7xl` | Mix different container widths |
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## Pre-Delivery Checklist
|
|
219
|
+
|
|
220
|
+
Before delivering UI code, verify these items:
|
|
221
|
+
|
|
222
|
+
### Visual Quality
|
|
223
|
+
- [ ] No emojis used as icons (use SVG instead)
|
|
224
|
+
- [ ] All icons from consistent icon set (Heroicons/Lucide)
|
|
225
|
+
- [ ] Brand logos are correct (verified from Simple Icons)
|
|
226
|
+
- [ ] Hover states don't cause layout shift
|
|
227
|
+
|
|
228
|
+
### Interaction
|
|
229
|
+
- [ ] All clickable elements have `cursor-pointer`
|
|
230
|
+
- [ ] Hover states provide clear visual feedback
|
|
231
|
+
- [ ] Transitions are smooth (150-300ms)
|
|
232
|
+
- [ ] Focus states visible for keyboard navigation
|
|
233
|
+
|
|
234
|
+
### Light/Dark Mode
|
|
235
|
+
- [ ] Light mode text has sufficient contrast (4.5:1 minimum)
|
|
236
|
+
- [ ] Glass/transparent elements visible in light mode
|
|
237
|
+
- [ ] Borders visible in both modes
|
|
238
|
+
- [ ] Test both modes before delivery
|
|
239
|
+
|
|
240
|
+
### Layout
|
|
241
|
+
- [ ] Floating elements have proper spacing from edges
|
|
242
|
+
- [ ] No content hidden behind fixed navbars
|
|
243
|
+
- [ ] Responsive at 320px, 768px, 1024px, 1440px
|
|
244
|
+
- [ ] No horizontal scroll on mobile
|
|
245
|
+
|
|
246
|
+
### Accessibility
|
|
247
|
+
- [ ] All images have alt text
|
|
248
|
+
- [ ] Form inputs have labels
|
|
249
|
+
- [ ] Color is not the only indicator
|
|
250
|
+
- [ ] `prefers-reduced-motion` respected
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Musa
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|